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 call-off order requested quantity across all sites for a tenant. Includes the grand total and optional breakdowns by product code, customer account, order status, and requested ship month.

byCustomer
object[] | null

Requested 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

Requested 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.

byRequestedShipMonth
object[] | null

Requested quantity broken down by the month of items[].requestedShipDate. Each entry's Key is an ISO-8601 month string (e.g. "2026-03"). Items without a requested ship date are excluded from this breakdown.

byStatus
object[] | null

Requested quantity broken down by call-off order status. Each entry's Key is the order-level status string (e.g. "Open", "Completed").

totalRequestedQty
integer<int64>

Sum of items[].requestedQty across all matched call-off order items.