Skip to main content

Product Categories

List all categories

GET /api/v1/product_categories

Query parameters

NameTypeDescription
fieldsstringComma-separated list of fields. Example id,parent_id,name
enabledbooleanOnly enabled categories

Retrieve a category

GET /api/v1/product_categories/{category_id}

Create a category

POST /api/v1/product_categories

Request body

NameTypeDescription
namestring-
descriptionstring-
meta_descriptionstring-
meta_titlestring-
enabledboolean-
sortstring-
parent_idstring-
positioninteger-
slugstring-

Update a category

PUT /api/v1/product_categories/{category_id}

Request body

NameTypeDescription
namestring-
descriptionstring-
meta_descriptionstring-
meta_titlestring-
enabledboolean-
sortstring-
parent_idstring-
positioninteger-
slugstring-

Delete a category

DELETE /api/v1/product_categories/{category_id}

Upload a category image

POST /api/v1/product_categories/{category_id}/image

Delete a category image

DELETE /api/v1/product_categories/{category_id}/image