API Reference
Back to site
Catalog

Categories

8. Categories API

Categories can be listed, retrieved by ID, created, updated, and deleted using the same API key authentication as Products and Orders.

GET/categoriesList Categories

Query Parameters:

ParameterTypeDescription
searchstringOptional. Search by name, slug, or description

Example Request:

bash
curl -X GET "https://your-store.com/api/v1/categories" \
  -u "ck_xxx:cs_yyy"

Example Response (200):

json
{
  "status": "success",
  "data": {
    "categories": [
      {
        "id": 1,
        "name": "Flour",
        "slug": "flour",
        "description": "Flour and baking",
        "parent_id": null,
        "created_at": "2026-01-15T10:00:00.000Z",
        "updated_at": "2026-01-15T10:00:00.000Z"
      }
    ]
  }
}

GET/categories/:idGet Single Category

Example Request:

bash
curl -X GET "https://your-store.com/api/v1/categories/1" \
  -u "ck_xxx:cs_yyy"

Example Response (200): Returns { "status": "success", "data": { "category": { ... } } } with optional children and parent associations.

POST/categoriesCreate Category

Send a JSON body with name, slug (optional), description (optional), parent_id (optional). Same Basic Auth as above.

PUT/categories/:idUpdate Category

Send a JSON body with fields to update. Same Basic Auth.

DELETE/categories/:idDelete Category

Example Request:

bash
curl -X DELETE "https://your-store.com/api/v1/categories/1" \
  -u "ck_xxx:cs_yyy"