API reference
Search
K
Links

Update a SKU list promotion rule

How to update an existing SKU list promotion rule via API
To update an existing SKU list promotion rule, send a PATCH request to the /api/sku_list_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/sku_list_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.all_skus
boolean
Optional
attributes.min_quantity
integer
Optional
relationships.promotion
object
Optional
relationships.sku_list
object
Optional

Example

Request
Response
The following request updates the SKU list promotion rule identified by the ID "xYZkjABcde":
curl -g -X PATCH \
'https://yourdomain.commercelayer.io/api/sku_list_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": "sku_list_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": "sku_list_promotion_rules",
"links": {
"self": "https://yourdomain.commercelayer.io/api/sku_list_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"
},
"all_skus": true,
"min_quantity": 3
},
"relationships": {
"promotion": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/sku_list_promotion_rules/xYZkjABcde/relationships/promotion",
"related": "https://yourdomain.commercelayer.io/api/sku_list_promotion_rules/xYZkjABcde/promotion"
}
},
"versions": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/sku_list_promotion_rules/xYZkjABcde/relationships/versions",
"related": "https://yourdomain.commercelayer.io/api/sku_list_promotion_rules/xYZkjABcde/versions"
}
},
"sku_list": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/sku_list_promotion_rules/xYZkjABcde/relationships/sku_list",
"related": "https://yourdomain.commercelayer.io/api/sku_list_promotion_rules/xYZkjABcde/sku_list"
}
},
"skus": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/sku_list_promotion_rules/xYZkjABcde/relationships/skus",
"related": "https://yourdomain.commercelayer.io/api/sku_list_promotion_rules/xYZkjABcde/skus"
}
}
},
"meta": {
"mode": "test"
}
}
}