List all versions
How to fetch a collection of versions via API
To fetch a collection of versions, send a GET request to the /api/versions endpoint.
Request
GET https://yourdomain.commercelayer.io/api/versions
Example
The following request fetches a collection of versions:
curl -g -X GET \
'https://yourdomain.commercelayer.io/api/versions/' \
-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": "versions",
"links": {
"self": "https://yourdomain.commercelayer.io/api/versions/XAyRWNUzyN"
},
"attributes": {
"resource_type": "orders",
"resource_id": "PzdJhdLdYV",
"event": "update",
"changes": {
"status": [
"draft",
"placed"
]
},
"who": {
"application": {
"id": "DNOPYiZYpn",
"kind": "sales_channel",
"public": true
},
"owner": {
"id": "yQQrBhLBmQ",
"type": "Customer"
}
},
"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": {
"event_stores": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/versions/XAyRWNUzyN/relationships/event_stores",
"related": "https://yourdomain.commercelayer.io/api/versions/XAyRWNUzyN/event_stores"
}
}
},
"meta": {
"mode": "test",
"organization_id": "xRRkjDFafe",
"trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74"
}
},
{
"other": "... 9 versions (first page)"
}
],
"meta": {
"record_count": 140,
"page_count": 14
},
"links": {
"first": "https://yourdomain.commercelayer.io/api/versions?page[number]=1&page[size]=10",
"next": "https://yourdomain.commercelayer.io/api/versions?page[number]=2&page[size]=10",
"last": "https://yourdomain.commercelayer.io/api/versions?page[number]=14&page[size]=10"
}
}Remember that when you fetch a list of resources you get paginated result.
Sortable fields
The list of versions can be sorted by the following fields:
Attributes
idcreated_atupdated_atreferencereference_origin
Filterable fields
The list of versions can be filtered by the following fields:
Attributes
resource_typeresource_ididcreated_atupdated_atreferencereference_originmetadata
Last updated

