Get Returnable Lines by Order Number
GET/api/portal/returns/lookup
Finds an order on the active account by the buyer's own order number — the retailer order number of a dropship order, or else the customer PO number — and returns its returnable lines, exactly like Get Returnable Lines. Use it to start a return when the buyer knows their own order number rather than the merchant's. When several orders match, the most recent one that is not cancelled is used.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
dropship is null for a normal order. For a dropship order it carries the return terms to give the end customer: retailer_order_number; destination — merchant_warehouse_retailer_named (returns go to the merchant's warehouse, addressed in the retailer's name so the merchant stays hidden) or retailer (returns go to the retailer's own address); return_address and return_address_lines (the same address as structured fields and as printable lines; null / empty when no return address is known yet, e.g. nothing has shipped); and restocking_fee_percent deducted from the credit for returned goods.
Returns 404 when no order on the account has that number, and 422 when retailer_order_number is missing.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 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
Unprocessable Entity
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.