B Entitlement Engine Services

This appendix provides information on using the Entitlement Engine to support communication between the POS system and Customer Engagement on entitlement deals that can apply to a shopping cart.

The Entitlement Engine uses RESTful services rather than SOAP services. Currently, only DealServices is supported.

The Entitlement Engine tables in Customer Engagement are populated through the creation and update of Entitlement Deals.

The Entitlement Engine is supported only if the Enable Promote Integration property is selected, and the Promote API Server URL property is completed in System Configuration with the URL as specified for each message.

See the Customer Engagement Cloud Services Implementation Guide for more information about System Configuration, including the settings related to the Entitlement Engine.

About this Appendix

This appendix includes information on communication with the Entitlement Engine.

• Post Deal Product Attributes

  • Sample Post Deal Product Attributes Request Message

  • Post Deal Product Attributes Request Parameters

  • Post Deal Product Attributes Request Message Contents

  • Sample Post Deal Product Attributes Response Message

  • Post Deal Product Attributes Response JSON Schema

  • Post Deal Product Attributes Response Message Contents

• Get Deal Product Attributes

  • Sample Get Deal Product Attributes Request Message

  • Sample Get Deal Product Attributes Response Message

  • Get Deal Product Attributes Response JSON Schema

  • Get Deal Product Attributes Response Message Contents

• Get Deal

  • Sample Get Deal Request Message

  • Sample Get Deal Response Message

  • Get Deal Response JSON Schema

  • Get Deal Response Message Contents

• Post Apply Deals

  • Sample Apply Deals Request Message

  • Apply Deals Request Parameters

  • Apply Deals Request Parameters

  • Apply Deals Request Message Contents

  • Apply Deals Request Message Contents

  • Apply Deals Response Schema

Post Deal Product Attributes

The POS system might use this message to associate attributes to a SKU. Examples of attributes are Dept, Class, Size, or Season. The attributes passed in this request update the DL_DEAL_PRODUCT_ATTRIBUTE table.

The URL for the Post Deal Product Attributes message is:

https://<SERVER>/<ORGANIZATION NAME>/promote/services/dealServices/dealProdAttr

Sample Post Deal Product Attributes Request Message

The following sample message assigns a Brand Name of Acme to SKU 111100001.

{ "attrName": "BRAND_NAME", "attrValue": "Acme", "sku" : "<SKU>" }

Post Deal Product Attributes Request Parameters

dealProdAttr =
{
    "attrName": "string",
    "attrValue": "string",
    "attributeId": "string",
    "sku": "string"
}

Post Deal Product Attributes Request Message Contents

The Post Deal Product Attributes request message contains the following information.

Value	Type	Description
attrName	string	The name of the attribute. Should be unique for each SKU.
attrValue	string	The value of the attribute for the SKU.
attributeId	string	Reserved for future use.
sku	string	The unique code identifying the SKU associated with the attribute.

Sample Post Deal Product Attributes Response Message

The following example illustrate a successful response to a Post Deal Product Attributes request message:

{ "dealProductAttributeId": "<ID>:: BRAND_NAME", "successful": true, "responseMessage":
"Deal Product Attribute persisted" }

Post Deal Product Attributes Response JSON Schema

{
    "dealProductAttributeId": "string",
    "responseCode": "string",
    "responseMessage": "string",
    "successful": "boolean"
}

Post Deal Product Attributes Response Message Contents

The Post Deal Product Attributes response message contains the following information.

Value	Type	Description
dealProductAttributeId	string	An automatically generated, publicly accessible primary key, creating by concatenating the SKU + : : + ATTRNAME.
successful	string	Set to true if the request to create the DL_DEAL_PRODUCT_ATTRIBUTE record was successful.
responseCode	string	Reserved for future use.
responseMessage	string	Set to Deal Product Attribute persisted if the request to create the DL_DEAL_PRODUCT_ATTRIBUTE record was successful.

Get Deal Product Attributes

The POS system might use this message to retrieve a listing of attributes associated with a SKU. Examples of attributes are Dept, Class, Size, or Season. The attributes passed in the response message are from the DL_DEAL_PRODUCT_ATTRIBUTE table.

The URL for the Get Deal Product Attributes message is:

https://<SERVER>/<ORGANIZATION>/promote/services/dealServices/dealProdAttrs/<PRODUCT_ATTRIBUTE_ID>

Sample Get Deal Product Attributes Request Message

The following sample message requests the attributes for example SKU 1234567890 in organization Org.

[/promote/Org/services/dealServices/dealProdAttrs/1234567890]

Sample Get Deal Product Attributes Response Message

The following example illustrates a successful response to a Get Deal Product Attributes request message, where two attributes are associated with the SKU in the DL_DEAL_PRODUCT_ATTRIBUTES table:

{ "dealProductAttributes": [ {
        "sku": "1234567890",
        "attributeId": "<ATTRIBUTE_ID>::BRAND_NAME",
        "attrValue": "Acme",
        "attrName": "BRAND_NAME",
        "objectId": "<OBJECT_ID>" }, {
        "sku": "1234567890",
        "attributeId": "1234567890::COLOR",
        "attrValue": "White",
        "attrName": "COLOR",
        "objectId": "<OBJECT_ID>" } ],
"successful": true}

Get Deal Product Attributes Response JSON Schema

{
"dealProductAttributes": [ {
        "attrName": "string",
        "attrValue": "string",
        "attributeId": "string",
        "sku": "string".
        "objectId": "string"
} ],
"responseCode": "string",
"responseMessage": "string",
"successful": "boolean"
}

Get Deal Product Attributes Response Message Contents

The Get Product Attributes response message contains the following information.

Value	Type	Description
dealProductAttributes		Includes sku, attrName, attrValue, attributeId, and objectId.
sku	string	The SKU code passed in the request message.
attributeId	string	An automatically generated, publicly accessible primary key, creating by concatenating the SKU + : : +ATTRNAME.
attrValue	string	The value of the attribute for the SKU.
attrName	string	The name of the attribute. From the ATTRNAME in the DL_DEAL_PRODUCT_ATTRIBUTE table.
objectId	string	A unique identifier for the deal product attribute. From the DL_DEAL_PRODUCT_ATTRIBUTE_ID in the DL_DEAL_PRODUCT_ATTRIBUTE table.
responseCode	string	Reserved for future use.
responseMessage	string	Reserved for future use.
successful	boolean	Set to true if the request to create the DL_DEAL_PRODUCT_ATTRIBUTE record was successful.

Get Deal

The POS system might use this message to retrieve information on a deal, including related data such as components, benefits, and qualifiers. The request message needs to specify the DEALID from the DL_DEAL table.

The URL for the Get Deal message is:

