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).
| Method | Path | Description |
|---|---|---|
GET | /products-categories | List product categories |
GET | /products-categories/:id | Get a product category |
POST | /products-categories | Create a product category |
PATCH | /products-categories/:id | Update a product category |
DELETE | /products-categories/:id | Delete 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
| Field | Type | Description |
|---|---|---|
id | integer | Read-only. Unique ID. |
name | string | Category name. Required. |
organization_id | integer | Organization that owns the category. Required on create. |
created_at | string (date-time) | Read-only. Creation time. |
updated_at | string (date-time) | Read-only. Last update time. |
deleted_at | string (date-time) | null | Read-only. Set when the category is deleted. |
Related
Report an issue with this documentation
Please log in to report issues with our documentation.