The main method
getOrderReturns downloads returns from Base from a given date, max. 100 per call — the same pagination principle as getOrders.
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
Working with statuses and refunds
- Return statuses are read and written analogously to orders:
getOrderReturnStatusList,setOrderReturnStatus/setOrderReturnStatuses. - Return reasons (why the customer is returning the item) come from
getOrderReturnReasonsList. setOrderReturnRefundmarks a return as refunded — it does not trigger any actual payment, it only records the information in Base.
Tracking changes over time
Just like orders, returns have their own journal:getOrderReturnJournalList — same principle and activation requirement (Profile → API) as getJournalList.