Inventory
Query Parameters
Header Parameters
Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.
Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.
Adds a location scope to the request for location-aware reads, writes, and audit entries.
Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.
Value in
- "hexclave"
Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.
Response Body
application/json
curl -X GET "https://example.com/inventory/ingredients" \ -H "x-tenant-id: tenant-local" \ -H "x-tenant-slug: trellis-local" \ -H "x-location-id: loc-tasting-room" \ -H "x-auth-provider: hexclave" \ -H "x-auth-user-id: user_abc123"{ "items": [ { "id": "string", "code": "string", "name": "string", "description": "string", "baseUnit": "string", "purchaseUnit": "string", "purchaseUnitQuantity": 1, "latestUnitCost": 0, "weightedAverageUnitCost": 0, "vendorId": "string", "active": true, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "stocks": [ { "id": "string", "ingredientId": "string", "locationId": "string", "onHandQuantity": 0, "parQuantity": 0, "reorderQuantity": 0, "lastCountedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ] } ], "page": { "total": 0 }}Header Parameters
Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.
Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.
Adds a location scope to the request for location-aware reads, writes, and audit entries.
Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.
Value in
- "hexclave"
Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/inventory/ingredients" \ -H "x-tenant-id: tenant-local" \ -H "x-tenant-slug: trellis-local" \ -H "x-location-id: loc-tasting-room" \ -H "x-auth-provider: hexclave" \ -H "x-auth-user-id: user_abc123" \ -H "Content-Type: application/json" \ -d '{ "code": "string", "name": "string", "baseUnit": "string" }'{ "id": "string", "code": "string", "name": "string", "description": "string", "baseUnit": "string", "purchaseUnit": "string", "purchaseUnitQuantity": 1, "latestUnitCost": 0, "weightedAverageUnitCost": 0, "vendorId": "string", "active": true, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "stocks": [ { "id": "string", "ingredientId": "string", "locationId": "string", "onHandQuantity": 0, "parQuantity": 0, "reorderQuantity": 0, "lastCountedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ]}Path Parameters
1 <= lengthHeader Parameters
Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.
Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.
Adds a location scope to the request for location-aware reads, writes, and audit entries.
Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.
Value in
- "hexclave"
Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.
Response Body
application/json
curl -X GET "https://example.com/inventory/ingredients/string" \ -H "x-tenant-id: tenant-local" \ -H "x-tenant-slug: trellis-local" \ -H "x-location-id: loc-tasting-room" \ -H "x-auth-provider: hexclave" \ -H "x-auth-user-id: user_abc123"{ "id": "string", "code": "string", "name": "string", "description": "string", "baseUnit": "string", "purchaseUnit": "string", "purchaseUnitQuantity": 1, "latestUnitCost": 0, "weightedAverageUnitCost": 0, "vendorId": "string", "active": true, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "stocks": [ { "id": "string", "ingredientId": "string", "locationId": "string", "onHandQuantity": 0, "parQuantity": 0, "reorderQuantity": 0, "lastCountedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ]}Path Parameters
1 <= lengthQuery Parameters
date-timedate-time1 <= value <= 500Header Parameters
Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.
Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.
Adds a location scope to the request for location-aware reads, writes, and audit entries.
Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.
Value in
- "hexclave"
Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.
Response Body
application/json
curl -X GET "https://example.com/inventory/ingredients/string/movements" \ -H "x-tenant-id: tenant-local" \ -H "x-tenant-slug: trellis-local" \ -H "x-location-id: loc-tasting-room" \ -H "x-auth-provider: hexclave" \ -H "x-auth-user-id: user_abc123"{ "movements": [ { "id": "string", "ingredientId": "string", "locationId": "string", "movementType": "string", "quantityDelta": 0, "unitCost": 0, "totalCost": 0, "referenceType": "string", "referenceId": "string", "note": "string", "occurredAt": "2019-08-24T14:15:22Z", "resultingOnHandQuantity": 0, "createdAt": "2019-08-24T14:15:22Z" } ], "page": { "total": 0 }}Path Parameters
1 <= lengthHeader Parameters
Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.
Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.
Adds a location scope to the request for location-aware reads, writes, and audit entries.
Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.
Value in
- "hexclave"
Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/inventory/ingredients/string/receivings" \ -H "x-tenant-id: tenant-local" \ -H "x-tenant-slug: trellis-local" \ -H "x-location-id: loc-tasting-room" \ -H "x-auth-provider: hexclave" \ -H "x-auth-user-id: user_abc123" \ -H "Content-Type: application/json" \ -d '{ "locationId": "string", "quantity": 1, "unitCost": 0 }'{ "ingredient": { "id": "string", "code": "string", "name": "string", "description": "string", "baseUnit": "string", "purchaseUnit": "string", "purchaseUnitQuantity": 1, "latestUnitCost": 0, "weightedAverageUnitCost": 0, "vendorId": "string", "active": true, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "stocks": [ { "id": "string", "ingredientId": "string", "locationId": "string", "onHandQuantity": 0, "parQuantity": 0, "reorderQuantity": 0, "lastCountedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ] }, "stock": { "id": "string", "ingredientId": "string", "locationId": "string", "onHandQuantity": 0, "parQuantity": 0, "reorderQuantity": 0, "lastCountedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }, "movement": { "id": "string", "ingredientId": "string", "locationId": "string", "movementType": "string", "quantityDelta": 0, "unitCost": 0, "totalCost": 0, "referenceType": "string", "referenceId": "string", "note": "string", "occurredAt": "2019-08-24T14:15:22Z", "resultingOnHandQuantity": 0, "createdAt": "2019-08-24T14:15:22Z" }}Path Parameters
1 <= lengthHeader Parameters
Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.
Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.
Adds a location scope to the request for location-aware reads, writes, and audit entries.
Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.
Value in
- "hexclave"
Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/inventory/ingredients/string/waste" \ -H "x-tenant-id: tenant-local" \ -H "x-tenant-slug: trellis-local" \ -H "x-location-id: loc-tasting-room" \ -H "x-auth-provider: hexclave" \ -H "x-auth-user-id: user_abc123" \ -H "Content-Type: application/json" \ -d '{ "locationId": "string", "quantity": 1 }'{ "ingredient": { "id": "string", "code": "string", "name": "string", "description": "string", "baseUnit": "string", "purchaseUnit": "string", "purchaseUnitQuantity": 1, "latestUnitCost": 0, "weightedAverageUnitCost": 0, "vendorId": "string", "active": true, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "stocks": [ { "id": "string", "ingredientId": "string", "locationId": "string", "onHandQuantity": 0, "parQuantity": 0, "reorderQuantity": 0, "lastCountedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ] }, "stock": { "id": "string", "ingredientId": "string", "locationId": "string", "onHandQuantity": 0, "parQuantity": 0, "reorderQuantity": 0, "lastCountedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }, "movement": { "id": "string", "ingredientId": "string", "locationId": "string", "movementType": "string", "quantityDelta": 0, "unitCost": 0, "totalCost": 0, "referenceType": "string", "referenceId": "string", "note": "string", "occurredAt": "2019-08-24T14:15:22Z", "resultingOnHandQuantity": 0, "createdAt": "2019-08-24T14:15:22Z" }}Header Parameters
Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.
Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.
Adds a location scope to the request for location-aware reads, writes, and audit entries.
Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.
Value in
- "hexclave"
Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.
Response Body
application/json
curl -X GET "https://example.com/inventory/recipes" \ -H "x-tenant-id: tenant-local" \ -H "x-tenant-slug: trellis-local" \ -H "x-location-id: loc-tasting-room" \ -H "x-auth-provider: hexclave" \ -H "x-auth-user-id: user_abc123"{ "recipes": [ { "id": "string", "kind": "menu_item", "title": "string", "productId": "string", "outputIngredientId": "string", "yieldQuantity": 1, "active": true, "note": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "components": [ { "id": "string", "ingredientId": "string", "quantity": 1 } ] } ], "page": { "total": 0 }}Header Parameters
Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.
Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.
Adds a location scope to the request for location-aware reads, writes, and audit entries.
Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.
Value in
- "hexclave"
Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/inventory/recipes" \ -H "x-tenant-id: tenant-local" \ -H "x-tenant-slug: trellis-local" \ -H "x-location-id: loc-tasting-room" \ -H "x-auth-provider: hexclave" \ -H "x-auth-user-id: user_abc123" \ -H "Content-Type: application/json" \ -d '{ "kind": "menu_item", "title": "string", "yieldQuantity": 1, "components": [ { "ingredientId": "string", "quantity": 1 } ] }'{ "id": "string", "kind": "menu_item", "title": "string", "productId": "string", "outputIngredientId": "string", "yieldQuantity": 1, "active": true, "note": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "components": [ { "id": "string", "ingredientId": "string", "quantity": 1 } ]}Path Parameters
1 <= lengthHeader Parameters
Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.
Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.
Adds a location scope to the request for location-aware reads, writes, and audit entries.
Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.
Value in
- "hexclave"
Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.
Response Body
application/json
curl -X GET "https://example.com/inventory/recipes/string" \ -H "x-tenant-id: tenant-local" \ -H "x-tenant-slug: trellis-local" \ -H "x-location-id: loc-tasting-room" \ -H "x-auth-provider: hexclave" \ -H "x-auth-user-id: user_abc123"{ "id": "string", "kind": "menu_item", "title": "string", "productId": "string", "outputIngredientId": "string", "yieldQuantity": 1, "active": true, "note": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "components": [ { "id": "string", "ingredientId": "string", "quantity": 1 } ]}Header Parameters
Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.
Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.
Adds a location scope to the request for location-aware reads, writes, and audit entries.
Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.
Value in
- "hexclave"
Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/inventory/prep-batches" \ -H "x-tenant-id: tenant-local" \ -H "x-tenant-slug: trellis-local" \ -H "x-location-id: loc-tasting-room" \ -H "x-auth-provider: hexclave" \ -H "x-auth-user-id: user_abc123" \ -H "Content-Type: application/json" \ -d '{ "recipeId": "string", "locationId": "string" }'{ "batchId": "string", "recipeId": "string", "locationId": "string", "outputIngredientId": "string", "outputQuantity": 1, "batchUnitCost": 0, "ingredient": { "id": "string", "code": "string", "name": "string", "description": "string", "baseUnit": "string", "purchaseUnit": "string", "purchaseUnitQuantity": 1, "latestUnitCost": 0, "weightedAverageUnitCost": 0, "vendorId": "string", "active": true, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "stocks": [ { "id": "string", "ingredientId": "string", "locationId": "string", "onHandQuantity": 0, "parQuantity": 0, "reorderQuantity": 0, "lastCountedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ] }, "stock": { "id": "string", "ingredientId": "string", "locationId": "string", "onHandQuantity": 0, "parQuantity": 0, "reorderQuantity": 0, "lastCountedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }, "producedMovement": { "id": "string", "ingredientId": "string", "locationId": "string", "movementType": "string", "quantityDelta": 0, "unitCost": 0, "totalCost": 0, "referenceType": "string", "referenceId": "string", "note": "string", "occurredAt": "2019-08-24T14:15:22Z", "resultingOnHandQuantity": 0, "createdAt": "2019-08-24T14:15:22Z" }, "consumedMovements": [ { "id": "string", "ingredientId": "string", "locationId": "string", "movementType": "string", "quantityDelta": 0, "unitCost": 0, "totalCost": 0, "referenceType": "string", "referenceId": "string", "note": "string", "occurredAt": "2019-08-24T14:15:22Z", "resultingOnHandQuantity": 0, "createdAt": "2019-08-24T14:15:22Z" } ]}Header Parameters
Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.
Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.
Adds a location scope to the request for location-aware reads, writes, and audit entries.
Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.
Value in
- "hexclave"
Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/inventory/recipe-depletions/apply" \ -H "x-tenant-id: tenant-local" \ -H "x-tenant-slug: trellis-local" \ -H "x-location-id: loc-tasting-room" \ -H "x-auth-provider: hexclave" \ -H "x-auth-user-id: user_abc123" \ -H "Content-Type: application/json" \ -d '{ "locationId": "string" }'{ "appliedOrders": [ { "orderId": "string", "orderNumber": 0, "submittedAt": "2019-08-24T14:15:22Z", "totalTheoreticalCost": 0, "ingredientImpacts": [ { "ingredientId": "string", "quantity": 1, "unitCost": 0, "totalCost": 0 } ] } ], "skippedOrders": [ { "orderId": "string", "reason": "string" } ], "totals": { "orderCount": 0, "ingredientCount": 0, "totalTheoreticalCost": 0 }}Query Parameters
date-timedate-timeHeader Parameters
Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.
Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.
Adds a location scope to the request for location-aware reads, writes, and audit entries.
Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.
Value in
- "hexclave"
Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.
Response Body
application/json
curl -X GET "https://example.com/inventory/reports/variance?locationId=string&startAt=2019-08-24T14%3A15%3A22Z&endAt=2019-08-24T14%3A15%3A22Z" \ -H "x-tenant-id: tenant-local" \ -H "x-tenant-slug: trellis-local" \ -H "x-location-id: loc-tasting-room" \ -H "x-auth-provider: hexclave" \ -H "x-auth-user-id: user_abc123"{ "rows": [ { "ingredientId": "string", "ingredientCode": "string", "ingredientName": "string", "locationId": "string", "currentOnHandQuantity": 0, "theoreticalQuantity": 0, "actualQuantity": 0, "wasteQuantity": 0, "receivedQuantity": 0, "prepProducedQuantity": 0, "varianceQuantity": 0, "weightedAverageUnitCost": 0, "theoreticalCost": 0, "actualCost": 0, "varianceCost": 0 } ], "totals": { "ingredientCount": 0, "theoreticalCost": 0, "actualCost": 0, "varianceCost": 0 }}Exact Commerce7-style inventory list path.
Query Parameters
Header Parameters
Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.
Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.
Adds a location scope to the request for location-aware reads, writes, and audit entries.
Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.
Value in
- "hexclave"
Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.
Response Body
application/json
curl -X GET "https://example.com/inventory" \ -H "x-tenant-id: tenant-local" \ -H "x-tenant-slug: trellis-local" \ -H "x-location-id: loc-tasting-room" \ -H "x-auth-provider: hexclave" \ -H "x-auth-user-id: user_abc123"{ "inventories": [ { "id": "string", "inventoryLocationTitle": "string", "inventoryLocationId": "string", "productVariantId": "string", "productVariantTitle": "string", "sku": "string", "upcCode": "string", "hasInventory": true, "availableForSaleCount": 0, "reserveCount": 0, "allocatedCount": 0, "inventoryPolicy": "string", "productId": "string", "productTitle": "string" } ], "total": 0}Header Parameters
Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.
Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.
Adds a location scope to the request for location-aware reads, writes, and audit entries.
Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.
Value in
- "hexclave"
Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/inventory" \ -H "x-tenant-id: tenant-local" \ -H "x-tenant-slug: trellis-local" \ -H "x-location-id: loc-tasting-room" \ -H "x-auth-provider: hexclave" \ -H "x-auth-user-id: user_abc123" \ -H "Content-Type: application/json" \ -d '{ "sku": "string", "initialInventory": [ { "inventoryLocationId": "string", "availableForSale": 0 } ], "inventoryPolicy": "string" }'{ "id": "string", "inventoryLocationTitle": "string", "inventoryLocationId": "string", "productVariantId": "string", "productVariantTitle": "string", "sku": "string", "upcCode": "string", "hasInventory": true, "availableForSaleCount": 0, "reserveCount": 0, "allocatedCount": 0, "inventoryPolicy": "string", "productId": "string", "productTitle": "string"}Path Parameters
1 <= lengthHeader Parameters
Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.
Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.
Adds a location scope to the request for location-aware reads, writes, and audit entries.
Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.
Value in
- "hexclave"
Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.
Response Body
application/json
curl -X GET "https://example.com/inventory/string" \ -H "x-tenant-id: tenant-local" \ -H "x-tenant-slug: trellis-local" \ -H "x-location-id: loc-tasting-room" \ -H "x-auth-provider: hexclave" \ -H "x-auth-user-id: user_abc123"{ "id": "string", "inventoryLocationTitle": "string", "inventoryLocationId": "string", "productVariantId": "string", "productVariantTitle": "string", "sku": "string", "upcCode": "string", "hasInventory": true, "availableForSaleCount": 0, "reserveCount": 0, "allocatedCount": 0, "inventoryPolicy": "string", "productId": "string", "productTitle": "string"}Header Parameters
Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.
Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.
Adds a location scope to the request for location-aware reads, writes, and audit entries.
Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.
Value in
- "hexclave"
Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/inventory-transaction" \ -H "x-tenant-id: tenant-local" \ -H "x-tenant-slug: trellis-local" \ -H "x-location-id: loc-tasting-room" \ -H "x-auth-provider: hexclave" \ -H "x-auth-user-id: user_abc123" \ -H "Content-Type: application/json" \ -d '{ "action": "Reset", "sku": "string", "availableForSaleCount": 0, "reserveCount": 0, "inventoryLocationId": "string" }'{ "inventoryLocationId": "string", "sku": "string", "productVariantId": "string", "transactionType": "string", "transactionDetails": "string", "notes": "string", "availableForSaleCount": 0, "reserveCount": 0, "allocatedCount": 0, "id": "string", "transactionDate": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "searchText": "string"}Commerce7 basis: Inventory and Inventory Location. This slice handles per-location stock visibility and depletion-ready counts.
Query Parameters
Header Parameters
Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.
Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.
Adds a location scope to the request for location-aware reads, writes, and audit entries.
Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.
Value in
- "hexclave"
Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.
Response Body
application/json
curl -X GET "https://example.com/inventory/items" \ -H "x-tenant-id: tenant-local" \ -H "x-tenant-slug: trellis-local" \ -H "x-location-id: loc-tasting-room" \ -H "x-auth-provider: hexclave" \ -H "x-auth-user-id: user_abc123"{ "items": [ { "id": "string", "productId": "string", "locationId": "string", "onHand": 0, "reserved": 0, "available": 0, "reorderPoint": 0, "parLevel": 0, "updatedAt": "2019-08-24T14:15:22Z" } ], "page": { "total": 0 }}Header Parameters
Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.
Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.
Adds a location scope to the request for location-aware reads, writes, and audit entries.
Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.
Value in
- "hexclave"
Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/inventory/items" \ -H "x-tenant-id: tenant-local" \ -H "x-tenant-slug: trellis-local" \ -H "x-location-id: loc-tasting-room" \ -H "x-auth-provider: hexclave" \ -H "x-auth-user-id: user_abc123" \ -H "Content-Type: application/json" \ -d '{ "productId": "string", "locationId": "string", "onHand": 0, "reorderPoint": 0, "parLevel": 0 }'{ "id": "string", "productId": "string", "locationId": "string", "onHand": 0, "reserved": 0, "available": 0, "reorderPoint": 0, "parLevel": 0, "updatedAt": "2019-08-24T14:15:22Z"}Path Parameters
1 <= lengthHeader Parameters
Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.
Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.
Adds a location scope to the request for location-aware reads, writes, and audit entries.
Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.
Value in
- "hexclave"
Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.
Response Body
application/json
curl -X GET "https://example.com/inventory/items/string" \ -H "x-tenant-id: tenant-local" \ -H "x-tenant-slug: trellis-local" \ -H "x-location-id: loc-tasting-room" \ -H "x-auth-provider: hexclave" \ -H "x-auth-user-id: user_abc123"{ "id": "string", "productId": "string", "locationId": "string", "onHand": 0, "reserved": 0, "available": 0, "reorderPoint": 0, "parLevel": 0, "updatedAt": "2019-08-24T14:15:22Z"}Path Parameters
1 <= lengthHeader Parameters
Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.
Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.
Adds a location scope to the request for location-aware reads, writes, and audit entries.
Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.
Value in
- "hexclave"
Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X PATCH "https://example.com/inventory/items/string" \ -H "x-tenant-id: tenant-local" \ -H "x-tenant-slug: trellis-local" \ -H "x-location-id: loc-tasting-room" \ -H "x-auth-provider: hexclave" \ -H "x-auth-user-id: user_abc123" \ -H "Content-Type: application/json" \ -d '{ "reorderPoint": 0, "parLevel": 0 }'{ "id": "string", "productId": "string", "locationId": "string", "onHand": 0, "reserved": 0, "available": 0, "reorderPoint": 0, "parLevel": 0, "updatedAt": "2019-08-24T14:15:22Z"}Returns the tenant-scoped adjustment ledger with product and location snapshots for audit and reporting.
Query Parameters
date-timedate-time0 <= value1 <= value <= 500Header Parameters
Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.
Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.
Adds a location scope to the request for location-aware reads, writes, and audit entries.
Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.
Value in
- "hexclave"
Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.
Response Body
application/json
curl -X GET "https://example.com/inventory/adjustments" \ -H "x-tenant-id: tenant-local" \ -H "x-tenant-slug: trellis-local" \ -H "x-location-id: loc-tasting-room" \ -H "x-auth-provider: hexclave" \ -H "x-auth-user-id: user_abc123"{ "items": [ { "id": "string", "inventoryItemId": "string", "productId": "string", "productTitle": "string", "sku": "string", "locationId": "string", "locationName": "string", "reason": "sale", "delta": 0, "note": "string", "wasteReasonGuid": "string", "wasteReasonName": "string", "previousOnHand": 0, "newOnHand": 0, "transactionId": "string", "createdByStaffUserId": "string", "createdAt": "2019-08-24T14:15:22Z" } ], "total": 0}Use this for stock counts, waste, transfers, and receiving. A future implementation can fan out into ledger-style movement records and costing.
Header Parameters
Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.
Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.
Adds a location scope to the request for location-aware reads, writes, and audit entries.
Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.
Value in
- "hexclave"
Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/inventory/adjustments" \ -H "x-tenant-id: tenant-local" \ -H "x-tenant-slug: trellis-local" \ -H "x-location-id: loc-tasting-room" \ -H "x-auth-provider: hexclave" \ -H "x-auth-user-id: user_abc123" \ -H "Content-Type: application/json" \ -d '{ "inventoryItemId": "string", "reason": "sale", "delta": 0 }'{ "id": "string", "inventoryItemId": "string", "productId": "string", "productTitle": "string", "sku": "string", "locationId": "string", "locationName": "string", "reason": "sale", "delta": 0, "note": "string", "wasteReasonGuid": "string", "wasteReasonName": "string", "previousOnHand": 0, "newOnHand": 0, "transactionId": "string", "createdByStaffUserId": "string", "createdAt": "2019-08-24T14:15:22Z"}Builds food-waste totals and reason breakdowns exclusively from the persisted inventory adjustment ledger.
Query Parameters
date-timedate-time1 <= value <= 500Header Parameters
Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.
Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.
Adds a location scope to the request for location-aware reads, writes, and audit entries.
Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.
Value in
- "hexclave"
Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.
Response Body
application/json
curl -X GET "https://example.com/inventory/reports/food-waste" \ -H "x-tenant-id: tenant-local" \ -H "x-tenant-slug: trellis-local" \ -H "x-location-id: loc-tasting-room" \ -H "x-auth-provider: hexclave" \ -H "x-auth-user-id: user_abc123"{ "items": [ { "id": "string", "inventoryItemId": "string", "productId": "string", "productTitle": "string", "sku": "string", "locationId": "string", "locationName": "string", "reason": "sale", "delta": 0, "note": "string", "wasteReasonGuid": "string", "wasteReasonName": "string", "previousOnHand": 0, "newOnHand": 0, "transactionId": "string", "createdByStaffUserId": "string", "createdAt": "2019-08-24T14:15:22Z" } ], "total": 0, "returned": 0, "totalUnits": 0, "affectedProducts": 0, "reasonBreakdown": [ { "reason": "string", "adjustments": 0, "units": 0 } ], "dailyTotals": [ { "date": "string", "adjustments": 0, "units": 0 } ]}Path Parameters
1 <= lengthHeader Parameters
Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.
Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.
Adds a location scope to the request for location-aware reads, writes, and audit entries.
Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.
Value in
- "hexclave"
Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.
Response Body
application/json
curl -X GET "https://example.com/inventory/availability/string" \ -H "x-tenant-id: tenant-local" \ -H "x-tenant-slug: trellis-local" \ -H "x-location-id: loc-tasting-room" \ -H "x-auth-provider: hexclave" \ -H "x-auth-user-id: user_abc123"{ "id": "string", "available": 0, "onHand": 0, "reserved": 0}Header Parameters
Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.
Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.
Adds a location scope to the request for location-aware reads, writes, and audit entries.
Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.
Value in
- "hexclave"
Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.
Response Body
application/json
curl -X GET "https://example.com/inventory-location" \ -H "x-tenant-id: tenant-local" \ -H "x-tenant-slug: trellis-local" \ -H "x-location-id: loc-tasting-room" \ -H "x-auth-provider: hexclave" \ -H "x-auth-user-id: user_abc123"{ "inventoryLocations": [ { "id": "string", "title": "string", "address": "string", "address2": "string", "city": "string", "stateCode": "string", "zipCode": "string", "countryCode": "string", "phone": "string", "isWebShipLocation": true, "isInboundShipLocation": true, "isClubShipLocation": true, "isAPickupLocation": true, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ], "total": 0}Commerce7 exact parity for inventory-location records and documented field names.
Header Parameters
Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.
Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.
Adds a location scope to the request for location-aware reads, writes, and audit entries.
Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.
Value in
- "hexclave"
Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/inventory-location" \ -H "x-tenant-id: tenant-local" \ -H "x-tenant-slug: trellis-local" \ -H "x-location-id: loc-tasting-room" \ -H "x-auth-provider: hexclave" \ -H "x-auth-user-id: user_abc123" \ -H "Content-Type: application/json" \ -d '{ "title": "string", "address": "string", "city": "string", "stateCode": "string", "zipCode": "string", "countryCode": "string", "phone": "string", "isWebShipLocation": true, "isClubShipLocation": true, "isAPickupLocation": true }'{ "id": "string", "title": "string", "address": "string", "address2": "string", "city": "string", "stateCode": "string", "zipCode": "string", "countryCode": "string", "phone": "string", "isWebShipLocation": true, "isInboundShipLocation": true, "isClubShipLocation": true, "isAPickupLocation": true, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z"}Path Parameters
1 <= lengthHeader Parameters
Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.
Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.
Adds a location scope to the request for location-aware reads, writes, and audit entries.
Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.
Value in
- "hexclave"
Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.
Response Body
application/json
curl -X GET "https://example.com/inventory-location/string" \ -H "x-tenant-id: tenant-local" \ -H "x-tenant-slug: trellis-local" \ -H "x-location-id: loc-tasting-room" \ -H "x-auth-provider: hexclave" \ -H "x-auth-user-id: user_abc123"{ "id": "string", "title": "string", "address": "string", "address2": "string", "city": "string", "stateCode": "string", "zipCode": "string", "countryCode": "string", "phone": "string", "isWebShipLocation": true, "isInboundShipLocation": true, "isClubShipLocation": true, "isAPickupLocation": true, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z"}Header Parameters
Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.
Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.
Adds a location scope to the request for location-aware reads, writes, and audit entries.
Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.
Value in
- "hexclave"
Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/stock/v1/inventory/search" \ -H "x-tenant-id: tenant-local" \ -H "x-tenant-slug: trellis-local" \ -H "x-location-id: loc-tasting-room" \ -H "x-auth-provider: hexclave" \ -H "x-auth-user-id: user_abc123" \ -H "toast-restaurant-external-id: string" \ -H "Content-Type: application/json" \ -d '{}'[ null]Header Parameters
Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.
Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.
Adds a location scope to the request for location-aware reads, writes, and audit entries.
Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.
Value in
- "hexclave"
Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.
Response Body
application/json
curl -X GET "https://example.com/stock/v1/inventory" \ -H "x-tenant-id: tenant-local" \ -H "x-tenant-slug: trellis-local" \ -H "x-location-id: loc-tasting-room" \ -H "x-auth-provider: hexclave" \ -H "x-auth-user-id: user_abc123" \ -H "toast-restaurant-external-id: string"[ null]Header Parameters
Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.
Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.
Adds a location scope to the request for location-aware reads, writes, and audit entries.
Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.
Value in
- "hexclave"
Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X PUT "https://example.com/stock/v1/inventory/update" \ -H "x-tenant-id: tenant-local" \ -H "x-tenant-slug: trellis-local" \ -H "x-location-id: loc-tasting-room" \ -H "x-auth-provider: hexclave" \ -H "x-auth-user-id: user_abc123" \ -H "toast-restaurant-external-id: string" \ -H "Content-Type: application/json" \ -d '[ { "property1": null, "property2": null } ]'[ null]