Skip to main content

Get brand products

note

The brand id/code in these examples are placeholders — get them from the brands query.

Use findBrand query to get the product and bundle availabilities of a brand by code (or brand by id), divided by warehouse. Each availability row carries the on-hand, reserved and available quantities and the time the on-hand quantity was last updated; a bundle also lists its components, the products it is made of with their quantity.

findBrand returns null when no brand matches the code.

products and bundles are paginated connections: on a real catalog walk the pages with first and after (see Pagination). Availability queries cost significant query complexity points, so budget your polling accordingly.

Response
{
  "data": {
    "findBrand": {
      "id": "31",
      "code": "BRAND_CODE",
      "name": "Brand name",
      "products": {
        "totalCount": 1,
        "pageInfo": {
          "hasNextPage": false,
          "endCursor": "WzUwMV0"
        },
        "nodes": [
          {
            "id": "501",
            "sku": "SKU-1",
            "skuDescription": "Demo product",
            "availabilities": [
              {
                "id": "8001",
                "availableQuantity": 11,
                "onHandQuantity": 12,
                "onHandQuantityUpdatedAt": "2026-07-22T09:30:00Z",
                "reservedQuantity": 1,
                "warehouse": {
                  "id": "12",
                  "codes": ["MIL"]
                }
              }
            ]
          }
        ]
      },
      "bundles": {
        "totalCount": 1,
        "pageInfo": {
          "hasNextPage": false,
          "endCursor": "WzYwMV0"
        },
        "nodes": [
          {
            "id": "601",
            "sku": "BUNDLE-1",
            "skuDescription": "Demo bundle",
            "components": [
              {
                "quantity": 2,
                "product": {
                  "id": "501",
                  "sku": "SKU-1"
                }
              },
              {
                "quantity": 1,
                "product": {
                  "id": "502",
                  "sku": "SKU-2"
                }
              }
            ],
            "availabilities": [
              {
                "id": "9001",
                "availableQuantity": 3,
                "onHandQuantity": 5,
                "onHandQuantityUpdatedAt": "2026-07-22T09:30:00Z",
                "reservedQuantity": 2,
                "warehouse": {
                  "id": "12",
                  "codes": ["MIL"]
                }
              }
            ]
          }
        ]
      }
    }
  },
  "extensions": {
    "queryComplexity": 596,
    "bucketBalance": 9404,
    "bucketRestoreRate": 100
  }
}

Relevant permissions

The operations in this page require the following permissions on the API credentials — they are configured for you by Calicantus.

  • brand:query:find_brand
  • brand:read
  • product:read
  • bundle:read
  • warehouse:read