inventoryAvailability
Get inventory availability for a selected set of products.
Business Rules
- Products can be selected by product ID, SKU, or both.
- Results are limited to products in the current company.
- If warehouse IDs are provided, quantities are scoped to those warehouses.
- If warehouse IDs are omitted, quantities are company-wide.
- Composable products include component availability for the same scope.
Permissions Required
read_inventory_itempermission
inventoryAvailability(
productIds: [ID!]
skus: [String!]
warehouseIds: [ID!]
): [ProductAvailability!]!
Arguments
inventoryAvailability.productIds ● [ID!] list scalar common
The product IDs to retrieve availability for. Maximum 50 IDs.
inventoryAvailability.skus ● [String!] list scalar common
The product SKUs to retrieve availability for. Maximum 50 SKUs.
inventoryAvailability.warehouseIds ● [ID!] list scalar common
The warehouse IDs to scope availability to. Maximum 50 IDs.
Type
ProductAvailability object common
Warehouse-scoped inventory availability for a product.