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'

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

Last updated