Product categories

Categories group the products of your catalog. A product points to its category with product_category_id.

Endpoints

The REST path of this resource is /products-categories (with an s in products).

MethodPathDescription
GET/products-categoriesList product categories
GET/products-categories/:idGet a product category
POST/products-categoriesCreate a product category
PATCH/products-categories/:idUpdate a product category
DELETE/products-categories/:idDelete a product category

The API key is scoped to one organization: reads are filtered to it automatically, and organization_id is required in the body on create.

The product category object

json

Fields

FieldTypeDescription
idintegerRead-only. Unique ID.
namestringCategory name. Required.
organization_idintegerOrganization that owns the category. Required on create.
created_atstring (date-time)Read-only. Creation time.
updated_atstring (date-time)Read-only. Last update time.
deleted_atstring (date-time) | nullRead-only. Set when the category is deleted.

Related

Report an issue with this documentation

Please log in to report issues with our documentation.