Access token recevied after user login with a deviceToken
Path parameters
tenantUidstringRequired
Reference to a tenant.
Pattern: ^[A-Za-z0-9-_]+
Query parameters
withProductsbooleanOptional
Include Product list
categoryParentUidstringOptional
Filter on category parent uid
Pattern: ^[A-Za-z0-9-_]+
categoryExternalIdstringOptional
External reference to a category.
pageNumberintegerOptional
Reference to a specific page in a result set.
pageSizeintegerOptional
The number of items per page in a result set.
sortBystringOptional
Defines which field the resource list is sorted by.
sortDirectionstring · enumOptional
ENUM
Description
ASC
Sort in ascending order
DESC
Sort in descending order
Possible values:
Responses
200
Example response
application/json
get
/tenants/{tenantUid}/categories
200
Example response
Create a new category
post
/tenants/{tenantUid}/categories
Create a new category.
Required permission: TENANT.BACKOFFICE
Authorizations
AuthorizationstringRequired
Access token recevied after user login with a deviceToken
Path parameters
tenantUidstringRequired
Reference to a tenant.
Pattern: ^[A-Za-z0-9-_]+
Body
externalIdstringOptional
namestringRequired
parentUidstringOptionalPattern: ^[A-Za-z0-9-_]*
categoryUidstringOptionalPattern: ^[A-Za-z0-9-_]+
Responses
200
Example response
application/json
post
/tenants/{tenantUid}/categories
200
Example response
Category details
get
/tenants/{tenantUid}/categories/{categoryUid}
Get category details
If storeUid is supplied prices and stock from the store will be returned, if no storeUid is supplied the quantityStock will always be 0 and the price will be the reccommended retail price
Required permission: TENANT.ACCESS
Authorizations
AuthorizationstringRequired
Access token recevied after user login with a deviceToken
Path parameters
tenantUidstringRequired
Reference to a tenant.
Pattern: ^[A-Za-z0-9-_]+
categoryUidstringRequired
Reference to a Category.
Pattern: ^[A-Za-z0-9-_]+
Query parameters
storeUidstringOptional
Reference to a store uid
Pattern: ^[A-Za-z0-9-_]+
Responses
200
Example response
application/json
get
/tenants/{tenantUid}/categories/{categoryUid}
200
Example response
Update category
put
/tenants/{tenantUid}/categories/{categoryUid}
Update a category
Required permission: TENANT.BACKOFFICE
Authorizations
AuthorizationstringRequired
Access token recevied after user login with a deviceToken
Path parameters
tenantUidstringRequired
Reference to a tenant.
Pattern: ^[A-Za-z0-9-_]+
categoryUidstringRequired
Reference to a Category.
Pattern: ^[A-Za-z0-9-_]+
Body
externalIdstringOptional
namestringRequired
parentUidstringOptionalPattern: ^[A-Za-z0-9-_]*
productUidsstring[]Optional
Responses
200
Example response
application/json
put
/tenants/{tenantUid}/categories/{categoryUid}
200
Example response
Delete a category
delete
/tenants/{tenantUid}/categories/{categoryUid}
This will delete a category and all its sub-categories.
Required permission: TENANT.BACKOFFICE
Authorizations
AuthorizationstringRequired
Access token recevied after user login with a deviceToken