https://<SERVER>/<ORGANIZATION_NAME>/promote/services/dealServices/deal/<DEAL_ID>

Sample Get Deal Request Message

The following sample messages requests information on a deal with a DEALID of 1234567890 in organization Org.

[/promote/Org/services/dealServices/deal/1234567890]

Sample Get Deal Response Message

The following example illustrates a successful response to a Get Deal request message:

{
"deal": {
   "code": "<CODE>",
   "active": true,
   "dealId": "1234567890",
   "dealType": "LINE_ITEM",
   "objectId": "<OBJECT_ID>"
},
"components": [ {
   "qualifiers": [ {
        "qualifierType": "AwardCouponQualifier",
        "objectId": "<OBJECT_ID>"
} ],
   "objectId": "<OBJECT_ID>"
},
{
"qualifiers": [
   { "prodSkus": [ "SKUS" ],
   "qualifierType": "ProductQualifier",
   "objectId": "<OBJECT_ID>"
} ],
"minimumQuantity": 2,
"benefit": {
   "benefitType": "PercentOffBenefit",
   "prodPctOff": 65,
   "objectId": "<OBJECT_ID>"
},
"objectId": "<OBJECT_ID>"
} ],
"name": "Line Deal 1021",
"rules": {
   "combinableWithOtherTypes": false,
   "combinableWithSameType": false,
   "discountProrated": true,
   "objectId": "<OBJECT_ID>"
},
   "description": "Line Deal 1021",
   "objectId": "<OBJECT_ID>",
   "successful": true
}

Get Deal Response JSON Schema

{
"deal": {
     "brandIds": ["string"],
     "code": "string",
     "active": "boolean",
     "createDate": "date",
     "dealId": "string",
     "dealType": "string",
     "description": "string",
     "endDateTime": "date",
     "name": "string",
     "objectId": "string",
     "components": [{
         "benefit": {
              "benefitType": "string",
              "couponCode": "string",
              "coupons": ["string"],
              "giftSku": "string",
              "giftSkuQty": "integer",
              "giftSkuQtys": ["integer"],
              "giftSkus": ["string"],
              "prodAmtOff": "decimal",
              "prodAmtsOff": ["decimal"],
              "prodPctOff": "integer",
              "prodPctsOff": ["integer"],
              "prodPrice": "decimal",
              "prodPrices": ["decimal"],
              "shipAddCharge": "decimal",
              "shipAmtOff": "decimal",
              "shipAwardType": "string",
              "shipChargeCode": "string",
              "shipNewCharge": "decimal",
              "shipNewMethod": "string",
              "shipPctOff": "integer",
              "groupDiscount": "boolean",
              "shipOnLines": "boolean"
              "objectId": "string"
},
     "maximumQuantity": "integer",
     "maximumSubtotal": "integer",
     "minimumQuantity": "integer",
     "minimumSubtotal": "integer",
     "qualifiers": [{
              "buyAmts": ["decimal"],
              "buyQtys": ["integer"],
              "channels": ["string"],
              "coupons": ["string"],
              "custEmails": ["string"],
              "custGroups": ["string"],
              "custIds": ["string"],
              "custLtdBuyAmt": "decimal",
              "custLtdTransCt": "integer",
              "custPrefs": ["string"],
              "custYtdBuyAmt": "decimal",
              "custYtdTransCt": "integer",
              "keyCodes": ["string"],
              "noDeals": ["string"],
              "offers": ["string"],
              "payments": ["string"],
              "objectId": "string"
              "prodAttrSets": [{
                 "attrName": "string",
                 "attrValue": "string"
}],
              "prodCodes": ["string"],
              "prodDistinctBy": "string",
              "prodSkus": ["string"],
              "qualifierType": "string",
              "searchEvents": [{
                  "searchText": "string",
                  "externalSearch": "boolean"
}],
              "shipCntries": ["string"],
              "shipMethods": ["string"],
              "shipScfs": ["integer"],
              "shipStates": ["string"],
              "stores": ["string"],
              "urls": ["string"],
              "custFirstTime": "boolean",
              "custLoggedIn": "boolean",
              "custLoyalty": "boolean",
              "custNewRegister": "boolean",
              "custRegistered": "boolean",
              "excluding": "boolean",
              "noOnLines": "boolean",
              "shipOneAddr": "boolean",
              "shipUS48Only": "boolean"
              "minimumCartSubtotal": "decimal",
              "maximumCartSubtotal": "decimal",
}],
     "scopeLimited": "boolean",
     "combinableWithDeal": "boolean"
}],
"objectId": "string",
"rules": {
     "groupsLinesByShipTo": "boolean",
     "maxApplications": "integer",
     "maxDiscount": "decimal",
     "maxDiscountPerApplication": "decimal",
     "maxGlobalApplications": "integer",
     "maxGlobalDiscount": "decimal",
     "priority": "integer",
     "combinableWithOtherTypes": "boolean",
     "combinableWithSameType": "boolean",
     "discountAppliedToLowestPriced": "boolean",
     "discountProrated": "boolean",
     "singleUseForCustomer": "boolean"
"objectId": "string"
},
"schedule": {
          "dailyEndTime": "date",
          "dailyStartTime": "date",
          "offDates": ["date"],
          "onDays": ["integer"]
},
     "startDateTime": "date",
     "updateDate": "date",
     "serializedCouponDeal": "boolean"
},
"responseCode": "string",
"responseMessage": "string",
"successful": "boolean"
}

Get Deal Response Message Contents

The Get Deal response message contains the following information.

