List all returns
GET https://{{subdomain}}.commercelayer.io/api/returns
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
Authorization | string |
RESPONSES
status: OK
{"data":[{"id":"xYZkjABcde","type":"returns","links":{"self":"https://yourdomain.commercelayer.io/api/returns/xYZkjABcde"},"attributes":{"number":"#1234/R/001","status":"draft","customer_email":"john@example.com","skus_count":2,"approved_at":"2018-01-01T12:00:00.000Z","cancelled_at":"2018-01-01T12:00:00.000Z","shipped_at":"2018-01-01T12:00:00.000Z","rejected_at":"2018-01-01T12:00:00.000Z","received_at":"2018-01-01T12:00:00.000Z","refunded_at":"2018-01-01T12:00:00.000Z","archived_at":"2018-01-01T12:00:00.000Z","estimated_refund_amount_cents":500,"estimated_refund_amount_float":5.0,"formatted_estimated_refund_amount":"€5,00","created_at":"2018-01-01T12:00:00.000Z","updated_at":"2018-01-01T12:00:00.000Z","reference":"ANY-EXTERNAL-REFEFERNCE","reference_origin":"ANY-EXTERNAL-REFEFERNCE-ORIGIN","metadata":{"foo":"bar"}},"relationships":{"order":{"links":{"self":"https://yourdomain.commercelayer.io/api/returns/xYZkjABcde/relationships/order","related":"https://yourdomain.commercelayer.io/api/returns/xYZkjABcde/order"}},"customer":{"links":{"self":"https://yourdomain.commercelayer.io/api/returns/xYZkjABcde/relationships/customer","related":"https://yourdomain.commercelayer.io/api/returns/xYZkjABcde/customer"}},"stock_location":{"links":{"self":"https://yourdomain.commercelayer.io/api/returns/xYZkjABcde/relationships/stock_location","related":"https://yourdomain.commercelayer.io/api/returns/xYZkjABcde/stock_location"}},"origin_address":{"links":{"self":"https://yourdomain.commercelayer.io/api/returns/xYZkjABcde/relationships/origin_address","related":"https://yourdomain.commercelayer.io/api/returns/xYZkjABcde/origin_address"}},"destination_address":{"links":{"self":"https://yourdomain.commercelayer.io/api/returns/xYZkjABcde/relationships/destination_address","related":"https://yourdomain.commercelayer.io/api/returns/xYZkjABcde/destination_address"}},"reference_capture":{"links":{"self":"https://yourdomain.commercelayer.io/api/returns/xYZkjABcde/relationships/reference_capture","related":"https://yourdomain.commercelayer.io/api/returns/xYZkjABcde/reference_capture"}},"reference_refund":{"links":{"self":"https://yourdomain.commercelayer.io/api/returns/xYZkjABcde/relationships/reference_refund","related":"https://yourdomain.commercelayer.io/api/returns/xYZkjABcde/reference_refund"}},"return_line_items":{"links":{"self":"https://yourdomain.commercelayer.io/api/returns/xYZkjABcde/relationships/return_line_items","related":"https://yourdomain.commercelayer.io/api/returns/xYZkjABcde/return_line_items"}},"attachments":{"links":{"self":"https://yourdomain.commercelayer.io/api/returns/xYZkjABcde/relationships/attachments","related":"https://yourdomain.commercelayer.io/api/returns/xYZkjABcde/attachments"}},"resource_errors":{"links":{"self":"https://yourdomain.commercelayer.io/api/returns/xYZkjABcde/relationships/resource_errors","related":"https://yourdomain.commercelayer.io/api/returns/xYZkjABcde/resource_errors"}},"events":{"links":{"self":"https://yourdomain.commercelayer.io/api/returns/xYZkjABcde/relationships/events","related":"https://yourdomain.commercelayer.io/api/returns/xYZkjABcde/events"}},"tags":{"links":{"self":"https://yourdomain.commercelayer.io/api/returns/xYZkjABcde/relationships/tags","related":"https://yourdomain.commercelayer.io/api/returns/xYZkjABcde/tags"}},"versions":{"links":{"self":"https://yourdomain.commercelayer.io/api/returns/xYZkjABcde/relationships/versions","related":"https://yourdomain.commercelayer.io/api/returns/xYZkjABcde/versions"}}},"meta":{"mode":"test"}},{"other":"... 9 returns (first page)"}],"meta":{"record_count":140,"page_count":14},"links":{"first":"https://yourdomain.commercelayer.io/api/returns?page[number]=1\u0026page[size]=10","next":"https://yourdomain.commercelayer.io/api/returns?page[number]=2\u0026page[size]=10","last":"https://yourdomain.commercelayer.io/api/returns?page[number]=14\u0026page[size]=10"}}