Skip to main content

List Dropship Orders

GET 
/api/portal/dropship/orders

Lists the dropship orders your account has sent to the supplier, newest first, 10 per page by default. Every order is pinned to your own account. Filters are plain query parameters (?status=shipped); the same names are also accepted as filter[status].

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Auth: a portal session bearer token, or a portal API key (pfk_…) with the dropship:read scope, sent as Authorization: Bearer. Requires an enabled dropship program; 60 requests a minute.

Order fields: id (use it to cancel), sales_order_number (your supplier's number), retailer_order_number (yours), status (received, processing, shipped, delivered, cancelled, on_hold; delivered is reserved — shipped orders currently stay shipped), hold_reason (credit, payment, review, billing, scheduled; only when on hold) with a readable hold_message, order_date (ISO 8601 UTC), ship_by_date (Y-m-d, the supplier's local date), sla (on_track, due_today, late, or null once the order is no longer open), intake_channel (portal, csv, api, edi, rep), batch_id (the CSV batch it came from), gift_message, service, ship_to, totals (money as 2-decimal strings: goods subtotal, dropship_fee, shipping, tax, total, currency), item_count, lines (sku, name, quantity, unit_price, shipped_quantity, cancelled_quantity), shipments (one per shipped package: carrier, service, tracking_number, tracking_url, shipped_at, and the SKUs and quantities in it), can_cancel with cancel_blocked_reason, and duplicate.

Errors: 422 for an unknown status, sla value or a malformed date.

Request​

Responses​

OK

Response Headers
    Content-Type