Value	Type	Description
deal		Includes brandIds, code, active, createDate, dealId, dealType, objectId, description, endDateTime, and name.
brandIds	string	A brand for which the corresponding deal applies.
code	string	The Customer Engagement Deal ID; same as the DEAL_ID in the DLS_DEAL table.
active	boolean	Set to true if the deal is active and will be evaluated.
createDate	date	Reserved for future use.
dealId	string	The DEALID identifying the deal in the Entitlement Engine.
dealType	string	Identifies the type of deal: BOGO: Buy X Get X, Buy X Get Y, or Gift with Purchase LINE_ITEM: Line Item, Fixed Quantity/Price, or Item Price Override SUBTOTAL: Transaction Kit deals and Tiered deals are not currently supported.
objectId	string	A unique identifier assigned by the Entitlement Engine; same as the EXTERNAL_DEAL_ID in the DLS_DEAL table.
description	string	The DESCRIPTION from the DL_DEAL table.
endDateTime	date	Reserved for future use.
name	string	The name of the deal.
components		Includes benefit, maximumQuantity, maximuumSubtotal, minimumQuantity, minimumSubtotal, qualifiers, rules, schedule, startDateTime, updateDate, serializedCouponDeal, scopeLimited, startDateTime, updateDate, and serializedCouponDeal.
benefit		Indicates the benefits of the deal. Includes benefitType, couponCode, coupons, giftSku, giftSkuQty, giftSkuQtys, giftSkus, prodAmtOff, prodAmtsOff, prodPctOff, prodPctsOff, prodPrice, prodPrices, shipAddCharge, shipAmtOff, shipNewCharge, shipNewMethod, shipPctOff, groupDiscount and shipOnLines.
benefitType	string	Describes the type of benefit: AmountOffBenefit, NewPriceBenefit, or PercentOffBenefit. If the setting is PercentOffBenefit, each qualifying line receives the full discount amount.
couponCode	string	Reserved for future use.
coupons	string	Reserved for future use.
giftSku	string	Reserved for future use.
giftSkuQty	integer	Reserved for future use.
giftSkuQtys	integer	Reserved for future use.
giftSkus	string	Reserved for future use.
prodAmtOff	decimal	Reserved for future use.
prodAmtsOff	decimal	Reserved for future use.
prodPctOff	integer	The PRODPCTOFF from the DL_DEAL_BENEFIT table.
prodPctsOff	integer	Reserved for future use.
prodPrices	decimal	Reserved for future use.
shipAddCharge	decimal	Reserved for future use.
shipAmtOff	decimal	Reserved for future use.
shipNewCharge	decimal	Reserved for future use.
shipNewMethod	string	Reserved for future use.
shipChargeCode	string	The code identifying the shipping award in an integrating system.
shipAwardType	string	The type of shipping award, such as upgrade (indicating a shipping upgrade) or base (indicating a discount on the base shipping charge).
shipPctOff	integer	Reserved for future use.
groupDiscount	boolean	Reserved for future use.
shipOnLines	boolean	Reserved for future use.
objectId	string	The DL_DEAL_BENEFIT_ID from the DL_DEAL_BENEFIT table.
maximumQuantity	integer	Reserved for future use.
maximumSubtotal	integer	Reserved for future use.
minimumQuantity	integer	The minimum number of purchase units required to activate this component. From the Threshold quantity specified at the Define Qualifying Items step for a deal.
minimumSubtotal	integer	Reserved for future use.
qualifiers		Includes buyAmts, buyQtys, channels, coupons, custEmails, custGroups, custIds, custLtdBuyAmt, custLtdTransCt, CustPrefs, custYtdBuyAmt, custYtdTransCt, keycodes, noDeals, offers, payments, prodAttrs, prodCodes, rodDistinctBy, prodSkus, qualifierType, searchEvents, shipCntries, shipMethods, shipScfs, shipStates, stores, urls, custFirstTime, custLoggedIn, custLoyalty, custNewRegistered, excluding, noOnLines, shipOneAddr, shipUS8Only, shipChargeCode, and shipAwardType.
buyAmts	decimal	Reserved for future use.
buyQtys	integer	Reserved for future use.
channels	string	Reserved for future use.
coupons	string	Reserved for future use.
custEmails	string	Reserved for future use.
custGroups	string	Reserved for future use.
custIds	string	Reserved for future use.
custLtdBuyAmt	decimal	Reserved for future use.
custLtdTransCt	integer	Reserved for future use.
custPrefs	string	Reserved for future use.
custYtdBuyAmt	decimal	Reserved for future use.
custYtdTransCt	integer	Reserved for future use.
keyCodes	string	A set of key codes entered by the cashier for this purchase; used to satisfy key code deal qualifier.
noDeals	string	Reserved for future use.
offers	string	Reserved for future use.
payments	string	Reserved for future use.
prodAttrs		Includes attrName and attrValue.
attrName	string	The name describing the attribute, such as CLASS or BRAND_NAME. Reserved for future use.
attrValue	string	The value for the attribute. Reserved for future use.
prodCodes	string	Reserved for future use.
prodDistinctBy	string	Reserved for future use.
prodSkus	string	A product SKU or item ID that qualifies for the specified deal.
qualifierType		The type of qualifier. Currently, supported qualifier types are AwardCouponQualifier and ProductQualifier.
searchEvents		Includes searchText and externalSearch.
searchText	string	The search text entered by the customer. Reserved for future use.
externalSearch	boolean	Indicates if the search was initiated from a website external to the retailer's, Reserved for future use.
shipCntries	string	Lists the two-position country codes that are eligible for a shipping award deal.
shipMethods	string	Lists the codes identifying the shipping methods to apply for a shipping award deal.
shipScfs	integer	Lists the 3-position codes identifying the Sectional Center Facility (SCF) that begin and end the geographical range where shipping addresses are eligible for the shipping award.
shipStates	string	Reserved for future use.
stores	string	Reserved for future use.
urls	string	Reserved for future use.
minimumCartSubtotal	decimal	Minimum subtotal for entire cart to satisfy this qualifier
maximumCartSubtotal	decimal	Maximum subtotal for entire cart to satisfy this qualifier
custFirstTime	boolean	Reserved for future use.
custLoggedIn	boolean	Reserved for future use.
custLoyalty	boolean	Reserved for future use.
custNewRegister	boolean	Reserved for future use.
custRegistered	boolean	Reserved for future use.
excluding	boolean	Reserved for future use.
noOnLines	boolean	Reserved for future use.
shipOneAddr	boolean	Reserved for future use.
shipUS48Only	boolean	Indicates whether the shipping award deal is available only in the continental US, excluding Alaska and Hawaii.
objectId	string	Unique identifier for the deal qualifier.
scopeLimited	boolean	Reserved for future use.
combinableWithinDeal	boolean	Indicates whether qualifying cart lines should be removed from further consideration within current deal, for use in subtotal and quantity thresholds. Useful when providing a component with no qualifiers solely to check for a minimum dollar/quantity threshold.
rules		Indicates the rules for the Deal. Includes groupLinesByShipTo, maxApplications, maxDiscount, maxDiscountPerApplication, maxGlobalApplications, maxGlobalDiscount, priority, combinableWithOtherTypes, combinableWithSameType, discountAppliedToLowestPriced, discountProrated, singleUseForCustomer, and objectId.
groupLinesByShipTo	boolean	Reserved for future use.
maxApplications	integer	Reserved for future use.
maxDiscount	decimal	Reserved for future use.
maxDiscountPerApplication	decimal	Reserved for future use.
maxGlobalApplications	integer	Reserved for future use.
maxGlobalDiscount	decimal	Reserved for future use.
priority	integer	Reserved for future use.
combinableWithOtherTypes	boolean	Set to true if the COMBINABLEWITHOTHERTYPES field in the DL_DEAL_RULES table is set to 1; otherwise set to false.
combinableWithSameType	boolean	Set to true if the COMBINABLEWITHSAMETYPE field in the DL_DEAL_RULES table is set to 1; otherwise set to false.
discountProrated	boolean	Set to true if the DISCOUNTPRORATED field in the DL_DEAL_RULES table is set to 1; otherwise set to false.
singleUserForCustomer	boolean	Reserved for future use.
objectId	string	The DL_DEAL_RULES_ID from the DL_DEAL_RULES table.
schedule		Includes dailyEndTime, dailyStartTime, offDates, and onDays.
dailyEndTime	date	Reserved for future use.
dailyStartTime	date	Reserved for future use.
offDates	date	Reserved for future use.
onDays	integer	Reserved for future use.
startDateTime	date	Reserved for future use.
updateDate	date	Reserved for future use.
serializedCouponDeal	boolean	Reserved for future use.
responseCode	string	Reserved for future use.
responseMessage	string	Reserved for future use.
successful	boolean	Set to true if the response includes the information on the Deal.

