Commerce Engine is now in beta. We're working hard to make it better for you.
curl --request GET \
--url https://staging.api.commercengine.io/api/v1/{store_id}/storefront/catalog/categories \
--header 'Authorization: Bearer <token>'{
"message": "<string>",
"success": true,
"content": {
"categories": [
{
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"parent_category_id": "<string>",
"product_count": 123,
"active": true,
"child_categories": [
{
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"parent_category_id": "<string>",
"product_count": 123,
"active": true
}
]
}
],
"pagination": {
"total_records": 123,
"total_pages": 123,
"limit": 123,
"next_page": 123,
"previous_page": 123
}
}
}Returns a list of your product categories. The categories are returned sorted by creation date, with the most recently created categories appearing first.
curl --request GET \
--url https://staging.api.commercengine.io/api/v1/{store_id}/storefront/catalog/categories \
--header 'Authorization: Bearer <token>'{
"message": "<string>",
"success": true,
"content": {
"categories": [
{
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"parent_category_id": "<string>",
"product_count": 123,
"active": true,
"child_categories": [
{
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"parent_category_id": "<string>",
"product_count": 123,
"active": true
}
]
}
],
"pagination": {
"total_records": 123,
"total_pages": 123,
"limit": 123,
"next_page": 123,
"previous_page": 123
}
}
}Access token
search keyword
JSON string format: {"field1":"asc", "field2":"desc"} json string in format {'field_name':'asc', 'other_field_name':'desc', ...}
return child categories up to nesting level
0 <= x <= 4To return child categories using category id.
"01JWZW41Y3FBKTZSP399SKANY7"
To return child categories using category slug
"vitals"
OK
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?