Pull Sales Order From Marketplace

Fetch one order from the marketplace it was placed on and store it in eDesk, given the order
ID the marketplace itself quotes. This is the API behind the "Pull Order by ID" screen in
eDesk, and it takes the same two values that screen asks for: the channel and the order ID.

Use it when an order is missing from eDesk and you do not want to wait for the next
scheduled import - a buyer is asking about an order your agents cannot see, or an order that
arrived while a channel was disconnected.

The call is idempotent. If eDesk already holds the order nothing is fetched and the stored
order is returned; if it does not, the marketplace is asked and the imported order is
returned. Either way the response is the order itself, in the same shape as
GET /sales-orders/{salesOrderId}.

data.id is the eDesk sales order ID the order was stored under. Keep it: it is what every
other endpoint takes the order by - GET /sales-orders/{salesOrderId},
PUT /sales-orders/{salesOrderId}, /sales-orders-tracking-links/{salesOrderId} and the
sales_order_id on a ticket.

The order is fetched while you wait, so this call is as slow as the marketplace is - allow
for tens of seconds - and it counts as a single request against your rate limit. The
marketplace's own rate limits apply on top of yours.

Supported marketplaces

Only the marketplaces below can be pulled from. Anything else is rejected with error code
4013. seller_order_id is the ID that marketplace quotes, which is not always the number
the buyer sees:

MarketplaceWhat to send as seller_order_idExampleOrder age limit
AmazonAmazon Order ID026-1234567-12345672 years
eBayOrderID, ExtendedOrderID or OrderLineItemID110512345678-987654321090 days
MagentoOrder increment ID100000123-
ShopifyOrder name as shown in Shopify, or the bare order number#1001-
BigCommerceStore order ID1234-
WalmartCustomer order ID1796277083022180 days
CdiscountCdiscount order number1234567890-
MiraklSuffixed logistic order ID, not the commercial order ID6730178216_1-A-
KauflandOrder unit ID, or the order ID to import every unit of an order123456789-
OttosalesOrderId (a UUID) or the short orderNumber4f6a1c2e-...-
AllegroCheckout form ID (a UUID)dcb2f0a5-...12 months
BolBol order IDC0008LCLRW90 days
FnacFnac order IDCV65PRPWGJEB2-
DartyDarty order ID (Darty sellers use a Fnac-type channel)127901946_314946-A-
ManoManoOrder referenceM260893258161-

Order age limits

Some marketplaces only serve orders up to a certain age:

MarketplaceOrder age limit
eBay90 days
Bol90 days
Walmart180 days
Allegro12 months
Amazon2 years

An order older than its marketplace's limit cannot be pulled. The marketplace answers a
request for it exactly as it answers a request for an order that never existed, so the
response is a 404 that cannot be told apart from a wrong ID - check the age of the order
before concluding the ID is wrong. If the order is not already in eDesk, there is no way to
fetch it.

A marketplace with no limit listed still applies its own retention rules, so an order being
old enough is always worth ruling out.

When no order comes back

A 404 means the marketplace was asked and had no such order - check the ID, that it belongs
to the channel you named, and that the order is within that marketplace's age limit. A 400
means the call never got through: the
channel connection has expired, the marketplace is rate limiting or temporarily down. In both
cases the response carries a sentence explaining what happened that is safe to show to a user

  • in error.details on a 404, and in error.message on a 400.

Pulling orders is a paid feature. An account without it gets a 403, the same way the
"Pull Order by ID" screen is hidden from it.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
required

The channel the order was placed on. It has to be one of yours, and one of the supported marketplaces - GET /channels lists them.

string
required
length ≤ 300

The order ID the marketplace quotes. Which ID that is differs per marketplace - see the table on this endpoint.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json