Links

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

Body Parameter
Type
Required
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

Request
Response
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"
}
}
}
}
}'
On success, the API responds with a 201 Created status code, returning the created resource object:
{
"data": {
"id": "xYZkjABcde",
"type": "buy_x_pay_y_promotions",
"links": {
"self": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde"
},
"attributes": {
"name": "Personal promotion",
"currency_code": "EUR",
"exclusive": true,
"priority": 2,
"starts_at": "2018-01-01T12:00:00.000Z",
"expires_at": "2018-01-02T12:00:00.000Z",
"total_usage_limit": 5,
"total_usage_count": 2,
"active": true,
"disabled_at": "2018-01-01T12:00:00.000Z",
"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"
},
"x": 3,
"y": 2,
"cheapest_free": true
},
"relationships": {
"market": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/relationships/market",
"related": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/market"
}
},
"promotion_rules": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/relationships/promotion_rules",
"related": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/promotion_rules"
}
},
"order_amount_promotion_rule": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/relationships/order_amount_promotion_rule",
"related": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/order_amount_promotion_rule"
}
},
"sku_list_promotion_rule": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/relationships/sku_list_promotion_rule",
"related": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/sku_list_promotion_rule"
}
},
"coupon_codes_promotion_rule": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/relationships/coupon_codes_promotion_rule",
"related": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/coupon_codes_promotion_rule"
}
},
"custom_promotion_rule": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/relationships/custom_promotion_rule",
"related": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/custom_promotion_rule"
}
},
"sku_list": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/relationships/sku_list",
"related": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/sku_list"
}
},
"coupons": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/relationships/coupons",
"related": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/coupons"
}
},
"attachments": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/relationships/attachments",
"related": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/attachments"
}
},
"events": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/relationships/events",
"related": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/events"
}
},
"tags": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/relationships/tags",
"related": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/tags"
}
},
"versions": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/relationships/versions",
"related": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/versions"
}
},
"skus": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/relationships/skus",
"related": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/xYZkjABcde/skus"
}
}
},
"meta": {
"mode": "test"
}
}
}