Skip to content

Categories

Create and update categories, organize their tree, and import or export categories.

Fields

idstringUnique identifier of the resource.
namestring
productCountinteger
isActiveboolean
slugstringURL-friendly identifier.
urlstring
customUrlstring
logostring
See all 22 fields
iconstring
descriptionstring
metaTitlestring
metaDescriptionstring
keywordsarray<string>
orderinteger
pathstring
requiresSizeGuideboolean
commissionPercentagenumber
commissionFixedFeenumber
createdOnstringTimestamp when the resource was created, in ISO 8601.
updatedOnstringTimestamp when the resource was last modified, in ISO 8601.
storeIdstring
parentIdstring

Operations

MethodEndpointOperation
POST/v1/catalog/categoriesCreate category
GET/v1/catalog/categoriesList categories
GET/v1/catalog/categories/{categoryId}Get category by ID
PUT/v1/catalog/categories/{categoryId}Update a category
DELETE/v1/catalog/categories/{categoryId}Delete a category

Import & export

MethodEndpointOperation
POST/v1/catalog/categories/exportsExport categories
POST/v1/catalog/categories/importsImport categories

Attributes

MethodEndpointOperation
GET/v1/catalog/categories/{categoryId}/specificationsList category attributes
PUT/v1/catalog/categories/{categoryId}/specificationsReplace category attributes

Tree

MethodEndpointOperation
GET/v1/catalog/categories/treeGet categories tree
PUT/v1/catalog/categories/treeUpdate categories tree

Last updated: