docs

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

ParameterDetails
id READ-ONLY

String

Promotion id

version READ-ONLY

String

Promotion version

name

String

Name of the promotion

displayName

Object
Display name localization

status

String
The status of the promotion

activationType

String
Promotion activation type

level

String
Promotion application level

schedule

Object
Time range when the promotion is active

companyIds

Integer
The list of company ids where the promotion takes place

shopCountryIds

Object
The list of shop country ids where the promotion takes place

siblingPromotions

Object
Sibling promotions allow/block other promotions from being used together with this one

audiences

Object
Audiences allow/block list. Use it to restrict promotions to specific customer groups

effect

Object
The effect that will be applied if all conditions are satisfied

conditions

Object
The list of conditions ('payload.*') that determines whether the promotion is applicable or not

priority

Integer
Priority of the promotion

customData

Object
Additional data of the promotion. Can be legal text or some other info, that will be shown to customer

tiers

Object

The list of promotion tiers. Tiers must be sent in ascending order

usageLimit

Create Buy X Get Y Promotion

Update a Promotion

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

Method Signature

Example: Update a Promotion

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.

Buy X Get Y

Next up
Automatic Discounts