API Reference
Back to site
Catalog

Brands

9. Brands API

Brands can be listed, retrieved by ID, created, updated, and deleted using the same API key authentication.

GET/brandsList Brands

Query Parameters:

ParameterTypeDescription
searchstringOptional. Search by name or slug

Example Request:

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

Example Response (200):

json
{
  "status": "success",
  "data": {
    "brands": [
      {
        "id": 1,
        "name": "Organic Co",
        "slug": "organic-co",
        "created_at": "2026-01-15T10:00:00.000Z",
        "updated_at": "2026-01-15T10:00:00.000Z"
      }
    ]
  }
}

GET/brands/:idGet Single Brand

Example Request:

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

Example Response (200): Returns { "status": "success", "data": { "brand": { ... } } }.

POST/brandsCreate Brand

Send a JSON body with name, slug (optional). Same Basic Auth.

PUT/brands/:idUpdate Brand

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

DELETE/brands/:idDelete Brand

Example Request:

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