Skip to main content

Get Dropship Order by Retailer Order Number

GET 
/api/portal/dropship/orders/:retailerOrderNumber

Gets one dropship order by your order number — the retailer_order_number you sent when creating it. Use this to poll status and pick up tracking. If the same number was used again after an earlier order was cancelled, the open (non-cancelled) order is returned; otherwise the most recent one. URL-encode the number if it contains special characters.

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: 404 not_found when your account has no dropship order with that number.

Request​

Responses​

OK

Response Headers
    Content-Type