Post Apply Deals

The POS might use this message to send details on a cart to the Entitlement Engine in order to obtain information on the qualifying deals.

The information in the request message is not retained in the database. It is used only to determine the deal information to be returned in the response message.

The URL for the Post Apply Deals message is:

https://<SERVER>/ORGANIZATION_NAME>/promote/services/dealServices/applyDeals

Sample Apply Deals Request Message

The following sample messages includes a single line item for a quantity of 2, and a single deal and coupon code.

The couponCode passed is not validated, but is required for the deal to be evaluated.

{"cartLines" :
    [
        {"product" :
              { "sku" : "<SKU>",
              "productCode" : "Sample Organic Cinnamon 2.5 oz jar" ,
              "unitPrice" : 10.00,
              "extendedPrice" : 20.00,
              "lineSeq" : 1,
              "quantity" : 2
          } } ],
        "awardCoupons" :
[
              {
        "dealId" : "<DEAL_ID>",
        "couponCode" : "<COUPON_CODE>"
}
],
"dateTime" : "2017-01-09T17:23:21.354+0000"
}

The following is a sample of a cart that includes shipping awards:

{"cartLines" :
[
        {"product" : { "sku" : "<SKU>",
              "productCode" : "Oopsie Daisy Ring" } ,
              "unitPrice" : 100.00,
              "extendedPrice" : 100.00,
              "lineSeq" : 1,
              "quantity" : 1,
              "shipToSeq": 1}],
              "awardCoupons" :
         [
         {
              "dealId" : "<DEAL_ID>",
              "couponCode" : "<COUPON_CODE>" } ],
              "shipTos":
              [ { "shipToAddress":
         {
              "addressLine1": "<ADDRESS LINE 1>",
              Entitlement Engine Services B-17
              "addressLine2": "",
              "addressLine3": "",
              "apartment": "",
              "city": "Cleveland",
              "country": "US",
              "postalCode": "44113",
              "state": "OH"
         },
              "shipToSeq": 1,
              "shipperCode": "<SHIPPER_CODE>",
              "shippingCharge": 18.98
         }
],
"dateTime" : "2018-06-26T17:23:21.354+0000"}

Apply Deals Request Parameters

{
     "awardCoupons": [ {
         "couponCode": "string",
         "dealId": "string"
} ],
     "cartLines": [ {
         "extendedPrice": "decimal",
         "lineSeq": "integer",
         "product": {
             "attributes": [ {
                  "attrName": "string",
                  "attrValue": "string",
                  "attributeId": "string",
                  "sku": "string"
         } ],
         "productCode": "string",
         "sku": "string"
},
     "quantity": "integer",
     "shipToSeq": "integer",
     "unitPrice": "decimal",
     "freeGift": "boolean",
     "nonDiscountable": "boolean",
     "nonQualifying": "boolean",
     "onRegistry": "boolean"
} ],
     "couponCodes": [ "string" ],
     "customer": {
          "customerId": "string",
          "emailAddress": "string",
          "emailPreference": "string",
          "loyaltyIds": [ "string" ],
          "ltdPurchaseAmount": "decimal",
          "ltdTransactionCount": "integer",
          "segments": [ "string" ],
          "ytdPurchaseAmount": "decimal",
          "ytdTransactionCount": "integer",
          "loggedIn": "boolean",
          "loyaltyMember": "boolean",
          "newlyRegistered": "boolean",
          "registered": "boolean"
},
     "dateTime": "date",
     "keyCodes": [ "string" ],
     "localCurrency": "string",
     "offerCodes": [ "string" ],
     "paymentTypes": [ "string" ],
     "retailChannel": "string",
     "searchEvents": [ {
          "searchText": "string",
          "externalSearch": "boolean"
} ],
     "shipTos": [ {
           "shipToAddress": {
               "addressLine1": "string",
               "addressLine2": "string",
               "addressLine3": "string",
               "apartment": "string",
               "city": "string",
               "country": "string",
               "postalCode": "string",
               "state": "string"
},
           " shipToSeq": "integer",
           "shipperCode": "string",
           "shippingCharge": "decimal"
} ],
     "soldToAddress": {
           "addressLine1": "string",
           "addressLine2": "string",
           "addressLine3": "string",
           "apartment": "string",
           "city": "string",
           "country": "string",
           "postalCode": "string",
           "state": "string"
},
     "storeGeoLocation": {
           "latitude": "integer",
           "longtitude": "integer"
},
     "storeId": "string",
     "subtotal": "decimal",
     "url": "string",
     "viewProductEvents": [ {
          "productCode": "string",
          "sku": "string"
           } ]
      }

Apply Deals Request Message Contents

The applyDeals request message contains the following information.

