API reference


The return object and the allowed CRUD operations on the related resource endpoint
Returns are linked to one specific order. They get created in draft status and become requested when a customer requests to return SKUs from an order. Requested returns can be approved or cancelled. An approved return becomes shipped once it leaves the customer address (origin). Returns are marked received once they reach the available return location (destination), where they can be restocked to an inventory location. Otherwise, in case of any errors (e.g. the customer sent back the wrong products) shipped returns will be marked as rejected.
Data model
Check the related ER diagram and explore the flowchart that illustrates how the return resource relates to the other API entities.