Export Webshop Category

The webshop categories can be accessed via the url GET http://<server name>:<odata port>/<service tier name>/api/BEterna/Export/v2.0/companies(<company system id>)/webshopCategories?$filter=webshopChannelCode eq '<webshop channel code>'. The filter on the webshop channel code is mandatory. The response is a JSON with all webshop categories assigned to the given webshop channel.

{
   "@odata.context": "http://<server name>:<odata port>/<service tier name>/api/BEterna/Export/v2.0/$metadata#companies(<company system id>)/webshopCategories",
   "value": [
      {
         "@odata.etag": "W/\"JzE5Ozg4ODIyMzczODk1NTU2MzM1MTgxOzAwOyc=\"",
         "systemId": "8023c9a1-86dd-ec11-90fe-cb62da85b82a",
         "webshopCategoryCode": "01",
         "webshopChannelCode": "B2C",
         "parentCategoryCode": "",
         "active": false,
         "hidden": false,
         "metaTitle": "",
         "metaDescription": "",
         "metaTags": ""
      },
      {
         "@odata.etag": "W/\"JzE5OzYxMDQ3NTExODExMjg2NjQwNzExOzAwOyc=\"",
         "systemId": "4667acb0-86dd-ec11-90fe-cb62da85b82a",
         "webshopCategoryCode": "02",
         "webshopChannelCode": "B2C",
         "parentCategoryCode": "",
         "active": false,
         "hidden": false,
         "metaTitle": "",
         "metaDescription": "",
         "metaTags": ""
      },
      {
         "@odata.etag": "W/\"JzIwOzE1MDM3MzU0ODc2MjcwOTMzNjIyMTswMDsn\"",
         "systemId": "791fa4ba-86dd-ec11-90fe-cb62da85b82a",
         "webshopCategoryCode": "03",
         "webshopChannelCode": "B2C",
         "parentCategoryCode": "",
         "active": false,
         "hidden": false,
         "metaTitle": "",
         "metaDescription": "",
         "metaTags": ""
      },
      {
         "@odata.etag": "W/\"JzE4OzQ1NTkyMTc3MjU3MDc5OTEyMTE7MDA7Jw==\"",
         "systemId": "421993cc-86dd-ec11-90fe-cb62da85b82a",
         "webshopCategoryCode": "01-01",
         "webshopChannelCode": "B2C",
         "parentCategoryCode": "01",
         "active": false,
         "hidden": false,
         "metaTitle": "",
         "metaDescription": "",
         "metaTags": ""
      },
      {
         "@odata.etag": "W/\"JzE5OzcyOTEyOTYyNTEwODcxMjA3MDgxOzAwOyc=\"",
         "systemId": "55d2f3e3-86dd-ec11-90fe-cb62da85b82a",
         "webshopCategoryCode": "01-02",
         "webshopChannelCode": "B2C",
         "parentCategoryCode": "01",
         "active": false,
         "hidden": false,
         "metaTitle": "",
         "metaDescription": "",
         "metaTags": ""
      },
      {
         "@odata.etag": "W/\"JzE5OzYyNTI0Mzk5OTIzNDEzNjUyNDkxOzAwOyc=\"",
         "systemId": "a4863bf7-86dd-ec11-90fe-cb62da85b82a",
         "webshopCategoryCode": "02-01",
         "webshopChannelCode": "B2C",
         "parentCategoryCode": "02",
         "active": false,
         "hidden": false,
         "metaTitle": "",
         "metaDescription": "",
         "metaTags": ""
      },
      {
         "@odata.etag": "W/\"JzE5OzMwNTk2OTM4MDc0OTcwNTM5ODIxOzAwOyc=\"",
         "systemId": "dac6670c-87dd-ec11-90fe-cb62da85b82a",
         "webshopCategoryCode": "02-02",
         "webshopChannelCode": "B2C",
         "parentCategoryCode": "02",
         "active": false,
         "hidden": false,
         "metaTitle": "",
         "metaDescription": "",
         "metaTags": ""
      },
      {
         "@odata.etag": "W/\"JzIwOzEyODc3MDc3MDY4Mzc5MTAwNTgwMTswMDsn\"",
         "systemId": "49526437-87dd-ec11-90fe-cb62da85b82a",
         "webshopCategoryCode": "03-01",
         "webshopChannelCode": "B2C",
         "parentCategoryCode": "03",
         "active": false,
         "hidden": false,
         "metaTitle": "",
         "metaDescription": "",
         "metaTags": ""
      }
   ]
}

The fields are documented in the following table.

field	data type	content
`systemId`	GUID	distinct identifier for a webshop category record
`webshopCategoryCode`	Text[10]	human-readable distinct identifier for a webshop category record
`webshopChannelCode`	Text[20]	Webshopkanalcode
`parentCategoryCode`	Text[10]	the code of the parent category, may be empty
`active`	boolean	active flag
`hidden`	boolean	hidden flag
`metaTitle`	Text[250]	the meta title of the category, may be empty
`metaDescription`	Text[250]	the meta description of the category, may be empty
`metaTags`	Text[250]	the meta tags of the category, may be empty

How the fields active, hidden, metaTitle, metaDescription and metaTags are used must be discussed individually.

Get multiligual Webshop Category descriptions

A webshop category can have descriptions in more than one language. To access these, the url GET http://<server name>:<odata port>/<service tier name>/api/BEterna/Export/v2.0/companies(<company system id>)/webshopCategoryDescriptions?$filter=webshopChannelCode eq '<webshop channel code>' and webshopCategorySystemId eq {<systemId of a webshop category>} The systemId of a webshop category can be accessed using the Webshop Category interface decribed above. The filters on webshopChannelCode and webshopCategorySystemId are mandatory. The response is a JSON with all description translations assigned to the given webshop category.

{
   "@odata.context": "http://<server name>:<odata port>/<service tier name>/api/BEterna/Export/v2.0/$metadata#companies(<company system id>)/webshopCategoryDescriptions",
   "value": [
      {
         "@odata.etag": "W/\"JzE5OzQ2NjQxMDUyMDQ4MTI0NTkwODIxOzAwOyc=\"",
         "systemId": "71fa9ae9-85dd-ec11-90fe-cb62da85b82a",
         "webshopChannelCode": "B2C",
         "webshopCategorySystemId": "{<systemId of a webshop category>}",
         "language": "DEU",
         "text": "Damen"
      },
      {
         "@odata.etag": "W/\"JzE5OzQ2NjMyNDc1MTQ2MzYwODkzNTcxOzAwOyc=\"",
         "systemId": "72fa9ae9-85dd-ec11-90fe-cb62da85b82a",
         "webshopChannelCode": "B2C",
         "webshopCategorySystemId": "{<systemId of a webshop category>}",
         "language": "ENU",
         "text": "Women"
      }
   ]
}

The fields are documented in the following table.

field	data type	content
`systemId`	GUID	distinct identifier for a language assigned to a webshop channel
`webshopChannelCode`	Text[20]	Webshopkanalcode
`webshopCategorySystemId`	GUID	systemId of the webshop category
`language`	Text[10]	human-readable distinct language identifier of the language
`text`	Text	The translation of the webshop category description