Comment on page
Update a recurring order copy
How to update an existing recurring order copy via API
To update an existing recurring order copy, send a
PATCH
request to the /api/recurring_order_copies/:id
endpoint, where id
is the ID of the resource that you want to update.Here below the list of all the possible arguments that you can pass with the request body.
PATCH https://yourdomain.commercelayer.io/api/recurring_order_copies/:id
Body Parameter | Type | Required |
---|---|---|
type | string | Required |
id | string | Required |
attributes.reference | string | Optional |
attributes.reference_origin | string | Optional |
attributes.metadata | object | Optional |
Request
Response
The following request updates the recurring order copy identified by the ID "xYZkjABcde":
curl -g -X PATCH \
'https://yourdomain.commercelayer.io/api/recurring_order_copies/xYZkjABcde' \
-H 'Accept: application/vnd.api+json' \
-H 'Authorization: Bearer your-access-token' \
-H 'Content-Type: application/vnd.api+json' \
-d '{
"data": {
"type": "recurring_order_copies",
"id": "xYZkjABcde",
"attributes": {
"reference": "ANY-EXTERNAL-REFEFERNCE"
}
}
}'
On success, the API responds with a
200 OK
status code, returning the updated resource object:{
"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"
}
}
}
Last modified 8mo ago