API reference
Search
K
Links

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

Request
Response
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": "xYZkjABcde",
"type": "recurring_order_copies",
"links": {
"self": "https://yourdomain.commercelayer.io/api/recurring_order_copies/xYZkjABcde"
},
"attributes": {
"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/xYZkjABcde/relationships/source_order",
"related": "https://yourdomain.commercelayer.io/api/recurring_order_copies/xYZkjABcde/source_order"
}
},
"target_order": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/recurring_order_copies/xYZkjABcde/relationships/target_order",
"related": "https://yourdomain.commercelayer.io/api/recurring_order_copies/xYZkjABcde/target_order"
}
},
"events": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/recurring_order_copies/xYZkjABcde/relationships/events",
"related": "https://yourdomain.commercelayer.io/api/recurring_order_copies/xYZkjABcde/events"
}
},
"order_subscription": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/recurring_order_copies/xYZkjABcde/relationships/order_subscription",
"related": "https://yourdomain.commercelayer.io/api/recurring_order_copies/xYZkjABcde/order_subscription"
}
}
},
"meta": {
"mode": "test"
}
},
{
"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:
  • status
  • started_at
  • completed_at
  • failed_at
  • errors_count
  • id
  • created_at
  • updated_at
  • reference
  • reference_origin

Filterable fields

The list of recurring order copies can be filtered by the following fields:

Attributes

  • status
  • started_at
  • completed_at
  • failed_at
  • errors_count
  • id
  • created_at
  • updated_at
  • reference
  • reference_origin
  • metadata

Relationships

  • source_order
  • target_order
  • events
  • order_subscription