saveCampaign

• 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.

Use the "warehouseIDs" instead to use multiple warehouse based campaign functionality.

Set this field if you want the promotion to be available only in a specific store.

Fields "warehouseID"/"warehouseIDs", "storeGroup" and "storeRegionIDs" are mutually exclusive: only one restriction can be set at a time, otherwise error code 1110 will be returned.

A comma-separated list of warehouse IDs.

Set this field if you want the promotion to be available only in specific stores.

Fields "warehouseID"/"warehouseIDs", "storeGroup" and "storeRegionIDs" are mutually exclusive: only one restriction can be set at a time, otherwise error code 1110 will be returned.

Set this field if you want the promotion to be available only in a specific store group.

Fields "warehouseID", "storeGroup" and "storeRegionIDs" are mutually exclusive: only one restriction can be set at a time, otherwise error code 1110 will be returned.

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

A comma-separated list of store region IDs.

Set this field if you want the promotion to be available only in selected store regions. To remove the restriction, set the field to an empty string.

Fields "warehouseID", "storeGroup" and "storeRegionIDs" are mutually exclusive: only one restriction can be set at a time, otherwise error code 1110 will be returned.

Using this field will return error code 1028 if "Store regions" and "Promotion regions" modules are not enabled on this account. If you supply a list containing non-numeric values, error 1016 will be returned.

To get a list of store regions, see getStoreRegions.

A comma-separated list of customer group IDs.

Set this field if you want the promotion to be available only for selected customer groups. To remove the restriction, set the field to an empty string.

Using this field will return error code 1028 if "Promotion regions" module is not enabled on this account. If you supply a list containing non-numeric values, error 1016 will be returned.

1. The customer must spend at least $X (purchaseTotalValue). Optionally it is possible to specify that the customer must spend the sum on certain product groups (purchasedProductGroupIDs), categories (purchasedProductCategoryIDs), brands (purchasedBrandIDs) or products (purchasedProducts), and it is possible to set a upper limit above which the promotion will not apply (purchaseTotalValueMax). The last option might be useful for setting up tiered benefits.
   
   
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)

A comma-separated list of subsidy amounts (in euros/dollars) for each of the products specified above.

Subsidy is money paid by the head office to the store, to offset the store's loss of revenue, due to HQ-mandated discounts and promotions.

You can only use this field for promotions "Buy at least X pcs of product Y and get $ / % off each one". This is the promotion that can be defined by setting the fields "purchasedProducts", "purchasedAmount", and one of either "percentageOffMatchingItems" or "sumOffMatchingItems". Since this promotion gives discounts to the same items that customer is required to buy, the subsidies need to be associated with "purchasedProducts". These amounts of subsidy will be paid out when this promotion applies and one of the products listed above (in purchasedProducts) gets a promotional discount.

Attempting to set "purchasedProductSubsidies" for any other type of promotion will return error code 1132.

This comma-separated list must consist of non-negative decimals, and if you set this parameter, the list must be exactly of the same length as "purchasedProducts" (a corresponding subsidy amount for each product ID). For instance:

• purchasedProducts=1,2,3,4
• purchasedProductSubsidies=0,0.15,0.35,0

This field can be used only if "Price list row subsidy and other fields" module is enabled on your account.

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 purchased items (purchasedAmount pcs of purchasedProducts) for a special bundle 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 list of brands (awardedBrandIDs)
   4. from a 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 / 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 set it only together with percentageOffEntirePurchase, otherwise API will return error 1129.

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).

By default 0.

This flag applies to promotions "% off entire sale", so set it only together with percentageOffEntirePurchase, otherwise API will return error 1182.

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

By default 0.

A further restriction for the "% off entire sale" promotion. IDs of products to which the discount percentage should not be applied.

A comma-separated list of product IDs.

A further restriction for the "% off entire sale" promotion. IDs of the only allowed products to which the discount percentage may be applied, at all. (All other products in the basket should be left unaffected by this promotion.)

A comma-separated list of product IDs.

A comma-separated list of subsidy amounts (in euros/dollars) for each of the awarded products specified above.

Subsidy is money paid to the store by the head office, to offset the store's loss of revenue, due to HQ-mandated discounts and promotions.

If you specify awardedProductSubsidies, these will be the amounts of subsidy that will be paid out when this promotion applies and one of the products listed above (in awardedProducts) gets a promotional discount.

This comma-separated list must consist of non-negative decimals, and if you set this parameter, the list must be exactly of the same length as "awardedProducts" (a corresponding subsidy amount for each product ID). For instance:

• awardedProducts=1,2,3,4
• awardedProductSubsidies=0,0.15,0.35,0

This field can be used only if "Price list row subsidy and other fields" module is enabled on your account.