Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Query Parameters

filter
string
responseFields
string

limits which fields are returned in the response body

Response

OK

Result of aggregating blanket order remaining quantity. Includes the grand total, per-product-code sums, and optional breakdowns by customer account and order status.

byCustomer
object[] | null

Remaining quantity broken down by customer account. Each entry's Key is the customer account id as a string, or "anonymous" for orders without an account.

byProductCode
object[] | null

Remaining quantity broken down by product code. Each entry's Key is a product code. Only product codes with at least one matching item appear here (no zero-quantity back-fill).

byStatus
object[] | null

Remaining quantity broken down by blanket order status. Each entry's Key is the order-level status string (e.g. "Active", "Completed").

totalRemainingQuantity
integer<int64>

Sum of items[].remainingQuantity across all matched blanket orders.