Buy X get Y

General

When the promotion conditions are satisfied, the customer will receive n items for free. The discount is added automatically to the item in the basket during the specified timeframe. You can define the exact conditions, for example, if a customer buys a number of specified items, certain items are received free of charge.

Example

Buy two t-shirts and receive one pair of socks for free. For every sneaker in the basket, you receive one care product for free. Have an order total greater than 100€ and receive a pair of glasses for free

Required fields for Buy X get Y promotions

• Name
• Priority
• Schedule Date
• Customer buys
• Customer gets

Admin API

Create Buy X Get Y Promotion

JavaScriptPHPcURLJava

Copy

let promotion = {
    name: "MyPromotion",
    schedule: {
        from: "2023-05-10T10:00:00+01:00",
        to: "2023-05-10T10:00:00+01:00"
    },
    isActive: true,
    shopId: ["1000"],
    companyId: "100",
    effect: {
        id: "buy_x_get_y",
        additionalData: {
            variant_ids: [1, 2],
            max_count: 2
        }
    },
    itemConditions: [
        {
            key: "mov_100",
            condition: "item.color == \"yellow\""
        }
    ]
};

let response = await client.apis.Promotions.createPromotion({}, {requestBody: promotion});
promotion = response.body;

console.log(promotion.id);

Update a Promotion

You can update promotion configuration such as schedule, effect, priority, etc.

Method Signature

JavaScriptPHPcURLJava

Copy

let response = await client.apis.Promotions.updatePromotion({promotionId: promotionId}, {requestBody: promotion});
let promotion = response.body;

Example: Update a Promotion

JavaScriptPHPcURLJava

Copy

let promotion = {
    name: "MyPromotion",
};

let response = await client.apis.Promotions.createPromotion({promotionId: "65688b0987f54332106a579e"}, {requestBody: promotion});
promotion = response.body;

console.log(promotion.name);

Storefront API

Get Promotions

Retrieve active promotions with matching ID using GET v1/promotions endpoint.

For details see the Storefront API Reference.

In the SCAYLE Panel

Create Buy X get Y promotion

For advanced & complex cases, you can use the advanced promotions view.

1. Select the Shop where you want to create your promotion and go to Promotions > Buy X get Y.
2. Enter a promotion Name.
3. Select a Type: Automatic Discount or Buy X and Get Y.
4. Select a Start date and End date.
5. Enter a number for Priority. This determines the priority of the promotion in the case that there are multiple promotions active at the same time.
6. Select whether the promotion should be combinable with other promotions.
   • If selected, enter Combinable promotion IDs in the Allowlist or Blocklist.
7. In Countries, select in which countries of the current shop the promotion should be valid.
8. In Audiences, select for which customer audience the promotion should be valid.
9. (Optional) In Combinable, select which promotions are allowed or blocked for combination.
10. Enter further criteria based on the discount type.
    • For type Buy X get Y, enter a list of variant IDs the customer can redeem.
    • For type Automatic Discount, enter Discount type and Discount amount.
11. Add at least one condition to the promotion. See conditions below.
12. Click Save.