Each product will belong to one or more categories.
GET /v1/companies/5678/categories |
|
GET /v1/companies/5678/sites/6203/categories |
|
GET /v1/companies/5678/products/92693/categories |
updated_at
field on this endpoint will return the current timestamp, not the actual last updated timestamp. It is recommended to use webhooks if you want to know when an entity has been updated.
GET /v1/companies/5678/categories/8263 |
show_online
flag is used to indicate if this category is shown or hidden.
When it is true, Site expects this category should be shown to customers. Otherwise it should be hidden.
Hint: Site needs to enable the Online Products
feature then edit it under Products > Online Products on Back Office
.
updated_at
field on this endpoint will return the current timestamp, not the actual last updated timestamp. It is recommended to use webhooks if you want to know when an entity has been updated.
POST /v1/companies/5678/categories |
|
POST /v1/companies/5678/sites/6203/categories |
name
attribute is required. See the
Get a category action
for a complete list of attributes.Use this action to rename a category or change its description or image.
PUT /v1/companies/5678/categories/8263 |
PUT /v1/companies/5678/categories/8263/products |
DELETE /v1/companies/5678/categories/8263/products/789216 |
Here is a list of the supported webhook topics.
When a category is created. You will receive the complete category.
When a category is updated. You will receive the complete category after the modifications have been applied.
You also may provide the following attribute filters:
show_online
Note that when filtering by show_online
, any changes to
categories where show_online
is true will trigger a
webhook notification.
When a category is deleted. You will receive the complete category.