Create Product Promotions in Point of Sale CMS

View Basic Promotion Information

Use the fields in the Basic Promotion Information section to configure several fields that can help describe and categorize your promotion. Promotions also support multi language. For more information, see Multi-Language Support.

Name *—The name of your promotion, for example Shipping For New Users at No Additional Cost. This value is only used to reference your promotion and is never shown to the customer.

Promotion ID—The promotion ID can be used to manually update a promotion in the import promotion workflow. The ID is also shown if downloading the promotion CSV file.

Active/Inactive—There are two tabs labeled ACTIVE and INACTIVE. When a promotion date expires, it'll be flagged as inactive. The ACTIVE tab will display promotions that are going live and active promotions.

Active—There's also a switch that enables or disables your promotion. This can be used to suspend your promotion for special circumstances or to create draft modes of promotions that can be activated at a later date.

Call Out Message *—The call-out message is the customer-facing message. For example "Use this code to receive No-Cost Shipping!". The Call-Out Message is displayed against the line item in the cart where the promotion is applied.

Applicability Rules *—A description of your promotion, including any legal and disclaimer text.

Promotion Image *—The image field ‌is used to show a promotional image in layouts. If you aren't using promotions in your layouts, you can add any generic image to meet the required field requirements.

External Promotion ID—A text-based ID that gets logged into your point of sale (POS) logs. Use this to track promotions in your external ERP or ecommerce systems.

Note Note: An asterisk (*) denotes a required field.

Promotion Configuration

The fields in the Promotion Configuration section allow you to define a discount type and amount. You also define the duration of your promotion, and what other types of promotions it can be combined with here.

Amount Off / Percentage Off / Fixed Price *—These fields represent the discount that'll be applied to the promotion. The discount type is related to the promotion type:

Start Date—The date and time the promotion starts.

End Date—The date and time the promotion ends. The date and time in this field takes precedence over that active field. This means that a promotion with a past End Date can still have an “active” state but not be a valid promotion that can be applied.

Can Be Combined With—By default, a promotion can't be combined with any other promotion types. Override this behavior by selecting the promotion type that you want to allow combinations with. Combining promotions will allow you to stack multiple promotions together (for example Your current promotion is a Fixed Price promotion for $20, that can also be stacked with a No-Cost Shipping promotion)

Price Override—Item Price is sometimes overridden to account for manual discounts on the Product. This flag allows the Promotion to be combined with the Manual discount on the Product.

Note Note: If this is set, then the promotion can be combined with a Manual discount.

Single-Use Promotion Codes

SUPCs can be uploaded and accessed in three ways: manual, CSV, scheduled feed, and through an API.

Single-Use Promotion File - SUPC file can be uploaded manually or through a schedule. Scheduled uploads don’t run until the promotion becomes effective (on the promotion start date). If you're changing an existing promotion that uses Single-Use codes, you don't ‌enter the field. The original file that was uploaded remains in use.

Single-Use Promotion file appends new codes to existing codes. It doesn't replace existing ones. For example, promotion codes (A, B, C) are uploaded. If you upload another file with new promotion codes (D, E), the final list of codes will be A, B, C, D, E.

Note Note: The Single-Use promotion file format consists of one column, refer to the bottom of this article for an example file. After a feed is run, you can check its status—whether it was successful or encountered issues—by reviewing the Feed Logs in Point of Sale CMS.

Single-Use API

With the Promotion Management API, SUPCs can be fetched, updated, and uploaded to Point of Sale, even including expired codes. For promotions exclusively tied to SUPCs, they must exist. The purpose here is to extract data from the promotion, gaining insight into the included codes and their redemption status. This API function lets you add SUPC codes to the promotion. It also lets you update these promo codes within the same promotion.

If creating SUPCs in Retail Cloud, it's essential to match them with the merchant's promotion controller. This alignment allows for direct passing of the promoId in parameters during SUPC redemptions online, reducing the number of API calls required.

Example POST Call

{
"promotionCodes": [
{
"codeAssignedDate": "2023-08-08T19:24:10.498Z",
"codeRedeemed": false,
// "codeRedeemedDate": "2023-08-08T19:24:10.498Z",
"codeType": "string",
"externalId": "123",
// "merchantId": "string",
"message": "test",
"oneTimeCode": "ZZZ",
"oneTimeCodeCS": "string",
"promotionId": "bf15c5ba-20a3-404d-8e2d-343f53664f78", // promotionId must match promotion configured in CMS.
"promotionValidDate": "2023-08-08T19:24:10.498Z",
// "region": "string",
// "storeCode": "string",
"type": "Promotion",
"updatedOn": "2023-08-08T19:24:10.498Z",
"validFrom": "2023-08-08T19:24:10.498Z",
"validTo": "2023-08-09T19:24:10.498Z"
}
]
}

Example PUT Call

