Get Brand PO History
GET/api/reporting/brands/:brand/po-history
Recent purchase orders containing one brand's products — backs the "Recent Purchase Orders" mini-table on the brand Analytics tab. Returns up to the 10 most recent non-draft purchase orders ordered by purchase order date (DESC), each with its receipt status and an on-time flag.
Authentication: Requires Bearer token (scope: reports)
Path parameters:
- brand: the Brand ID
This endpoint is period-independent — it always returns the most recent purchase orders and takes no query parameters. Draft purchase orders are excluded.
Response fields per row:
- id: purchase order ID
- po_number: human-readable purchase order number
- purchase_order_date: order date (Y-m-d)
- total_cost: total purchase order cost
- receipt_status: receipt status of the PO (e.g. unreceived, partially_received, fully_received)
- on_time: true if fully received on or before the estimated delivery date, false if late, null if not yet fully received
Request
Responses
- 200
- 401
- 403
- 404
- 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.
Not Found
Response Headers
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.