Create a SKU list promotion rule
How to create a SKU list promotion rule via API
To create a new SKU list promotion rule, send a POST request to the /api/sku_list_promotion_rules endpoint, passing the resource arguments in the request body.
Request
POST https://yourdomain.commercelayer.io/api/sku_list_promotion_rules
Arguments
Body Parameter
Type
Required
type
string
Required
attributes.reference
string
Optional
attributes.reference_origin
string
Optional
attributes.metadata
object
Optional
attributes.all_skus
boolean
Optional, default is 'false'
attributes.min_quantity
integer
Optional
relationships.promotion
object
Required
relationships.sku_list
object
Optional
Example
The following request creates a new SKU list promotion rule:
curl -g -X POST \
'https://yourdomain.commercelayer.io/api/sku_list_promotion_rules' \
-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",
"relationships": {
"promotion": {
"data": {
"type": "promotions",
"id": "ABCRtyUpBa"
}
}
}
}
}'On success, the API responds with a 201 Created status code, returning the created resource object:
{
"data": {
"id": "XAyRWNUzyN",
"type": "sku_list_promotion_rules",
"links": {
"self": "https://yourdomain.commercelayer.io/api/sku_list_promotion_rules/XAyRWNUzyN"
},
"attributes": {
"type": "coupon_codes_promotion_rules",
"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/XAyRWNUzyN/relationships/promotion",
"related": "https://yourdomain.commercelayer.io/api/sku_list_promotion_rules/XAyRWNUzyN/promotion"
}
},
"versions": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/sku_list_promotion_rules/XAyRWNUzyN/relationships/versions",
"related": "https://yourdomain.commercelayer.io/api/sku_list_promotion_rules/XAyRWNUzyN/versions"
}
},
"event_stores": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/sku_list_promotion_rules/XAyRWNUzyN/relationships/event_stores",
"related": "https://yourdomain.commercelayer.io/api/sku_list_promotion_rules/XAyRWNUzyN/event_stores"
}
},
"sku_list": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/sku_list_promotion_rules/XAyRWNUzyN/relationships/sku_list",
"related": "https://yourdomain.commercelayer.io/api/sku_list_promotion_rules/XAyRWNUzyN/sku_list"
}
},
"skus": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/sku_list_promotion_rules/XAyRWNUzyN/relationships/skus",
"related": "https://yourdomain.commercelayer.io/api/sku_list_promotion_rules/XAyRWNUzyN/skus"
}
}
},
"meta": {
"mode": "test",
"organization_id": "xRRkjDFafe",
"trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74"
}
}
}Last updated

