Categories

This section describes how to use the Generic API endpoint to replicate category data to the Business Center.

Payload description

The payload consists of the internal category name, whether the category is visible, an external name, long description, and description. You can add image information to the payload, but it is not yet supported. Images can be uploaded in the Business Center.

To receive a notification when the payload fails, add the recipientEmails element.

In the "type" element, specify Created, Updated, or Deleted.

Sample payload

{
"context": "catalogs::categories",
"data":{
"images": {
"desktop": "string",
"mobile": "string"
"preview": "string"
"tablet": "string"
},
"internalName": "string",
"isVisible": true,
"key": "string",
"texts": [
{,
"description": "string",
"languageCode": "string",
"longDescription": "string",
"name": "string",
},
],
"recipientEmails": [
"email address"
]
},
"dateFormatVersion": 0
"dataId": "dataid"
groupId": "groupid",
"notes": "notes",
"source": "source",
"type": "string"
}