docs

Price Campaigns (hidden)

Introduction

Price Campaigns apply time-limited, relative discounts to all or specific products within a given shop. These campaigns are designed to drive volume and visibility by showcasing discounted prices directly in the storefront - on product listing pages, product detail pages, and in the basket.

Only one price campaign can be active per shop at any given time. Campaigns can be launched for one or multiple shop countries simultaneously. They support a start and end date, a default discount rate (applied to all products), and specific variant-level reductions that overrides the default where configured.

You can also Bulk import Campaign prices. See this guide for how to.

Example: Launch a summer sale across all shop countries with 15% off the entire women's collection, 10% off men's, and 20% off selected kids’ items - active for one week.

Setting Price Campaigns up via SCAYLE Panel

In the SCAYLE Panel navigate to Shops and select the shop you want to create a Price Campaign for. On the left hand side menu select Promotion ➜ Price Campaign.

Here you will be able to see a list of existing Price Campaigns, manage them and create new Price Campaigns.

The price campaign status indicates whether a campaign is Active or Inactive. Expired or not yet started price campaigns are automatically assigned the status Inactive.

Create a new Price campaign

  1. Select the Shop where you want to create your promotion and go to Promotions ➜ Price Campaigns
  2. Click + NEW PRICE CAMPAIGN. This opens a window where you can define campaign details.
  3. In the Name field, type a name for the Campaign.
  4. Add Price Campaign Key (optional) - this acts as a unique identifier you can later reuse across the system.
  5. Define for which shop Countries the campaign is valid.
  6. Add a Common Discount (optional). If a common discount is entered, it will automatically be applied to all products in the shop if they do not have a product-based discount.
  7. Add the Timeframe (needs to be in the future) of the campaign.
  8. Add a Description (optional).
  9. Click Create Campaign to save and create the new price campaign.

You can also create a price campaign on the overview page on shop country level. The campaign will automatically assigned to the country you are currently in. On country level it's not possible to change the countries a campaign should apply to.

Next, you decide which products to include in the new campaign. See Define Campaign Details below.

Define Campaign Details

Assign Discounted Products to a Campaign

After you create a price campaign, define products and discounts for it as follows:

  1. Go to Promotions ➜ Price Campaigns ➜ Select the Campaign you want to work on, select the tab All Products.
  2. Refine the product selection using checkboxes or filters. You can also use the filter function to switch between campaign shops (displaying prices for the respective shop).\
  3. Click Change Prices. A menu will open where you can apply the Change and Value (for example, percentage).\
  4. Click Change Prices to apply the reduction.

As soon as a discount is assigned to a product, it appears in the tab For Campaign. You can also delete the product from the campaign by removing the discount.

The entered discount is immediately visible. The price campaigns product table shows the original and new price for each product. Changes are also displayed in both absolute and percentage values.

Custom data

SCAYLE Panel allows you to extend its functionality by adding custom data.
First, you need to configure custom data in the SCAYLE Panel's Settings area.

  1. Go to Settings ➜ General ➜ Custom Data.
  2. Select Price Campaigns, then ADD DATA FIELDS.
  3. Enter a name and select the criteria type:
    • String
    • Number
    • Boolean (True/False)
    • JSON
  4. Optionally: click the configuration icon to make the field mandatory, and to futher configure it.
  5. Click SAVE.

Custom data properties types & rules

TypeAllowed ValuesSupported RulesLimits
number
  • integer
  • float
  • double
  • string : casting applied
  • required: determine whether the property is required or not.(mandatory)
(-109, 109)
string
  • string
  • object : only in case the property isLocalized.
  • number : casting applied
  • minLength : specifies the minimum length of the property.(optional)
  • maxLength : specifies the maximum length of the property.(optional)
  • required : determine whether the property is required or not.(mandatory)
  • requiredLocales : represents the translations in case the property isLocalized = true. (optional)
  • The maximum length is 7,000 characters .
  • The maximum length of the value for a specific locale is also 7,000 characters.
boolean
  • true or false
  • 1 or 0
  • 'true' or 'false'
  • required : determine whether the property is required or not.(mandatory)
​
json
  • object
  • array
  • required : determine whether the property is required or not.(mandatory)
  • requiredLocales : represents the translations in case the property isLocalized = true. (optional)
  • jsonSchema : for the json type it is allowed to have any kind of jsonSchema. (optional)
  • Reference: JSON Schema​
  • Maximum depth of a JSON object is 4 levels.
  • Although null is valid JSON, it is not allowed to set on the root level.
  • The entire JSON object (per locale) can not contain more than 7,000 characters.

Examples

Scenario 1: Summer sale across all shop countries with 15% off the entire women's collection

You want to set up a weekend discount for all of your users, where they will get 50% on selected t-shirts over a weekend

Your SCAYLE Panel screen should look like the following:

Edit a Price campaign

  • Navigate to Shops ➜ Promotions ➜ Price Campaign and locate the Price Campaign you want to edit (you can use the search function) ➜ Click on it
  • You can edit the items and the settings from this screen
  • Hit save

Delete a Price campaign

Delete

  • Navigate to Shops ➜ Promotions ➜ Automatic Discount and locate the Price Campaign you want to delete (you can use the search function)
  • Select the toggle
  • Click on Delete

Setting Price Campaigns up via Admin API

In order to set up and update campaigns via Admin API, please see the endpoints here.

\