Value	Type	Description
awardCoupons		Includes couponCode and dealId.
couponCode	string	The code identifying the coupon to be redeemed. Not validated, but required for the deal to be evaluated.
dealId	string	Unique number identifying the deal to the Entitlement Engine. From the EXTERNAL_DEAL_ID in the DLS_DEAL table.
cartLines		Includes product, awardCoupons, and dateTime. Additional elements included at this level are reserved for future use.
product		Includes attributes, productCode, sku, unitPrice, extendedPrice, lineSeq, and quantity.
productCode	string	The description of the item.
sku	string	The code identifying the item in the cart.
unitPrice	decimal	The price of a single unit of the item.
extendedPrice	decimal	The extended price of the item * the quantity.
lineSeq	integer	Line item sequence number for the item in the cart.
quantity	integer	Quantity of the item in the cart.
attributes		Includes attrName, attrValue, attrId, and sku. Reserved for future use.
attrName	string	Reserved for future use.
attrValue	string	Reserved for future use.
attributeId	string	Reserved for future use.
ShipToSeq	integer	Reserved for future use.
unitPrice	decimal	Reserved for future use.
freeGift	boolean	Reserved for future use.
nonDiscountable	boolean	Reserved for future use.
nonQualifying	boolean	Reserved for future use.
onRegistry	boolean	Reserved for future use.
couponCodes	string	Reserved for future use.
customer		Includes customerId, emailAddress, emailPreference, loyaltyIds, ltdPurchaseAmount, ltdTransactionCount, segments, ytdPurchaseAmount, ytdTransactionCount, loggedIn, loyaltyMember, newlyRegistered, and registered. Reserved for future use.
customerId	string	Reserved for future use.
emailAddress	string	Reserved for future use.
emailPreference	string	Reserved for future use.
loyaltyIds	string	Reserved for future use.
ltdPurchaseAmount	decimal	Reserved for future use.
ltdTransactionCount	integer	Reserved for future use.
segments	string	Reserved for future use.
ytdPurchaseAmount	decimal	Reserved for future use.
ytdTransactionCount	integer	Reserved for future use.
loggedIn	boolean	Reserved for future use.
loyaltyMember	boolean	Reserved for future use.
newlyRegistered	boolean	Reserved for future use.
registered	boolean	Reserved for future use.
dateTime	date	A date/time stamp for the request.
keyCodes	string	Reserved for future use.
localCurrency	string	Reserved for future use.
offerCodes	string	Reserved for future use.
paymentTypes	string	Reserved for future use.
retailChannel	string	Reserved for future use.
searchEvents		Includes searchText and externalSearch. Reserved for future use.
searchText	string	Reserved for future use.
externalSearch	boolean	Reserved for future use.
shipTos		Includes shipToAddress, shipToSeq, shipperCode, and shippingCharge.
shipToAddress		Includes addressLine1 through addressLine3, apartment, city, country, postalCode, and state.
addressLine1	string	Reserved for future use.
addressLine2	string	Reserved for future use.
addressLine3	string	Reserved for future use.
apartment	string	Reserved for future use.
city	string	Reserved for future use.
country	string	Reserved for future use.
postalCode	string	Reserved for future use.
state	string	Reserved for future use.
shipToSeq	integer	Reserved for future use.
shipperCode	string	Reserved for future use.
shippingCharge	decimal	Reserved for future use.
soldToAddress		Includes addressLine1 through addressLine3, apartment, city, country, postalCode, and state. Reserved for future use.
addressLine1 through addressLine3	string	Reserved for future use.
apartment	string	Reserved for future use.
city	string	Reserved for future use.
country	string	Reserved for future use.
postalCode	string	Reserved for future use.
state	string	Reserved for future use.
storeGeoLocation		Includes latitude and longitude. Reserved for future use.
latitude	integer	Reserved for future use.
longitude	integer	Reserved for future use.
storeId	string	Reserved for future use.
subtotal	decimal	Reserved for future use.
url	string	Reserved for future use.
viewProductEvents		Includes productCode and sku. Reserved for future use.
productCode	string	Reserved for future use.
sku	string	Reserved for future use.

Sample Apply Deals Response Messages

The following examples illustrate some possible applyDeals() response messages for different types of deals.

Line Item Deal Response

The following illustrates a response for a cart that includes a single line item for a quantity of two that is eligible for a line item deal. The unit price is $10, and the deal can apply a 65% discount to both units.

