List all recurring order copies
How to fetch a collection of recurring order copies via API
To fetch a collection of recurring order copies, send a GET request to the /api/recurring_order_copies endpoint.
Request
GET https://yourdomain.commercelayer.io/api/recurring_order_copies
Example
The following request fetches a collection of recurring order copies:
curl -g -X GET \
'https://yourdomain.commercelayer.io/api/recurring_order_copies/' \
-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": "recurring_order_copies",
"links": {
"self": "https://yourdomain.commercelayer.io/api/recurring_order_copies/XAyRWNUzyN"
},
"attributes": {
"type": "recurring_order_copies",
"status": "in_progress",
"started_at": "2018-01-01T12:00:00.000Z",
"completed_at": "2018-01-01T12:00:00.000Z",
"failed_at": "2018-01-01T12:00:00.000Z",
"errors_log": {
"status": [
"cannot transition from draft to placed"
]
},
"errors_count": 2,
"place_target_order": true,
"reuse_wallet": true,
"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": {
"source_order": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/recurring_order_copies/XAyRWNUzyN/relationships/source_order",
"related": "https://yourdomain.commercelayer.io/api/recurring_order_copies/XAyRWNUzyN/source_order"
}
},
"target_order": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/recurring_order_copies/XAyRWNUzyN/relationships/target_order",
"related": "https://yourdomain.commercelayer.io/api/recurring_order_copies/XAyRWNUzyN/target_order"
}
},
"events": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/recurring_order_copies/XAyRWNUzyN/relationships/events",
"related": "https://yourdomain.commercelayer.io/api/recurring_order_copies/XAyRWNUzyN/events"
}
},
"event_stores": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/recurring_order_copies/XAyRWNUzyN/relationships/event_stores",
"related": "https://yourdomain.commercelayer.io/api/recurring_order_copies/XAyRWNUzyN/event_stores"
}
},
"order_subscription": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/recurring_order_copies/XAyRWNUzyN/relationships/order_subscription",
"related": "https://yourdomain.commercelayer.io/api/recurring_order_copies/XAyRWNUzyN/order_subscription"
}
}
},
"meta": {
"mode": "test",
"organization_id": "xRRkjDFafe",
"trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74"
}
},
{
"other": "... 9 recurring_order_copies (first page)"
}
],
"meta": {
"record_count": 140,
"page_count": 14
},
"links": {
"first": "https://yourdomain.commercelayer.io/api/recurring_order_copies?page[number]=1&page[size]=10",
"next": "https://yourdomain.commercelayer.io/api/recurring_order_copies?page[number]=2&page[size]=10",
"last": "https://yourdomain.commercelayer.io/api/recurring_order_copies?page[number]=14&page[size]=10"
}
}Remember that when you fetch a list of resources you get paginated result.
Sortable fields
The list of recurring order copies can be sorted by the following fields:
Attributes
typestatusstarted_atcompleted_atfailed_aterrors_countidcreated_atupdated_atreferencereference_origin
Relationships
order_subscription
Filterable fields
The list of recurring order copies can be filtered by the following fields:
Attributes
typestatusstarted_atcompleted_atfailed_aterrors_countidcreated_atupdated_atreferencereference_originmetadata
Relationships
source_ordertarget_ordereventsorder_subscription
Last updated

