# Create a buy x pay y promotion To [create](https://docs.commercelayer.io/core/creating-resources) 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** ### 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 {% tabs %} {% tab title="Request" %} The following request creates a new buy x pay y promotion: ```shell 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" } } } } }' ``` {% endtab %} {% tab title="Response" %} On success, the API responds with a `201 Created` status code, returning the created resource object: ```json { "data": { "id": "XAyRWNUzyN", "type": "buy_x_pay_y_promotions", "links": { "self": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/XAyRWNUzyN" }, "attributes": { "name": "Personal promotion", "type": "percentage_discount_promotions", "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, "total_usage_reached": false, "active": true, "status": "pending", "weight": 112, "coupons_count": 2, "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/XAyRWNUzyN/relationships/market", "related": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/XAyRWNUzyN/market" } }, "promotion_rules": { "links": { "self": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/XAyRWNUzyN/relationships/promotion_rules", "related": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/XAyRWNUzyN/promotion_rules" } }, "order_amount_promotion_rule": { "links": { "self": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/XAyRWNUzyN/relationships/order_amount_promotion_rule", "related": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/XAyRWNUzyN/order_amount_promotion_rule" } }, "sku_list_promotion_rule": { "links": { "self": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/XAyRWNUzyN/relationships/sku_list_promotion_rule", "related": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/XAyRWNUzyN/sku_list_promotion_rule" } }, "coupon_codes_promotion_rule": { "links": { "self": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/XAyRWNUzyN/relationships/coupon_codes_promotion_rule", "related": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/XAyRWNUzyN/coupon_codes_promotion_rule" } }, "custom_promotion_rule": { "links": { "self": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/XAyRWNUzyN/relationships/custom_promotion_rule", "related": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/XAyRWNUzyN/custom_promotion_rule" } }, "sku_list": { "links": { "self": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/XAyRWNUzyN/relationships/sku_list", "related": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/XAyRWNUzyN/sku_list" } }, "coupons": { "links": { "self": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/XAyRWNUzyN/relationships/coupons", "related": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/XAyRWNUzyN/coupons" } }, "attachments": { "links": { "self": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/XAyRWNUzyN/relationships/attachments", "related": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/XAyRWNUzyN/attachments" } }, "events": { "links": { "self": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/XAyRWNUzyN/relationships/events", "related": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/XAyRWNUzyN/events" } }, "tags": { "links": { "self": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/XAyRWNUzyN/relationships/tags", "related": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/XAyRWNUzyN/tags" } }, "versions": { "links": { "self": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/XAyRWNUzyN/relationships/versions", "related": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/XAyRWNUzyN/versions" } }, "event_stores": { "links": { "self": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/XAyRWNUzyN/relationships/event_stores", "related": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/XAyRWNUzyN/event_stores" } }, "skus": { "links": { "self": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/XAyRWNUzyN/relationships/skus", "related": "https://yourdomain.commercelayer.io/api/buy_x_pay_y_promotions/XAyRWNUzyN/skus" } } }, "meta": { "mode": "test", "organization_id": "xRRkjDFafe", "trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74" } } } ``` {% endtab %} {% endtabs %}