Get Drop-ship Order Money Summary
GET/api/reports/dropship-order-money/summary
KPI totals for the Drop-ship Order Money report, computed over the same filtered set as the list endpoint so the header cards never disagree with the rows beneath them.
reports:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Returns the number of drop-ship orders, the customer side (billed, received, outstanding) and the supplier side (committed, paid, outstanding). Accepts the same filters as the list endpoint (inline plus filter_groups), so the cards always agree with the rows; pagination and sort parameters are ignored.
The money columns (billed, received, customer due, PO total, deposits paid, supplier due) are computed per row from the underlying orders and deposits — they are returned on every row but are deliberately NOT filterable or sortable, because they are not database columns.
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.