Get Supplier Pickup Summary
GET/api/reports/supplier-pickup-orders/summary
KPI summary totals for the Supplier Pickup Orders report header cards. Honours the same filters as the list endpoint (search, customer_id, supplier_id, warehouse_id, customer_tag, and the advanced filter_groups) EXCEPT status, which is ignored so both the awaiting and picked-up buckets are always represented.
Returns: open_count (distinct orders awaiting pickup), units_awaiting, value_awaiting (COGS of awaiting lines), picked_up_count (distinct picked-up orders), revenue_period and margin_period (revenue / margin of picked-up lines).
Authentication: Requires Bearer token
Request
Responses
- 200
- 401
- 403
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.