{
"promotionCodes": [
{
//REQUIRED FIELDS BELOW
"codeAssignedDate": "2023-08-08T19:24:10.498Z",
"codeRedeemed": true,
"codeType": "string",
"externalId": "123",
"message": "test",
"oneTimeCode": "ZZZ",
"oneTimeCodeCS": "string",
"promotionId": "c114d0a2-d952-468d-b967-c42b338af2d9", // promotionId must match the promotion configured in CMS.
"promotionValidDate": "2023-08-08T19:24:10.498Z",
"type": "Promotion",
"updatedOn": "2023-08-08T19:24:10.498Z",
"validFrom": "2023-08-08T19:24:10.498Z",
"validTo": "2023-08-09T19:24:10.498Z"
//REQUIRED FIELDS ABOVE
/*
//OPTIONAL FIELDS BELOW
"codeRedeemedDate": "2023-08-08T19:24:10.498Z",
"region": "string",
"storeCode": "string",
"merchantId": "string",
//OPTIONAL FIELDS ABOVE
*/
}
]
}

A rule consists of three defining fields: an attribute, an operator, and a value. In each rule type, the selected attribute will be compared using the operator vs the value defined. If the condition is met, then the promotion will get applied.

Attribute - This allows you to select an attribute that your condition will be compared against. The attributes are rule-specific. So for product rules, you’ll only see attributes relevant to products.

Important: The attributes can be mismatched to the target fields in the field mappings. If selecting the attribute for these target fields in field mappings, select ProductID for id and VariantGroupID for item_group_id.

Operator - The operator lets you pick what kind of comparison you want to do. For test-based attributes such as color, the comparison operators are Contains and Doesn't Contain. For numeric attributes such as ProductID, the comparison operators are >= or <= (that is, greater than equal, and less than equal).

Value - The value field allows you to select the value or values that the attribute will be compared against. Numeric values only allow a single value to compare against, while you can define multiple values for a text-based attribute.

In this example, two conditions must be met:

• The customer must buy any product that is more than 19.99.
• The customer must buy any product that is either of the brand Point of Sale or ShopNow.

Buy/Applied To—You'll see these additional fields only for percentage off-type BOGO promotions.

• At least: Applies discounts on all discounted items if the cart-item quantity is greater than or equal to the qualifying quantity.
• Exactly: Applies a discount exactly (or multiples of) on the discounted quantity if the cart-item quantity is greater than or equal to the qualifying quantity.

Types of Rules

Products - The Product rules will allow you to select specific products to apply to your promotion. Limit the product rule to applying rules to a limited set of Products and is currently capped at 1000 Product IDs. To apply your promotion to a broader set of products, use the Category Rule, which will allow you to set rules to Categories.

• Disable discount proration - Turning off discount proration, for example, applies the promotion to one item instead of all of the items. This is useful in cases where gross margins can be affected.

Order - The Order rules will allow you to add order rules that the promotion discount will be applied to, for example discounts on shipping.

Location - The Location rule will allow you to add location rules that the promotion discount will be applied to.

Customer - The Customer rule will allow you to add customer rules that the promotion discount will be applied to, for example employee discounts.

• Customer Groups—To create customer groupings, for example discounts for different types of employees, you'll need a custom integration through your CRM.

  • Make certain there’s a field that groups all the customers.
  • Point of Sale reads this field and maps it to customerGroup on our end.
  • In the promo engine, group-based promos will run against this group.

No-cost Sample Rules

Similar to promotion rules, you can configure rules to specify which products will be no-cost samples in the promotion. This can be configured if creating a No-Cost Samples Promotion.

Under No-Cost Sample Rules, you can control the quantity, attribute, operator, and value(s). With the quantity, you can indicate the maximum amount of No-Cost samples allowed in an order (default is 1). Set all rules to turn on the No-Cost Samples promotion in the POS app. To always set a product as "No-Cost", consider adding an Order rule where the Order Total is >= 0.

Note Note: Offline support is only available for app builds 9.1.2 and greater.

Common Tasks

• Adding a Rule—Select ADD in the upper right corner of the rule card.
• Deleting a Rule—You can delete an empty rule (that is, a rule with no fields set) by selecting the trash can. If your rule has values set in any of its fields, you can delete it by selecting the vertical three dots and selecting delete.
• Adding Values Manually — You can enter values manually using your keyboard.
• Adding Values From a CSV—Using the vertical three dots, you can import a list of values from a CSV file. Selecting the (replace current values) will replace all the current values of the field with the contents of the file. Selecting (merge with current values) will merge with the existing values.
• Removing Values—For text values, you can remove a value by clicking the cross icon. To remove a numeric value, you can simply remove the rule.
• Using the Product Picker—For a product, qualifying products, or discount group rule, you can use a product picker to select Product IDs if the attribute is set to Product ID. This is the value that is mapped to the Point of Sale ProductID field during feed imports.

Additional Information

If you're ready to create promotions and need an example guide, see Common Promotion Examples. The article will go over promotions you commonly see and how to create them.