Title: Basket Response Schema The basket response provides details of the promotions applied to a basket, and any new lines created, or coupons and points issued. Version 1.0 : 2014-08-07. Initial schema creation. Version 1.1 : 2014-09-04. Updated to include 'yourref' and 'groupcode' for applied promotions. Version 1.2 : 2015-06-15. Updated to include issued points and issued coupons. Version 1.3 : 2015-06-26. Standardised reporting code attribute/element names. Version 1.4 : 2015-10-02. Updates after changes to provide additional details with applied promotions and coupons. Version 1.5 : 2016-10-29. Added Missed Promotions to response. Version 1.6 : 2018-04-24. Company key is no longer a required attribute.. The Name of the API service action The Id of the API service action The promotion name The end-user/display text defined against the promotiton. The Id of the promotion that has been applied to the basket. The reference assigned to the promotion. The reporting code assigned to the promotion. The type of the promotion that has been applied to the basket. Flag indicating whether the promotion has been published. Display text version of the promotion type. The total discount applied to the basket for this instance of the promotion. The instance of the promotion applied to the basket. Where a promotion is applied multiple times to the basket, each instance will be assigned an incremented number for that instance. Flag indicating whether the promotion will be applied to the delivery price for the basket. A flag indicating whether the promotion is applied to all items in the basket. A flag indicating whether the promotion is configured to be applied outside of the best deal calculations. Where the promotion is configured as 'alwaysapply', provides a value indicating whether promotion will be applied before or after best deal calculations. Where the 'AlwaysApply' flag is true, the sequence in which the promotion was applied within the context of promotions flagged as 'AlwaysApply'. The total number of points issued to the basket for this instance of the promotion. Flag indicating whether the promotion issued a voucher code when it was applied. Flag indicating whether the promotion add a product to the basket when it was applied. Where appropriate, the name of the attribute that the promotion updated when it was applied. The message text. The code associated with the message. A unique ID assigned to the basket at the point of being validated. Flag indicating whether the process completed without errors. The name of the coupon against which the code is defined. Where specified, the text defined against the promotion to be returned with issued voucher codes. Where applicable, refer-a-friend details Flag indicating whether the code is the referral code to be provided to friends. Flag indicating whether the code is the customer's reserved code, and as such will be activated when the referral code has been redeemed. The message text. A code for the message. The message text. A code for the message. The Id of the promotion which utilized the code. The instance number, for the promotion which utilized the code. The coupon code. A flag indicating whether the code has been utilized by a promotion. A code is deemed to be utilized where a promotion has been applied to the basket, and that promotion has a criteria defined that is matched against the code. Where specified, the reporting code defined against the coupon. A flag indicating whether the code has been issud by a promotion. Only the 'IssueVoucherCode' promotion type may issue coupon codes against a basket. A flag indicating whether the code has been confirmed as issued against this basket. Unconfirmed codes issued against a basket will not be available to be utilized. Issued codes are confirmed when the basket request 'confirmed' flag is set to true. A flag indicating whether the utilization of the code has been confirmed. Unconfirmed utilizations will not be logged against the code, and any maximum uses for the code will not be affected. Utilizations are confirmed when the basket request 'confirmed' flag is set to true. A flag indicating whether the code was issued or utilized by a previously confirmed instance of the basket. The Id of the 'IssueVoucherCode' type promotion which issued the code. The instance number, for the promotion which issued the code. The maximum number of uses for the issued code. Flag indicating whether uses for codes of the coupon will be tracked and the code use locked until the transaction is confirmed, or the lock release time is exceeded. Where locks are in use - the count of locks currently active for the code. Where locks are in use - the time in minutes that a lock for a code will be held since the most recent submission. Where available, the description of the product for this basket item. The message text The code for the message The status for the gift card processing result Where available, the expiry date for the gift card Where available, the new balance for the gift card For Allocated card numbers, the token to be used when activating The Id of the promotion applied to the basket item. Where applicable, the calculated discount for this promotion against the basket item. The instance number of the promotion for this application. A flag indicating whether the promotion is applied to the delivery amount only. A flag indicating whether the promotion is applied to the entire basket. The points issued by an 'IssuePoints' promotion against the basket item. The Id of the basket item against which this promotion instance has been applied. A line number for the basket item. A product code to identify the product for this basket item. Where applicable, the variant code of the product for this basket item. Where applicable, the barcode of the product for this basket item. The price at which the product is to be sold. Where applicable, the manual discount (per item) applied to the product for this basket item. The number of items being sold for this basket item. The total line level discounts applied by promotions to this basket item. A flag indicating whether the basket item is configured to always be excluded from promotions. The total line level discounts for this basket item, including manual and promotion discounts. The price for this basket item provided with the basket request. The quantity for this basket item provided with the basket request. The line amount for this basket item provided with the basket request. The Id of the item from which this basket item was split. A flag indicating whether the basket item is a delivery item. A flag indicating whether the basket item was added during basket validation. The total points issued to this basket item from 'IssuePoints' type promotions applied. The amount of the basket item, including any discounts. Flag indicating whether this line is a gift card line The name of the missed promotion. The end-user description assigned to the promotion being reported as missed. Flag indicating whether the promotion is unpublished. Where defined, the Missed Promotions end-user/customer free text defined for the promotion. Where applicable, the selected Missed Promotions reporting code for the promotion. Where the 'type' property is configured to 'Issue_Coupon', the name of the coupon to issue a voucher code for. The type of the action item. Product Product Attribute Where applicable, the product code for the product action item. Flag indicating where the criteria is for a product with multiple variants, that any variant is permitted. Where applicable, the variant code for the product action item. Where applicable, the barcode for the product action item. Where the action 'type' is set to 'ProductAttribute', the name of the attribute. Where the action 'type' is set to 'ProductAttribute', the value of the attribute. Flag indicating whether the item has been matched against the basket. The type of action to be performed when the promotion being reported as missed is applied successfully to a basket. The action details applies to all matched items The action details applies to matched products from Group A The action details applies to matched products from Group B The action details applies to matched products from Group C The action details applies to matched products from Group D The action details applies to matched products from Group E The action details applies to matched products from selected groups The action details applies to the discount items The action details applies to the basket total including delivery The action details applies to the basket total excluding delivery The action details applies to the delivery charge The action details applies to issuing points The action details applies to issuing a coupon code The action details applies to products to be added The action details applies to setting an attribute Where the 'type' property is configured to 'Set_Attribute', the token for the attribute to be set. Where the 'type' property is configured to 'Set_Attribute', the value for the attribute to be set. Where the 'type' property is configured to apply a discount, details on how the discount will be applied to the selected items. The action details does not apply The action details applies to setting the cheapest item to free The action details applies to discounting the cheapest item by a percentage The action details applies to discounting the cheapest item by a fixed amount The action details applies to setting the cheapest item to a fixed price The action details applies to a percentage discount The action details applies to a fixed discount The action details applies to a bundles or fixed price The action details applies to a fixed price Where the 'type' property is configured to 'Issue_Points', the minimum number of points to be issued. Where applicable, the percentage discount to be applied. The estimated saving if the promotion is applied. The type of the criteria item. Product Product Attribute Flag indicating whether the criteria is an exclusion. Where applicable, the product code for the product defined against the criteria. Where applicable, Flag indicating whether to accept any variant for the product. Where applicable, the variant code for the product defined against the criteria. Where applicable, the barcode for the product defined against the criteria. Where applicable, the name of the product attribute. Where applicable, the value of the product attribute. Flag indicating whether the criteria has been matched against the basket. Flag indicating that the criteria item has been fully matched against the basket. The source of the criteria item from the promotion definition. Product Criteria group Product Criteria group A Product Criteria group B Product Criteria group C Discount Items group Flag indicating that the criteria additional spend/quantity must be applied to the matched items. Where applicable the additional spend required to satisfy the criteria. Where applicable the additional quantity required to satisfy the criteria. Flag indicating whether all criteria items have been returned. For large number of criteria items, the response list may be truncated. Where applicable, the additional basket spend required to trigger the promotion. Where applicable, the additional spend required to trigger the promotion, including all criteria items and basket additional spend. The Id of the promotion being reported as missed. A reference assigned to the promotion being reported as missed. A reporting code assigned to the promotion being reported as missed. The type of the promotion being reported as missed. Display text version of the promotion type. The category of promotion being reported as missed. The missed promotion is line level The missed promotion is delivery level The missed promotion is basket level The missed promotion would issue points The missed promotion would issue a coupon code A unique incrementing number assigned to each instance of the same promotion that is being reported as missed. Where applicable, a custom sort value for the promotion being reported as missed. A flag indicating whether the promotion being reported as missed is configured to be applied outside of the best deal calculations. Where the promotion being reported as missed is configured as 'alwaysapply', provides a value indicating whether promotion will be applied before or after best deal calculations. The description to be presented to the end-user/customer to help them understand what to select. The unique id for the select item in the list The type of the select item Flag indicating whether the item already exists in the basket. Where applicable, the product code for the select list item Where applicable, the variant code for the select list item Flag indicating whether this item was selected in the request Flag indicating whether the request selection indicated to use the existing item in the basket The status of the select list, indicating whether action is needed by the integrated system. The source for the select list Where available, the promotion id associated with the select list. Where applicable, the quantity to be selected. A unique identifier for the basket. This can be a transaction or session reference, or order identifier. The id should be persisted for each submission of the basket. The sale date and time for the transaction. The date and time will be used to establish available promotions. A flag indicating whether the basket is for a confirmed order. When the confirmed flag is provided, any coupon codes that have been utilized or issued will be committed. The customer group supplied with the basket request. The customer ID supplied with the basket request. The channel supplied with the basket request. The store supplied with the basket request. The store group supplied with the basket request. The delivery method supplied with the basket request. The manual discount supplied with the basket request. The total basket level discount applied to the basket. The total line level discount applied to the basket. The total line level promotional discount applied to the basket. The total line level manual discount applied to the basket. The total discount applied to the basket. The basket total. The basket total supplied with the basket request. The manual delivery price discount supplied with the basket request. The delivery price including any applied discounts. The total promotional discount applied to the delivery. The total discount applied to the delivery. The delivery price supplied with the basket request. The total number of points issued to the basket. The currency code provided with the request