List all exports

How to fetch a collection of exports via API

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

Request

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

Example

The following request fetches a collection of exports:

curl -g -X GET \
  'https://yourdomain.commercelayer.io/api/exports/' \
  -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 exports can be sorted by the following fields:

  • resource_type

  • format

  • status

  • started_at

  • completed_at

  • interrupted_at

  • records_count

  • attachment_url

  • id

  • created_at

  • updated_at

  • reference

  • reference_origin

Filterable fields

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

Attributes

  • resource_type

  • format

  • status

  • started_at

  • completed_at

  • interrupted_at

  • records_count

  • attachment_url

  • id

  • created_at

  • updated_at

  • reference

  • reference_origin

  • metadata

Relationships

  • events

Last updated