Backend API
Fields
Unique identifier for the category.
A human-friendly name for the category.
Indicates the category may be visible to customers. Otherwise it will be hidden from view.
Expandable list of child categories.
Date and time the category was created.
Date and time the category was last updated.
Indicates the category is a demo.
A long-form description of the category. Can contain HTML or other markup languages.
Image depicting the category.
Deprecated — use images instead.
An object representing the image's source file.
Unique identifier for the file.
Optional file name.
A reference to the raw file data.
MIME content type of the file.
Date the file was uploaded.
Image height in pixels, if applicable.
Size of the file in bytes.
A set of arbitrary data that is typically used to store custom values.
An MD5 hash of the file contents. This can be used to uniquely identify the file for caching purposes.
Indicates whether the file is private.
A public URL to reference the file. Updated automatically if file content changes.
Image width in pixels, if applicable.
List of images depicting the category.
Unique identifier for the object.
A brief description of the image.
An object representing the image file.
Unique identifier for the file.
MIME content type of the file.
A reference to the raw file data.
Date the file was uploaded.
Optional file name.
Image height in pixels, if applicable.
Size of the file in bytes.
An MD5 hash of the file contents. This can be used to uniquely identify the file for caching purposes.
A public URL to reference the file. Updated automatically if file content changes.
Image width in pixels, if applicable.
Arbitrary image data, typically used to store custom values. See Frontend API for more details.
Indicates the image is not visible to customers.
Page description used for search engine optimization purposes.
Page keywords used for search engine optimization purposes.
Page title used to override product name in storefronts.
ID of the parent category, if applicable.
Expandable link to the parent category, if applicable.
Expandable list of category products.
Expandable list of products as indexed and sorted by their respective position.
Unique identifier typically used in URLs. Defaults to name converted to lowercase and hyphenated. If the category has a parent, the default slug will be prefixed with the parent slug. Maximum length of 1,000 characters.
Position of the category in a list.
Default product sorting applied when retrieving products using the category or categories filter. Can be one of popularity, price_asc, price_desc, date_asc. date_desc. If not specified, products are sorted by their manually defined sort value.
ID of an alternate theme template used to render this category in a storefront, if applicable.
An object containing custom attribute key/value pairs.
Template of attribute id/value pairs to apply to products added to this category.
Expandable link to the top level category.
ID of the top level category in the hierarchy.
The category model
{
"name": "Luck",
"active": true,
"sorting": null,
"images": [
{
"file": {
"id": "628bb4ba499bba0019b1ab7c",
"date_uploaded": "2022-05-23T16:22:18.978Z",
"length": 52772,
"md5": "82fd851c2edcd4bd7ed941c561e605ea",
"filename": null,
"content_type": "image/gif",
"metadata": null,
"url": "https://cdn.schema.io/launch-storefront/628bb4ba499bba0019b1ab7c/82fd851c2edcd4bd7ed941c561e605ea",
"width": 127,
"height": 127
},
"id": "628bb4be499bba0019b1ab7e"
}
],
"description": "Luck affects all skills a little bit—with the exception of Acrobatics and Athletics.<br>",
"meta_title": "Luck",
"meta_description": "Luck affects all skills a little bit—not including Acrobatics and Athletics.",
"parent_id": "628bae71499bba0019b1aac2",
"slug": "skills-luck",
"top_id": "628bae71499bba0019b1aac2",
"date_created": "2022-05-23T16:06:40.137Z",
"date_updated": "2022-05-23T16:22:22.300Z",
"sort": 7,
"id": "628bb1101869c10019b4205c"