Order returns work analogously to orders in Base and have their own, mirrored block of API methods.
The main method
getOrderReturns downloads returns from Base from a given date, max. 100 per call — the same pagination principle as getOrders.
| Parameter | Type | Description |
|---|
order_id | int | ID of the original order the return was created from. |
return_id | int | Downloads a single specific return. |
date_from | int (unix) | Return creation date to start collecting from. |
id_from | int | Return ID to start from. |
status_id | int | Limits results to a specific return status. |
filter_order_return_source, filter_order_return_source_id | — | Filter by return source (marketplace code). |
include_custom_extra_fields | bool | Adds custom field values — see Extra fields; the same principle applies to returns via getOrderReturnExtraFields. |
Unlike orders, there is no confirmed/unconfirmed concept for returns (no date_confirmed) — page through results using date_from (plus the last processed record’s value +1s), or id_from.
Key response fields
| Field | Description |
|---|
return_id / order_id | Return ID and the original order’s ID. |
status_id | Return status — list via getOrderReturnStatusList, same concept as order Statuses. |
fulfillment_status | Numeric processing state: 0 active, 5 accepted, 1 done, 2 cancelled. |
refunded | Whether the return has already been refunded. |
order_return_account_number / order_return_iban / order_return_swift | Bank details for refunding the customer. |
products | Returned line items (same structure as an order, plus return_reason_id). |
Working with statuses and refunds
Tracking changes over time
Just like orders, returns have their own journal: getOrderReturnJournalList — same principle and activation requirement (Profile → API) as getJournalList.
Returns from marketplace channels
For selected marketplace channels, Base can automatically fetch return requests directly from the customer and create returns from them — configurable per sales channel. Once enabled, just monitor new returns as described above.
If you also handle return shipping labels, the principle is the same as for standard shipments — see Shipping labels, just with return_shipment: true.