Title: Configure Promotions - Edit - request schema Edit a promotion Version 1.0 : 2018-10-01. Initial schema creation Where available, the name of the user in the remote system. Where applicable, when the customer is selecting from a list, provides text to assist them in their selection For promotion type(s): Workflow Trigger Indicates the token of the attribute to set as the result of applying the promotion. For promotion type(s): Workflow Trigger Indicates the value to set the attribute to as the result of applying the promotion. For promotion type(s): Multi-buy For promotion type(s): Issue Voucher Code Provides details on which Voucher to issue codes from as a result of applying the promotion. For promotion type(s): Issue Points Provides details on how to calculate points to be returned with a basket as a result of applying the promotion. The promotion will issue a fixed number of points The promotion will issue points calculated from the basket value (including delivery) The promotion will issue points calculated from the basket value excluding delivery The promotion will issue points calculated from the value of the matched items The promotion will issue points calculated from the delivery value There are no restrictions on the number of times this promotion can be applied The promotion will be applied only n-times per customer The promotion will only be applied n-times per coupon code The promotion will only be applied n-times per customer and coupon code Not applicable All matched items will be reduced. The cheapest matched item will have a 100% discount applied. The matched criteria items will be discounted such that their combined prices equal the 'bundleprice'. The cheapest item will be discounted by the specified percentage or value. The cheapest item will be discounted such that its new price equals the 'newprice'. A voucher code will be issued to the basket. Points will be issued to the basket. The discount product(s) will be added to the basket with a 100% discount. The specified attribute will be updated or appended with the given value. Each matched item will be discounted by the specified percentage or value Override the line item price with a new price from a product attribute For all basket, delivery, and line level discount, and Workflow Trigger promotion type(s) Indicates what will be affected within the basket when the promotion is applied. The applies to is not applicable for the selected promotion type The matched criteria items will have the discount applied The matched items from the discount group will have the discount applied All matched items in the basket will have the discount applied The cheapest matched item in the basket will have the discount applied The discount will be applied to the matched item from product group 1 The discount will be applied to the matched item from product group 2 The discount will be applied to the matched item from product group 3 The discount will be applied to the delivery amount The discount will be applied to the basket total The discount will be applied to all items in the basket The discount will be applied to the matched item from selected product group(s) The discount will be applied to the matched item from product group 4 The discount will be applied to the matched item from product group 5 For all basket, delivery, and line level discount promotion type(s) Indicates whether to apply a percentage or value discount when the promotion is applied. The selected promotion type does not give a discount (eg, Issue Points) The selected promotion gives a percentage discount The selected promotion gives a fixed discount For promotion type(s): Buy one get one reduced, Product % or Value Off, Deal Price, Basket % or Value Off, Delivery % or Value Off Where a value discount is to be applied by the promotion, indicates the amount of discount value to apply to the target items. For promotion type(s): Bundle Price, Deal Price Indicates the new total price to use for the target items. For promotion type(s): Buy one get one reduced, Deal Price Indicates the new price to use for the target item(s). For promotion type(s): Free Gift For the Free Gift promotion type, indicates whether to only apply the promotion when the product(s) to be provided free are not found in the basket. For promotion type(s): Free Gift For the Free Gift promotion type, indicates whether to always add the product(s) to be provided free. Where this flag is not set to true the Free Gift promotion will use product(s) in the basket where they already exist. Where applicable, when applying the free gift promotion and where a basket level spend qualification is in use, indicate whether the free gift product(s) should be included in the spend qualification calculation Where applicable, indicates whether the customer must select from a list before the promotion is applied Where applicable, when the customer selecting from a list, indicates the quantity of items the customer must select For promotion type(s): Buy one get one free, Buy one get one reduced, Deal Price Indicates how to apportion the discount against the lines to be discounted. The selected promotion type does not give a discount that can be apportioned The discount for the selected promotion will be apportioned across all matched items The discount for the selected promotion (BOGOF/BOGOR) will be applied to the second item For promotion type(s): Multi-buy Indicates whether to validate for spend or quantity. The current settings have no applicable validation methods for qualifying items The qualifying items will be validated by quantity The qualifying items will be validated by spend For all line level discount, Issue Voucher Code, Issue Points, Free Gift and Workflow Trigger promotion type(s) Indicates whether the promotion can be applied multiple times to a basket. For promotion type(s): Deal Price, Basket % or Value off, Delivery % or Value off, Issue Voucher Code, Issue Points, Free Gift, Workflow Trigger Indicates a minimum basket spend threshold to be validated before applying the promotion. For promotion type(s): Free Gift Indicates a maximum basket spend threshold to be validated before applying the promotion. For promotion type(s): Deal Price, Basket % or Value off, Delivery % or Value off, Issue Voucher Code, Issue Points, Free Gift, Workflow Trigger When validating spend thresholds, indicates whether to include delivery within the total spend. For promotion type(s): Basket % or Value off, Delivery % or Value off, Issue Voucher Code, Issue Points, Free Gift, Workflow Trigger When validating spend thresholds, indicates whether to include previously applied discounts within the total spend. For promotion type(s): Basket % or Value off Indicates whether to discount the delivery along with all other items in the basket when applying the promotion. For promotion type(s): Buy one get one free, Buy one get one reduced, Product % or Value Off, Deal Price. Indicates whether basket products used to establish whether the promotion should be applied, but have not been discounts, are available to be used by other line level promotions. For promotion type(s): Product % or Value Off Indicates how to proceed with an invalid or missing attribute value. The selected promotion type does not support overriding the price, or the override price option is not selected. Do not apply the promotion where the value for the selected attribute is missing or invalid Use a zero price where the value for the selected attribute is missing or invalid For promotion type(s): Product % or Value Off Indicates whether the override price promotion should be regarded as exclusive and have priority over any other promotion that could be applied to the line. Only applicable to line-level promotions. Flag indicating whether to permit a voucher or coupon code to be reused for all iterations of a promotion within a basket. Where appropriate, the fixed value to compare the attribute value against, using the defined operator Where appropriate, the name of the function to be used to calculate the comparison value. For a full list on supported function names please refer to the Qixol Promo Help documentation. Where appropriate, parameter values for the selected function The type of values provided for the attribute The operator to be used when comparing the provided attribute value against the fixed value or function result Where appropriate, for functions that calculate a date, date/time or time value comparison value, indicates whether calculate from the basket date/time or the current date/time Where appropriate, the fixed value to compare the attribute value against, using the defined operator Where appropriate, the name of the function to be used to calculate the comparison value. For a full list on supported function names please refer to the Qixol Promo Help documentation. Where appropriate, parameter values for the selected function The type of values provided for the attribute The operator to be used when comparing the provided attribute value against the fixed value or function result Where appropriate, for functions that calculate a date, date/time or time value comparison value, indicates whether calculate from the basket date/time or the current date/time The current settings have no applicable validation methods for qualifying items The qualifying items will be validated by quantity The qualifying items will be validated by spend There is no restriction on the items in a group that match the criteria To match this group, all items must be the same To match this group, all items must be different There is no defined rule for matching products and/or attributes When matching products against the group criteria, products will be matched using the defined attribute criteria in combination with the selected products. When matching products against the group criteria, products may be matched using either the defined attribute criteria or the selected products. Where appropriate, the fixed value to compare the attribute value against, using the defined operator Where appropriate, the name of the function to be used to calculate the comparison value. For a full list on supported function names please refer to the Qixol Promo Help documentation. Where appropriate, parameter values for the selected function The type of values provided for the attribute The operator to be used when comparing the provided attribute value against the fixed value or function result Where appropriate, for functions that calculate a date, date/time or time value comparison value, indicates whether calculate from the basket date/time or the current date/time The 'displaytype' element is included in another schema where this object is defined, but is not used in this schema. To ensure the object can be passed between service methods without manipulation, 'displaytype' is also included here. The 'statistics' element is included in another schema where this object is defined, but is not used in this schema. To ensure the object can be passed between service methods without manipulation, 'statistics' is also included here. No filter will be applied for this field. Basket % or Value Off Buy one get one free Buy one get one reduced Bundle Price Product(s) % or value Off Deal Price Delivery Reduction Issue Voucher Code Issue Points Add Free Product(s) Workflow Trigger Multi-buy