Skip to main content
Model about a category. Sent in data feeds.
Set empty array fields to empty array brackets (e.g. [ ]) not empty strings.

Properties

Id
string
required
This should be the unique category Id. Id’s are required to be unique across all records.
DisplayName
string
required
This is the name that will be displayed for each category in recommenders.
Image
string
An absolute URL pointing to the location of the image. This image is used when displaying category recommenders. If possible, specify the URL without a protocol e.g. // instead of http:// or https://
This can be a relative or absolute URL pointing to category listing page. If using an absolute URL, specify the URL without a protocol e.g. // instead of http:// or https://
ParentIds
array
The Id’s of the parent categories for this category. This means that a category can exist in more than one parent category, for example a category of “Shirts” could be in both of the categories “Mens” and “Sale”
Description
string
A short, non-formatted description of the category. This field should not contain any HTML