Create a buy x pay y promotion
How to create a buy x pay y promotion via API
To create a new buy x pay y promotion, send a POST
request to the /api/buy_x_pay_y_promotions
endpoint, passing the resource arguments in the request body.
Request
POST https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions
Arguments
type
string
Required
attributes.name
string
Required
attributes.currency_code
string
Optional
attributes.exclusive
boolean
Optional
attributes.priority
integer
Optional
attributes.starts_at
datetime
Required
attributes.expires_at
datetime
Required
attributes.total_usage_limit
integer
Optional
attributes._disable
boolean
Optional
attributes._enable
boolean
Optional
attributes.reference
string
Optional
attributes.reference_origin
string
Optional
attributes.metadata
object
Optional
attributes.x
integer
Required
attributes.y
integer
Required
attributes.cheapest_free
boolean
Optional, default is 'false'
relationships.market
object
Optional
relationships.order_amount_promotion_rule
object
Optional
relationships.sku_list_promotion_rule
object
Optional
relationships.coupon_codes_promotion_rule
object
Optional
relationships.custom_promotion_rule
object
Optional
relationships.sku_list
object
Required
relationships.tags
array
Optional
Example
The following request creates a new buy x pay y promotion:
curl -g -X POST \
'https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions' \
-H 'Accept: application/vnd.api+json' \
-H 'Authorization: Bearer your-access-token' \
-H 'Content-Type: application/vnd.api+json' \
-d '{
"data": {
"type": "buy_x_pay_y_promotions",
"attributes": {
"name": "Personal promotion",
"starts_at": "2018-01-01T12:00:00.000Z",
"expires_at": "2018-01-02T12:00:00.000Z",
"x": 3,
"y": 2
},
"relationships": {
"sku_list": {
"data": {
"type": "sku_lists",
"id": "ABCRtyUpBa"
}
}
}
}
}'
Last updated