Skip to main content

Get brand products

note

The brand id/code, the warehouse codes and the sku values in these examples are placeholders — get the brand from the brands query and use your own warehouse codes and SKUs.

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 — including a brand your access token is not enabled for, which is not reported as an error.

To read everything stocked in one warehouse, across brands, start from the warehouse instead: the Query warehouse availabilities guide documents the findWarehouse query, whose rows carry the product's brand.

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": {
        "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": {
        "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": 594,
    "bucketBalance": 9406,
    "bucketRestoreRate": 100
  }
}

Minimal query: SKUs and quantities​

When all you need is the stock level of each SKU, keep the selection to sku, the quantities and the warehouse codes that tell the rows apart: the request below walks the catalog with first / after (here first: 3 to keep the response short — use 20, the maximum page size, on a real catalog) and costs a fraction of the full example above. Every product carries one availability row per warehouse it is stocked in.

Request
query brandStock($after: String) {
  findBrand(code: "BRAND_CODE") {
    products(first: 3, after: $after) {
      pageInfo {
        hasNextPage
        endCursor
      }
      nodes {
        sku
        availabilities {
          warehouse {
            codes
          }
          availableQuantity
          onHandQuantity
          reservedQuantity
          onHandQuantityUpdatedAt
        }
      }
    }
  }
}
Response
{
  "data": {
    "findBrand": {
      "products": {
        "pageInfo": {
          "hasNextPage": true,
          "endCursor": "WzUwM10"
        },
        "nodes": [
          {
            "sku": "SKU-1",
            "availabilities": [
              {
                "warehouse": {
                  "codes": ["MIL"]
                },
                "availableQuantity": 25,
                "onHandQuantity": 25,
                "reservedQuantity": 0,
                "onHandQuantityUpdatedAt": "2026-10-08T22:23:40.982Z"
              }
            ]
          },
          {
            "sku": "SKU-2",
            "availabilities": [
              {
                "warehouse": {
                  "codes": ["MIL"]
                },
                "availableQuantity": 0,
                "onHandQuantity": 0,
                "reservedQuantity": 0,
                "onHandQuantityUpdatedAt": "2026-10-08T22:23:40.982Z"
              }
            ]
          },
          {
            "sku": "SKU-3",
            "availabilities": [
              {
                "warehouse": {
                  "codes": ["MIL"]
                },
                "availableQuantity": 11,
                "onHandQuantity": 12,
                "reservedQuantity": 1,
                "onHandQuantityUpdatedAt": "2026-10-09T11:42:26.803Z"
              }
            ]
          }
        ]
      }
    }
  },
  "extensions": {
    "queryComplexity": 30,
    "bucketBalance": 9970,
    "bucketRestoreRate": 100
  }
}

Pass {"after": null} on the first call, then the endCursor of the previous page while hasNextPage is true. onHandQuantity is the physical stock, reservedQuantity the part committed to orders and availableQuantity what is left to sell; onHandQuantityUpdatedAt is when the physical stock was last updated.

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
  • product_availability:read
  • product_component:read