getCampaigns

Warehouse ID. Search for promotions that apply in this location.

The response includes promotions that have been set up specifically for this store, as well as promotions that do not have any restrictions and which apply to all stores.

There are five different ways to restrict the scope of a promotion:

• one single location (field "Promotion only takes place in this store" on the old promotion form)
• multiple locations (field "Promotion only applies in stores" on the new promotion form)
• multiple store regions (both old and new forms)
• group of stores (on the old promotion form)
• check box "Promotion is inactive if no stores have been selected" (on the new promotion form)

This filter does not check all five: the "multiple store regions" restriction and the "multiple locations" restriction are skipped for better performance. Effectively, it means that the filter might return more promotions than expected, including some which have been configured to apply only in certain other store regions.

(The calculateShoppingCart call, in contrast, will respect all restrictions and will not ignore any.)

Warehouse ID. Search for promotions that apply in this location.

This filter checks two restrictions:

• one single location (field "Promotion only takes place in this store" on the old promotion form)
• multiple locations (field "Promotion only applies in stores" on the new promotion form)

To manage multiple locations, see getCampaignWarehouses, saveCampaignWarehouse and removeCampaignWarehouse.

Search for promotions that are associated with this specific region. (This will NOT return promotions that do not have any region restriction, ie. which are configured to apply in all stores.)

A comma-separated list of store region IDs.

Using this field will return error 1028 if "Store regions" and "Promotion regions" modules are not enabled on this account.

Search for promotions that are associated with this specific customer group. (This will NOT return promotions that do not have any restrictions by customer group, ie. which are configured to apply to all customer groups.)

A comma-separated list of customer group IDs.

Using this field will return error 1028 if "Promotion regions" module is not enabled on this account.

• 'eng' - English
• 'spa' - Spanish
• 'ger' - German
• 'swe' - Swedish
• 'fin' - Finnish
• 'rus' - Russian
• 'est' - Estonian
• 'lat' - Latvian
• 'lit' - Lithuanian
• 'gre' - Greek

• auto - Promotion is applied automatically to all customers, based on rules below. No coupons needed.
• manual - Cashier selects the promotion manually. (Cashier must have relevant rights - getUserRights must return rightApplyPromotions = 1)
• coupon - Promotion is applied when user hands in a printed coupon with a serial number.

Indicates the general "pattern" of the promotion. Based on what is the requirement and what is the award, all promotions can be organized into these 11 categories. This is a derived field, generated from the more specific properties listed below. One of the following:

• BUNDLE_PRICE
• SPECIAL_PRICE_WITH_BULK_PURCHASE
• DISCOUNT_WITH_BULK_PURCHASE
• BUY_ONE_GET_ONE
• BUY_AND_GET_PERCENTAGE_OFF_EVERYTHING
• BUY_AND_GET_SUM_OFF_YOUR_PURCHASE
• SPEND_AND_GET
• SPEND_AND_GET_PERCENTAGE_OFF_EVERYTHING
• SPEND_AND_GET_SUM_OFF_YOUR_PURCHASE
• PAY_WITH_LOYALTY_POINTS
• GET_DISCOUNT_FOR_LOYALTY_POINTS

A comma-separated list of location IDs where the promotion applies.

This is a derived field. The list is combined from three separate settings:

• Field "Promotion only takes place in this store" on the old promotion form (one single location)
• Field "Promotion only applies in stores" on the new promotion form (multiple locations)
• Field "Or in this group of stores" on the old promotion form (a group of stores that can contain multiple locations)

If this list is empty, it means that the promotion has been configured for specific store regions (see field storeRegions), or that it does not currently apply anywhere (if field restrictOnNoWarehouses has a value of 1), or otherwise, that it applies to all locations.

A compatibility field for old integrations that do not expect a promotion to be available in multiple locations.

This is just the first entry from the comma-separated list warehouseIDs, explained above.

To manage multiple locations (field "Promotion only applies in stores" on the new promotion form) use getCampaignWarehouses, saveCampaignWarehouse and removeCampaignWarehouse.

If this field has a value, the promotion is available only in a specific store group.

"Store group" is a text field on location form.

If this list contains any elements, then promotion is available only in specific store regions.

Each list element contains the following fields:

If this list contains any elements, then promotion will apply only to these customer groups.

Each list element contains the following fields:

1. The customer must make a purchase with a total value of $X.XX (purchaseTotalValue)
   
   
2. The customer must buy at least a certain number of items (purchasedAmount) from a list of product groups (purchasedProductGroupIDs)
   
   
3. The customer must buy at least a certain number of items (purchasedAmount) from a list of product categories (purchasedProductCategoryIDs)
   
   
4. The customer must buy at least a certain number of items (purchasedAmount) from a list of brands (purchasedBrandIDs)
   
   
5. The customer must buy at least a certain number of items (purchasedAmount) from a list of products (purchasedProducts)
   
   
6. The customer must redeem a specified number of loyalty points (rewardPoints)

1. The customer gets X% off the entire purchase (percentageOffEntirePurchase)
   
   
2. The customer gets $X.XX off the entire purchase (sumOffEntirePurchase). Note that Erply invoice model does not have a concept of applying a discount sum to the whole invoice. This sum needs to be more-or-less evenly, or proportionally, divided between invoice rows.
   
   
3. The customer gets bought items (purchasedAmount pcs of purchasedProducts) for a specific total price (specialPrice). Such a promotion may be called "Buy Two For $5".
   
   
4. The customer gets a certain sum off (sumOFF), or a discount % off (percentageOFF) of one (awardedAmount = 1), multiple (awardedAmount = n) or infinite (awardedAmount = 0) items:
   
   
   1. from a list of product groups (awardedProductGroupIDs)
   2. from a list of product categories (awardedProductCategoryIDs)
   3. from a particular list of brands (awardedBrandIDs)
   4. from a particular list of products (awardedProducts)
   5. with a price equal to or lower than any items specified above (lowestPriceItemIsAwarded).
   
   
   
5. The customer gets a % discount on any one chosen receipt line (discountForOneLine)
   
   
6. The customer gets a certain sum (sumOffMatchingItems), or a discount % (percentageOffMatchingItems) off the items that were required for the promotion (purchasedProducts / purchasedProductGroupID / purchasedProductCategoryID / purchasedProductGroupIDs / purchasedProductCategoryIDs / purchasedBrandIDs), and also of each subsequent similar item.
   
   
7. The customer gets bought items (purchasedAmount pcs of purchasedProducts) for a special discounted price (specialUnitPrice). The promotion can have a maximum limit how many items get the discount(maxItemsWithSpecialUnitPrice).

This flag applies to promotions "% off entire sale", so you should inspect it only if percentageOffEntirePurchase contains a non-zero value.

Indicates that the promotion should not apply to items that have already received any discount from a price list, a manual discount by the cashier, or a discount from any preceding promotion (both item-level and invoice-level promotions).

This flag applies to promotions "% off entire sale", so you should inspect it only if percentageOffEntirePurchase contains a non-zero value.

Indicates that the promotion should not apply to items that have already received a promotion discount (item-level promotions), or have triggered a promotion.