API reference
Search
K
Links
Comment on page

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

Request
Response
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'
On success, the API responds with a 200 OK status code, returning a paginated collection of resource objects:
{
"data": [
{
"id": "xYZkjABcde",
"type": "exports",
"links": {
"self": "https://yourdomain.commercelayer.io/api/exports/xYZkjABcde"
},
"attributes": {
"resource_type": "skus",
"format": "json",
"status": "in_progress",
"includes": [
"prices.price_tiers"
],
"filters": {
"code_eq": "AAA"
},
"dry_data": false,
"started_at": "2018-01-01T12:00:00.000Z",
"completed_at": "2018-01-01T12:00:00.000Z",
"interrupted_at": "2018-01-01T12:00:00.000Z",
"records_count": 300,
"attachment_url": "http://cl_exports.s3.amazonaws.com/",
"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": {
"events": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/exports/xYZkjABcde/relationships/events",
"related": "https://yourdomain.commercelayer.io/api/exports/xYZkjABcde/events"
}
}
},
"meta": {
"mode": "test"
}
},
{
"other": "... 9 exports (first page)"
}
],
"meta": {
"record_count": 140,
"page_count": 14
},
"links": {
"first": "https://yourdomain.commercelayer.io/api/exports?page[number]=1&page[size]=10",
"next": "https://yourdomain.commercelayer.io/api/exports?page[number]=2&page[size]=10",
"last": "https://yourdomain.commercelayer.io/api/exports?page[number]=14&page[size]=10"
}
}
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