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's address (origin). As soon as they reach the available return location (destination), shipped returns can either be marked as received and restocked to an inventory location or — in case of any errors (e.g. the customer sent back the wrong products) — be marked as rejected.

Returns are still creatable and updatable even when the associated order's fulfillment status is in_progress.

Data model

Check the related ER diagram and explore the flowchart that illustrates how the return resource relates to the other API entities.

Last updated