API reference
Search
K
Links
Comment on page

Update an order amount promotion rule

How to update an existing order amount promotion rule via API
To update an existing order amount promotion rule, send a PATCH request to the /api/order_amount_promotion_rules/: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.

Request

PATCH https://yourdomain.commercelayer.io/api/order_amount_promotion_rules/:id

Arguments

Body Parameter
Type
Required
type
string
Required
id
string
Required
attributes.reference
string
Optional
attributes.reference_origin
string
Optional
attributes.metadata
object
Optional
attributes.order_amount_cents
integer
Optional
attributes.use_subtotal
boolean
Optional
relationships.promotion
object
Optional

Example

Request
Response
The following request updates the order amount promotion rule identified by the ID "xYZkjABcde":
curl -g -X PATCH \
'https://yourdomain.commercelayer.io/api/order_amount_promotion_rules/xYZkjABcde' \
-H 'Accept: application/vnd.api+json' \
-H 'Authorization: Bearer your-access-token' \
-H 'Content-Type: application/vnd.api+json' \
-d '{
"data": {
"type": "order_amount_promotion_rules",
"id": "xYZkjABcde",
"attributes": {
"reference": "ANY-EXTERNAL-REFEFERNCE"
},
"relationships": {
"promotion": {
"data": {
"type": "promotions",
"id": "ABCRtyUpBa"
}
}
}
}
}'
On success, the API responds with a 200 OK status code, returning the updated resource object:
{
"data": {
"id": "xYZkjABcde",
"type": "order_amount_promotion_rules",
"links": {
"self": "https://yourdomain.commercelayer.io/api/order_amount_promotion_rules/xYZkjABcde"
},
"attributes": {
"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"
},
"order_amount_cents": 1000,
"order_amount_float": 10.0,
"formatted_order_amount": "€10,00",
"use_subtotal": true
},
"relationships": {
"promotion": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/order_amount_promotion_rules/xYZkjABcde/relationships/promotion",
"related": "https://yourdomain.commercelayer.io/api/order_amount_promotion_rules/xYZkjABcde/promotion"
}
},
"versions": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/order_amount_promotion_rules/xYZkjABcde/relationships/versions",
"related": "https://yourdomain.commercelayer.io/api/order_amount_promotion_rules/xYZkjABcde/versions"
}
}
},
"meta": {
"mode": "test"
}
}
}