List Supplier Pickup Orders
GET/api/reports/supplier-pickup-orders
Paginated Supplier Pickup Orders report — one row per drop-ship purchase-order line whose requested shipping method is a supplier pickup (vendor will-call), so a customer collects the goods directly from the merchant's supplier. Each row carries COGS (from the purchase-order line), revenue (from the matching sales-order line), margin, the customer, the supplier, the pickup location, and the derived pickup status.
Filters (Spatie filter[...]): search (SKU, product name, PO number, SO number, customer name, supplier name, or row id), status (picked_up | awaiting_pickup | all), customer_id (comma-separated customer ids), supplier_id (comma-separated), warehouse_id (comma-separated pickup-location / supplier-warehouse ids), customer_tag (comma-separated tag names on the customer).
Advanced grouped filters are also accepted via a filter_groups tree over the columns expected_pickup_at, order_date, quantity, customer, supplier, product, sku.
Sorting (sort, prefix - for descending): id, order_date, expected_pickup_at, days_open, customer, supplier. Default order is newest order date first.
Pagination: page, per_page (default 10).
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.