{ "cart": { "appliedDeals": [ {
        "applicationSeq": 1,
        "dealCode": "<DEAL_CODE>",
        "dealDescription": "Line Deal",
        "dealName": "Line Deal",
        "traces": [ {
           "value": "<VALUE>",
           "key": "awardCouponCode" }],
        "dealId": "<DEAL_ID>",
        "dealType": "LINE_ITEM" }],
"awardCoupons": [ {
        "couponCode": "<COUPON_CODE>",
        "dealId": "<DEAL_ID>" }],
"cartLines": [ {
        "discountRewards": [ {
           "appliedToOrder": false,
           "amountOff": 13,
           "dealPointer": {
               "applicationSeq": 1,
               "dealId": "<DEAL_CODE>" } }],
"lineSeq": 1,
"quantity": 2,
"extendedPrice": 20,
"priceModifier": {
     "adjustedUnitPrice": 3.5,
     "discountAmount": 13,
     "adjustedExtendedPrice": 7 },
"product": {
     "sku": "1234567890",
     "productCode": "Sample Organic Cinnamon 2.5 oz jar", "attributes": [ {
             "sku": "<SKU>",
             "attributeId": "<ID>::BRAND_NAME",
             "attrValue": "Sample Organic ",
             "attrName": "BRAND_NAME",
             "objectId": "<OBJECT_ID>" }, {
             "sku": "222200002",
             "attributeId": "<ID>::CLASS",
             "attrValue": "925-B-M",
             "attrName": "CLASS",
             "objectId": "<OBJECT_ID>" }, {
             "sku": "222200002",
             "attributeId": "<ID>::SUB_DEPT",
             "attrValue": "925-B",
             "attrName": "SUB_DEPT",
             "objectId": "<OBJECT_ID>" }, {
             "sku": "<SKU>",
             "attributeId": "<ID>::DEPT",
             "attrValue": "925",
             "attrName": "DEPT",
             "objectId": "<OBJECT_ID>" }, {
             "sku": "<SKU>",
             "attributeId": "<ID>::STYLE_ID",
             "attrValue": "BELTS",
             "attrName": "PRODUCT_CODE",
             "objectId": "<OBJECT_ID>" }, {
             "sku": "<SKU>",
             "attributeId": "<ID>::SEASON_CODE",
             "attrValue": "All-Seasons",
             "attrName": "SEASON_CODE",
             "objectId": "<OBJECT_ID>" } ] },
"unitPrice": 10,
       "unitPriceModifiers": [ {
             "adjustedUnitPrice": 3.5,
             "discountAmount": 6.5,
             "unitQuantity": 2 }] }],
   "dateTime": "2017-01-09T17:23:21",
   "dealCurrency": "USD" },
"successful": true

BOGO Deal Response

The following illustrates a response for a cart that is eligible for a buy 2 get 1 free deal.

The cart needs to include both the qualifying items and the free items.

In the following example, the total discount of the item price of $100 is broken out into two amountOff entries of 63.5 and 36.5, each in a separate discountRewards entry.

{ "cart": { "appliedDeals": [ {
       "applicationSeq": 1,
       "dealCode": "<CODE>",
       "dealDescription": "Gift Deal",
       "dealName": "Gift Deal",
       "traces": [ { "value": "<VALUE>",
          "key": "awardCouponCode" }],
       "dealId": "<ID>",
       "dealType": "BOGO" }],
"awardCoupons": [ {
       "couponCode": "<COUPON_CODE>",
       "dealId": "<ID>" }],
"cartLines": [ {
       "discountRewards": [ {
           "appliedToOrder": false,
        "amountOff": 63.5,
        "dealPointer": {
           "applicationSeq": 1,
           "dealId": "1234567890" } }],
       "quantity": 2,
       "lineSeq": 1,
       "product": {
           "sku": "111100028",
           "productCode": " Men’s Formal Slacks - Brown" },
       "extendedPrice": 173.98,
       "priceModifier": {
            "discountAmount": 63.5,
            "adjustedExtendedPrice": 110.48,
            "adjustedUnitPrice": 55.24 },
       "unitPrice": 86.99,
       "unitPriceModifiers": [ {
            "discountAmount": 31.75,
            "unitQuantity": 2,
            "adjustedUnitPrice": 55.24 }] }, {
       "discountRewards": [ {
            "appliedToOrder": false,
       "amountOff": 36.5,
       "dealPointer": {
            "applicationSeq": 1,
            "dealId": "<ID>" } }],
            "quantity": 1,
            "lineSeq": 2,
            "product": {
               "sku": "<SKU>",
               "productCode": " Men’s Formal Shirt - White" },
            "extendedPrice": 100,
            "priceModifier": {
                "discountAmount": 36.5,
                "adjustedExtendedPrice": 63.5,
                "adjustedUnitPrice": 63.5 },
            "unitPrice": 100,
            "unitPriceModifiers": [ {
                "discountAmount": 36.5,
                "unitQuantity": 1,
                "adjustedUnitPrice": 63.5 }] } ],
   "dateTime": "2016-02-10T17:23:21",
   "dealCurrency": "USD" }, "successful": true}

Multiple Deal Response

The following illustrates a response for a cart that is eligible for multiple deals that are specified in the request.

In this example, the original price is $100. The first deal applies a discount of $35, changing the price to $65. The second deal then applies a discount of $9.75, for an adjusted unit price of $55.25, and a total discount of $44.75.

The Allow items to be used in other Deals setting at the Define Advanced Params step for the deal controls whether each subsequent deal can apply to the items in the same cart. For example, deal A is flagged to allow additional deals, and deal B is not. If deal A is passed before deal B in the request, it is possible for both deals to apply. However, if deal B is passed before deal A, then deal B consumes the items, and deal A is not evaluated.

"cart": { "appliedDeals": [ {
         "applicationSeq": 1,
         "dealCode": "<CODE>",
         "dealDescription": "Deal Item in Dept 900",
         "dealName": "Deal Item in Dept 900",
         "traces": [ {
           "value": "456",
           "key": "awardCouponCode" }],
         "dealId": "<ID>",
         "dealType": "LINE_ITEM" }, {
         "applicationSeq": 2,
         "dealCode": "<CODE>",
         "dealDescription": "Brazil - ETL",
         "dealName": "Brazil - ETL",
         "traces": [ {
            "value": "<VALUE>",
            "key": "awardCouponCode" }],
         "dealId": "<ID>",
         "dealType": "LINE_ITEM" } ],
"awardCoupons": [ {
         "couponCode": "<CODE>",
         "dealId": "<ID>" }, {
         "couponCode": "<CODE>",
         "dealId": "<ID>" } ],
         "cartLines": [ {
           "discountRewards": [ {
                   "appliedToOrder": false,
                   "amountOff": 35,
                   "dealPointer": {
                       "applicationSeq": 1, "dealId": "12345678905" } }, {
                   "appliedToOrder": false,
                   "amountOff": 9.75,
                   "dealPointer": {
                       "applicationSeq": 2,
                       "dealId": "<DEAL_ID>" } } ],
         "lineSeq": 1,
         "quantity": 1,
         "extendedPrice": 100,
         "priceModifier": {
            "adjustedUnitPrice": 55.25,
            "discountAmount": 44.75,
            "adjustedExtendedPrice": 55.25 },
         "product": {
            "sku": "<SKU>",
            "productCode": "Men’s Argyle Sweater - Black",
            "attributes": [ {
            "sku": "<SKU>",
            "attributeId": "<ATTRIBUTE_ID>::DEPT",
            "attrValue": "900",
            "attrName": "DEPT",
            "objectId": "<OBJECT_ID>" }] },
         "unitPrice": 100,
         "unitPriceModifiers": [ {
            "adjustedUnitPrice": 55.25,
            "discountAmount": 44.75,
            "unitQuantity": 1 }] }],
   "dateTime": "2015-12-10T17:23:21",
   "dealCurrency": "USD" }, "successful": true}

Ineligible for Deal Response

The following illustrates a response for a cart that is not eligible for the deal specified in the request.

