brands

Requires at least one of the permissions products:brand:list, products:brand:read, products:product:create, products:product:read, products:product:update or storefront:storefront:update.

Lists the brands of your organization with the number of products on each. Only active brands are returned unless the filter asks for another status. Needs the brands read or list permission, a products read, create or update permission, or the storefront update permission.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query Brands {
  brands {
    total
    brands {
      id
      code
      name
      createdAt
      deletedAt
      deletedBy
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query Brands {\n  brands {\n    total\n    brands {\n      id\n      code\n      name\n      createdAt\n      deletedAt\n      deletedBy\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "brands": {
      "total": 0,
      "brands": [
        {
          "id": "id",
          "code": "string",
          "name": "string",
          "createdAt": "2025-01-15T00:00:00Z",
          "deletedAt": "2025-01-15T00:00:00Z",
          "deletedBy": "string"
        }
      ]
    }
  }
}

brands(
  filter: BrandFilterInput
): BrandListResponse!

Arguments

brands.filter ● BrandFilterInput input

Optional filters: search text, status, creation date range, paging and sort order.

Type

BrandListResponse object

A page of brands.