List all returns

How to fetch a collection of returns via API

To fetch a collection of returns, send a GET request to the /api/returns endpoint.

Request

GET https://yourdomain.commercelayer.io/api/returns

Example

The following request fetches a collection of returns:

curl -g -X GET \
  'https://yourdomain.commercelayer.io/api/returns/' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token'

On success, the API responds with a 200 OK status code, returning a paginated collection of resource objects:

{
  "data": [
    {
      "id": "XAyRWNUzyN",
      "type": "returns",
      "links": {
        "self": "https://yourdomain.commercelayer.io/api/returns/XAyRWNUzyN"
      },
      "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/XAyRWNUzyN/relationships/order",
            "related": "https://yourdomain.commercelayer.io/api/returns/XAyRWNUzyN/order"
          }
        },
        "customer": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/returns/XAyRWNUzyN/relationships/customer",
            "related": "https://yourdomain.commercelayer.io/api/returns/XAyRWNUzyN/customer"
          }
        },
        "stock_location": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/returns/XAyRWNUzyN/relationships/stock_location",
            "related": "https://yourdomain.commercelayer.io/api/returns/XAyRWNUzyN/stock_location"
          }
        },
        "origin_address": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/returns/XAyRWNUzyN/relationships/origin_address",
            "related": "https://yourdomain.commercelayer.io/api/returns/XAyRWNUzyN/origin_address"
          }
        },
        "destination_address": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/returns/XAyRWNUzyN/relationships/destination_address",
            "related": "https://yourdomain.commercelayer.io/api/returns/XAyRWNUzyN/destination_address"
          }
        },
        "reference_capture": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/returns/XAyRWNUzyN/relationships/reference_capture",
            "related": "https://yourdomain.commercelayer.io/api/returns/XAyRWNUzyN/reference_capture"
          }
        },
        "reference_refund": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/returns/XAyRWNUzyN/relationships/reference_refund",
            "related": "https://yourdomain.commercelayer.io/api/returns/XAyRWNUzyN/reference_refund"
          }
        },
        "return_line_items": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/returns/XAyRWNUzyN/relationships/return_line_items",
            "related": "https://yourdomain.commercelayer.io/api/returns/XAyRWNUzyN/return_line_items"
          }
        },
        "attachments": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/returns/XAyRWNUzyN/relationships/attachments",
            "related": "https://yourdomain.commercelayer.io/api/returns/XAyRWNUzyN/attachments"
          }
        },
        "resource_errors": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/returns/XAyRWNUzyN/relationships/resource_errors",
            "related": "https://yourdomain.commercelayer.io/api/returns/XAyRWNUzyN/resource_errors"
          }
        },
        "events": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/returns/XAyRWNUzyN/relationships/events",
            "related": "https://yourdomain.commercelayer.io/api/returns/XAyRWNUzyN/events"
          }
        },
        "tags": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/returns/XAyRWNUzyN/relationships/tags",
            "related": "https://yourdomain.commercelayer.io/api/returns/XAyRWNUzyN/tags"
          }
        },
        "event_stores": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/returns/XAyRWNUzyN/relationships/event_stores",
            "related": "https://yourdomain.commercelayer.io/api/returns/XAyRWNUzyN/event_stores"
          }
        }
      },
      "meta": {
        "mode": "test",
        "organization_id": "xRRkjDFafe",
        "trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74"
      }
    },
    {
      "other": "... 9 returns (first page)"
    }
  ],
  "meta": {
    "record_count": 140,
    "page_count": 14,
    "page_size": 10,
    "page_number": 1,
    "mode": "test",
    "organization_id": "xRRkjDFafe",
    "trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74"
  },
  "links": {
    "first": "https://yourdomain.commercelayer.io/api/returns?page[number]=1&page[size]=10",
    "next": "https://yourdomain.commercelayer.io/api/returns?page[number]=2&page[size]=10",
    "last": "https://yourdomain.commercelayer.io/api/returns?page[number]=14&page[size]=10"
  }
}

Remember that when you fetch a list of resources you get paginated result.

Sortable fields

The list of returns can be sorted by the following fields:

Attributes

number
status
approved_at
cancelled_at
shipped_at
rejected_at
received_at
refunded_at
archived_at
id
created_at
updated_at
reference
reference_origin

Relationships

order
customer
stock_location
reference_capture
reference_refund

Filterable fields

The list of returns can be filtered by the following fields:

Attributes

number
status
skus_count
approved_at
cancelled_at
shipped_at
rejected_at
received_at
refunded_at
archived_at
id
created_at
updated_at
reference
reference_origin
metadata

Relationships

order
customer
stock_location
origin_address
destination_address
reference_capture
reference_refund
return_line_items
attachments
resource_errors
events
tags

PreviousCreate a return

NextRetrieve a return

Last updated 3 months ago