{ "cart": {
     "awardCoupons": [ {
        "couponCode": "<CODE>",
         "dealId": "<DEAL_ID>" }],
     "cartLines": [ {
        "lineSeq": 1,
        "quantity": 2,
        "extendedPrice": 400,
        "product": {
            "sku": "<SKU>",
      "productCode": " Men’s Formal Shirt - Black " },
    unitPrice": 200 }],
"dateTime": "2015-12-21T17:23:21", "dealCurrency": "USD" },
"successful": true}

Apply Deals Response Schema

{
"cart": {
     "appliedDeals": [ {
         "applicationSeq": "integer",
         "dealCode": "string",
         "dealDescription": "string",
         "dealId": "string",
         "dealName": "string",
         "dealType": "string",
         "traces": [ {
              "key": "string",
              "value": "string"
} ]
} ],
     "bouncebackCouponRewards": [ {
         "couponCode": "string",
         "dealPointer": {
             "applicationSeq": "integer",
             "dealId": "string"
},
        "lineQuantity": "integer",
        "shipToSeq": "integer"
} ],
     "awardCoupons": [ {
         "couponCode": "string",
         "dealId": "string" }],
     "cartLines": [ {
         "appliedQualifiers": [ {
            "applicationSeq": "integer",
            "dealId": "string"
} ],
     "discountRewards": [ {
         "amountOff": "decimal",
         "dealPointer": {
              "applicationSeq": "integer",
              "dealId": "string"
},
         "lineQuantity": "integer",
         "appliedToOrder": "boolean"
} ],
     "extendedPrice": "decimal",
     "lineSeq": "integer",
     "priceModifier": {
           "adjustedExtendedPrice": "decimal",
           "adjustedUnitPrice": "decimal",
           "discountAmount": "decimal"
},
     "product": {
           "attributes": [ {
           "attrName": "string",
           "attrValue": "string",
           "attributeId": "string",
           "sku": "string"
           "objectId": "string"
           } ],
           "productCode": "string",
           "sku": "string"
},
     "quantity": "integer",
     "shipToSeq": "integer",
     "shippingRewards": [ {
           "additionalCharge": "decimal",
           "amountOffCharge": "decimal",
           "dealPointer": {
               "applicationSeq": "integer",
               "dealId": "string"
           },
           "lineQuantity": "integer",
           "newCharge": "decimal",
           "newMethod": "string",
           "percentOffCharge": "integer"
} ],
     "unitPrice": "decimal",
     "unitPriceModifiers": [ {
           "adjustedUnitPrice": "decimal",
           "discountAmount": "decimal",
           "unitQuantity": "integer"
} ],
     "freeGift": "boolean",
     "nonDiscountable": "boolean",
     "nonQualifying": "boolean",
     "onRegistry": "boolean"
} ],
     "couponCodes": [ "string" ],
     "customer": {
           "customerId": "string",
           "emailAddress": "string",
           "emailPreference": "string",
           "loyaltyIds": [ "string" ],
           "ltdPurchaseAmount": "decimal",
           "ltdTransactionCount": "integer",
           "segments": [ "string" ],
           "ytdPurchaseAmount": "decimal",
           "ytdTransactionCount": "integer",
           "loggedIn": "boolean",
           "loyaltyMember": "boolean",
           "newlyRegistered": "boolean",
           "registered": "boolean"
},
     "dateTime": "date",
     "dealCurrency": "string",
     "giftItemRewards": [ {
           "dealPointer": {
                "applicationSeq": "integer",
                "dealId": "string"
},
           "lineQuantity": "integer",
           "quantity": "integer",
           "shipToSeq": "integer",
           "sku": "string"
} ],
     "keyCodes": [ "string" ],
     "localCurrency": "string",
     "offerCodes": [ "string" ],
     "paymentTypes": [ "string" ],
     "retailChannel": "string",
     "searchEvents": [ {
           "searchText": "string",
           "externalSearch": "boolean"
} ],
     "shipTos": [ {
        "shipToAddress": {
           "addressLine1": "string",
           "addressLine2": "string",
           "addressLine3": "string",
           "apartment": "string",
           "city": "string",
           "country": "string",
           "postalCode": "string",
           "state": "string"
},
        "shipToSeq": "integer",
        "shipperCode": "string",
        "shippingCharge": "decimal"
} ],
     "shippingRewards": [ {
           "additionalCharge": "decimal",
           "amountOffCharge": "decimal",
           "dealPointer": {
                "applicationSeq": "integer",
                "dealId": "string"
},
           "lineQuantity": "integer",
           "newCharge": "decimal",
           "newMethod": "string",
           "percentOffCharge": "integer"
} ],
     "soldToAddress": {
           "addressLine1": "string",
           "addressLine2": "string",
           "addressLine3": "string",
           "apartment": "string",
           "city": "string",
           "country": "string",
           "postalCode": "string",
           "state": "string"
},
     "storeGeoLocation": {
           "latitude": "integer",
           "longtitude": "integer"
},
     "storeId": "string",
     "subtotal": "decimal",
     "url": "string",
     "viewProductEvents": [ {
         "productCode": "string",
         "sku": "string"
} ]
},
     "responseCode": "string",
     "responseMessage": "string",
     "successful": "boolean"
}

Apply Deals Response Message Contents

The Apply Deals response message contains the following information.

Value	Type	Description
cart		Includes appliedDeals, bouncebackCouponRewards, responseCode, responseMessage, and successful.
appliedDeals		Includes applicationSeq, dealCode, dealDescription, dealId, dealName, dealType, and traces.
applicationSeq	integer	A counter used both to indicate the order in which deals were applied, and to differentiate between multiple applications of the same deal.
dealCode	string	The Customer Engagement deal ID.
dealDescription	string	Description of the deal.
dealName	string	Description of the deal.
dealId	string	Unique number identifying the deal to the Entitlement Engine
dealType	string	Identifies the type of deal: BOGO: Buy X Get X, Buy X Get Y, or Gift with Purchase LINE_ITEM: Line Item, Fixed Quantity/Price, or Item Price Override SUBTOTAL: Transaction Kit deals and Tiered deals are not currently supported.
value	string	The couponCode passed in the request message.
key	string	Identifies the type of trace information; for example, awardCouponCode.
bouncebackCouponRewards		Includes couponCode, dealPointer, lineQuantity, and shipToSeq. Reserved for future use.
couponCode	string	Reserved for future use.
lineQuantity	integer	Reserved for future use.
shipToSeq	integer	Reserved for future use.
dealPointer		Includes applicationSeq and dealId. Reserved for future use.
applicationSeq	integer	Reserved for future use.
dealId	integer	Reserved for future use.
awardCoupons		Includes couponCode and dealId.
couponCode	string	The couponCode passed in the request message.
dealId	string	Unique number identifying the deal to the Entitlement Engine.
cartLines		Includes appliedQualifiers, discountRewards, extendedPrice, lineSeq, priceModifier, product, quantity, shipToSeq, shippingRewards, unitPrice, unitPriceModifiers, freeGift, nonDiscountable, nonQualifying, and onRegistry.
appliedQualifiers		Includes applicationSeq and dealId. Reserved for future use.
applicationSeq	integer	Reserved for future use.
dealId	string	Reserved for future use.
discountRewards		Includes appliedToOrder, amountOff, dealPointer, and lineQuantity.
appliedToOrder	boolean	Set to true if this is a transaction-level discount; otherwise, set to false if the deal includes product-specific qualifiers, such as applies only to sweaters.
amountOff	decimal	The total amount of the discount applied to the line. For example, if the line is for 2 units at an original unit price of $100, and a 10% discount applies to each unit, the amountOff is 20. In the case of a 100% BOGO discount such as buy 2 get 1 free, the amountOff is equal to the original unit price. If the deal has a maximum award amount specified, the discount actually applied might be less than the calculated amount.
lineQuantity	integer	Reserved for future use.
dealPointer		Includes applicationSeq and dealId.
applicationSeq	integer	A counter used both to indicate the order in which deals were applied, and to differentiate between multiple applications of the same deal. dealId string Unique number identifying the deal to the Entitlement Engine.
extendedPrice	decimal	The extended price before applying the discount. For example, if there are 2 units at an original price of $100 each, this is 200.
lineSeq	integer	A unique number identifying the line in the cart.
priceModifier		Includes adjustedExtendedPrice, adjustededUnitPrice, and discountAmount.
adjustedUnitPrice	decimal	The unit price after applying the discount. For example, if each unit on the line receives a $25 discount, this is 75. If the deal has a maximum award amount specified, the discount actually applied might be less than the calculated amount.
discountAmount	decimal	The extended discount amount. For example, if 2 units each receive a $25 discount, this is 50. In the case of a 100% BOGO discount such as buy 2 get 1 free, the discountAmount is equal to the original unit price. If the deal has a maximum award amount specified, the discount actually applied might be less than the calculated amount.
adjustedExtendedPrice	decimal	The extended line price after applying the discount. For example, if 2 units originally priced at $100 each received a $25 discount, this is 150. If the deal has a maximum award amount specified, the discount actually applied might be less than the calculated amount.
product		Includes attributes, productCode, and sku.
sku	string	The SKU code for the item on the line.
productCode	string	The description of the item.
attributes		Includes attrName, attrValue, attributeId, sku, and objectId.
attributeId	string	An automatically generated, publicly accessible primary key, creating by concatenating the SKU + ::+ ATTRNAME. For example, if the SKU is 12345 and the attrName is CLASS, this is 12345::CLASS.
attrValue	string	The value for the attribute.
attrName	string	The name describing the attribute, such as CLASS or BRAND_NAME.
sku	string	The SKU code for the item on the line.
objectId	string	The DL_DEAL_PRODUCT_ATTRIBUTE_ID from the DL_DEAL_PRODUCT_ATTRIBUTE table, uniquely identifying the attribute for the product in the deal.
quantity	integer	The line quantity receiving the discount. Less than the total line quantity if a maximum quantity is specified for the deal, and the total line quantity exceeds this maximum.
shipToSeq	integer	Reserved for future use.
shippingRewards		Includes additionalCharge, amountOffCharge, dealPointer, lineQuantity, newCharge, newMethod, and percentOffCharge. Reserved for future use.
additionalCharge	decimal	Reserved for future use.
amountOffCharge	decimal	Reserved for future use.
lineQuantity	integer	Reserved for future use.
newCharge	decimal	Reserved for future use.
newMethod	string	Reserved for future use.
percentOffCharge	integer	Reserved for future use.
dealPointer		Includes applicationSeq and dealId. Reserved for future use.
applicationSeq	integer	Reserved for future use.
dealId	string	Reserved for future use.
unitPrice	decimal	The original unit price before applying the discount. For example, for a line with 2 units at $100, this is 100.
unitPriceModifiers		Includes adjustedUnitPrice, discountAmount, and unitQuantity.
adjustedUnitPrice	decimal	The single-unit price after applying the discount. For example, for a line with 2 units at $100 and a $25 discount applied to each unit, this is 75. If the deal has a maximum award amount specified, the discount actually applied might be less than the calculated amount.
discountAmount	decimal	The single-unit discount amount. For example, for a line with 2 units at $100 and a $25 discount applied to each unit, this is 25. If the deal has a maximum award amount specified, the discount actually applied might be less than the calculated amount.
unitQuantity	integer	The unit quantity for the line.
freeGift	boolean	Reserved for future use.
nonDiscountable	boolean	Reserved for future use.
nonQualifying	boolean	Reserved for future use.
onRegistry	boolean	Reserved for future use.
couponCodes	string	Reserved for future use.
customer		Includes customerId, emailAddress, emailPreference, loyaltyIds, ltdPurchaseAmount, ltdTransactionCount, segments, ytdPurchaseAmount, ytdTransactionCount, loggedIn, loyaltyMember, newlyRegistered, and registered.
customerId	string	Reserved for future use.
emailAddress	string	Reserved for future use.
emailPreference	string	Reserved for future use.
loyaltyIds	string	Reserved for future use.
ltdPurchaseAmount	decimal	Reserved for future use.
ltdTransactionCount	integer	Reserved for future use.
segments	string	Reserved for future use.
ytdPurchaseAmount	decimal	Reserved for future use.
ytdTransactionCount	integer	Reserved for future use.
loggedIn	boolean	Reserved for future use.
loyaltyMember	boolean	Reserved for future use.
newlyRegistered	boolean	Reserved for future use.
registered	string	Reserved for future use.
dateTime	date	The date/time stamp indicating when the response was generated.
dealCurrency	string	The code identifying the currency for the cart.
giftItemRewards		Includes dealPointer, lineQuantity, quantity, shipToSeq, and sku. Reserved for future use.
dealPointer		Includes applicationSeq and dealId. Reserved for future use.
applicationSeq	integer	Reserved for future use.
dealId	string	Reserved for future use.
lineQuantity	integer	Reserved for future use.
quantity	integer	Reserved for future use.
shipToSeq	integer	Reserved for future use.
sku	string	Reserved for future use.
keyCodes	string	Reserved for future use.
localCurrency	string	Reserved for future use.
offerCodes	string	Reserved for future use.
paymentTypes	string	Reserved for future use.
retailChannel	string	Reserved for future use.
searchEvents		Includes searchText and externalSearch. Reserved for future use.
searchText	string	Reserved for future use.
externalSearch	boolean	Reserved for future use.
shipTos		Includes shipToAddress, shipToSeq, shipperCode, and shippingCharge. Reserved for future use.
shipToAddress		Includes addressLine1 through addressLine3, apartment, city, country, postalCode, and state. Reserved for future use.
addressLine1throughaddressLine3	string	Reserved for future use.
apartment	string	Reserved for future use.
city	string	Reserved for future use.
country	string	Reserved for future use.
postalCode	string	Reserved for future use.
state	string	Reserved for future use.
shipToSeq	string	Reserved for future use.
shipperCode	string	Reserved for future use.
shippingCharge	decimal	Reserved for future use.
shippingRewards		Includes additionalCharge, amountOffCharge, dealPointer, lineQuantity, newCharge, newMethod, and percentOffCharge. Reserved for future use.
additionalCharge	decimal	Reserved for future use.
amountOffCharge	decimal	Reserved for future use.
dealPointer		Includes applicationSeq and dealId. Reserved for future use.
applicationSeq	integer	Reserved for future use.
dealId	string	Reserved for future use.
lineQuantity	integer	Reserved for future use.
newCharge	decimal	Reserved for future use.
newMethod	string	Reserved for future use.
percentOffCharge	integer	Reserved for future use.
soldToAddress		Includes addressLine1 through addressLine3, apartment, city, country, postalCode, and state. Reserved for future use.
addressLine1throughaddressLine3	string	Reserved for future use.
apartment	string	Reserved for future use.
city	string	Reserved for future use.
country	string	Reserved for future use.
postalCode	string	Reserved for future use.
state	string	Reserved for future use.
storeGeoLocation		Includes latitude and longitude. Reserved for future use.
latitude	integer	Reserved for future use.
longitude	integer	Reserved for future use.
storeId	string	Reserved for future use.
subtotal	decimal	Reserved for future use.
url	string	Reserved for future use.
viewProductEvents		Includes productCode and sku. Reserved for future use.
productCode	string	Reserved for future use.
sku	string	Reserved for future use.
responseCode	string	Reserved for future use.
responseMessage	string	Reserved for future use.
successful	boolean	Set to true.