brand

Requires at least one of the permissions products:brand:read or products:product:read.

Returns one brand of your organization with its products. Fails if the brand does not exist. Needs the brands read or the products read 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 Brand($id: ID!) {
  brand(id: $id) {
    id
    code
    name
    createdAt
    deletedAt
    deletedBy
    products {
      id
      name
      status
      createdAt
      basePrice
      baseUOMId
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query Brand($id: ID!) {\n  brand(id: $id) {\n    id\n    code\n    name\n    createdAt\n    deletedAt\n    deletedBy\n    products {\n      id\n      name\n      status\n      createdAt\n      basePrice\n      baseUOMId\n    }\n  }\n}",
  "variables": {
    "id": "id"
  }
}
EOF

Variables:

{
  "id": "id"
}

Response:

{
  "data": {
    "brand": {
      "id": "id",
      "code": "string",
      "name": "string",
      "createdAt": "2025-01-15T00:00:00Z",
      "deletedAt": "2025-01-15T00:00:00Z",
      "deletedBy": "string",
      "products": [
        {
          "id": "id",
          "name": "string",
          "status": "ACTIVE",
          "createdAt": "2025-01-15T00:00:00Z",
          "basePrice": 0,
          "baseUOMId": "id"
        }
      ]
    }
  }
}

brand(
  id: ID!
): Brand!

Arguments

brand.id ● ID! non-null scalar

The ID of the brand.

Type

Brand object

A brand products are made or sold under.