This event is triggered at checkout page to get tax for cart from external service
Root Schema : externalTaxCalculation_request
Type: object
This event is triggered at checkout page to get tax for cart from external service
Show Source
{
"description":"This event is triggered at checkout page to get tax for cart from external service",
"properties":{
"request":{
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"The secondary currency tax amount and this will be present only if it is a points based order",
"type":"number",
"example":0
},
"shippingGroups":{
"type":"array",
"items":{
"type":"object",
"properties":{
"lastName":{
"description":"The second name of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"Muir"
},
"firstName":{
"description":"The first name of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"John"
},
"priceInfo":{
"type":"object",
"properties":{
"amount":{
"type":"number",
"example":21.99
},
"total":{
"type":"number",
"example":21.99
},
"lkpValExcludingFreeShip":{
"type":"number",
"example":0
},
"shipping":{
"type":"number",
"example":25
},
"shippingSurchargeValue":{
"type":"number",
"example":0
},
"tax":{
"type":"number",
"example":0
},
"subTotal":{
"type":"number",
"example":21.99
},
"currencyCode":{
"type":"string",
"example":"USD"
},
"totalWithoutTax":{
"type":"number",
"example":21.99
}
}
},
"itemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding items property is truncated. The value for this field will always be true if present",
"type":"boolean"
},
"phoneNumber":{
"description":"The phone number of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"1231231234"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number",
"example":21.99
},
"total":{
"description":"The total price of the recurring charge.",
"type":"number",
"example":21.99
},
"frequencyAmountTotals":{
"description":"The total for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string",
"example":21.99
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string",
"example":"Monthly"
}
}
}
},
"shipping":{
"description":"Cost of shipping the product.",
"type":"number",
"example":25
},
"tax":{
"description":"Monetary tax amount.",
"type":"number",
"example":0
},
"subTotal":{
"description":"The sub-total price of the recurring charge.",
"type":"number",
"example":21.99
},
"frequencyTaxTotals":{
"description":"The tax for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string",
"example":0
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string",
"example":"Monthly"
}
}
}
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string",
"example":"USD"
},
"totalWithoutTax":{
"description":"Total of recurring amount without tax included.",
"type":"number",
"example":21.99
}
}
},
"discountInfo":{
"description":"The discount information.",
"type":"object",
"properties":{
"unclaimedCouponMultiPromotions":{
"type":"object",
"properties":{
"promotionInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"long desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PRMName"
},
"promotionLevel":{
"type":"string",
"example":"order"
},
"totalAdjustment":{
"type":"number",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"description of the promotion"
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
},
"orderCouponsMap":{
"description":"The list of all the coupons with the order",
"type":"array",
"items":{
"type":"object",
"properties":{
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions)",
"type":"boolean",
"example":false
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string",
"example":"0"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string",
"example":"promotion desc"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string",
"example":"promo123"
}
}
}
},
"orderDiscount":{
"description":"The order discount.",
"type":"number",
"example":0
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"number",
"example":5.6
},
"orderImplicitDiscountList":{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"Detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PROMO1"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions)",
"type":"boolean",
"example":true
},
"promotionLevel":{
"description":"promotion level - order or item",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string",
"example":"5.6"
},
"promotionDesc":{
"type":"string",
"example":"the order related promotion"
},
"secondaryCurrencyTotalAdjustment":{
"description":"The total adjustment for secondary currency",
"type":"string",
"example":"0"
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
},
"unclaimedCouponsMap":{
"type":"object",
"properties":{
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
},
"claimedCouponMultiPromotions":{
"type":"object",
"properties":{
"promotions":{
"type":"array",
"items":{
"type":"object",
"properties":{
"totalAdjustment":{
"type":"number",
"example":0
},
"secondaryCurrencyTotalAdjustment":{
"type":"number",
"example":0
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
}
}
},
"shippingMethod":{
"description":"The shipping method details for the order.",
"type":"object",
"properties":{
"shippingTax":{
"description":"The shipping tax.",
"type":"number",
"example":0
},
"cost":{
"description":"The cost of shipping.",
"type":"number",
"example":25
},
"taxCode":{
"description":"The tax code for shipping method.",
"type":"string",
"example":"TX123"
},
"value":{
"description":"The shipping method .",
"type":"string",
"example":"TwoDay"
},
"shippingMethodDescription":{
"description":"The shipping method description.",
"type":"string",
"example":"Two day shipping"
}
}
},
"shippingGroupId":{
"description":"The shipping group id.",
"type":"string",
"example":"sg123"
},
"shippingAddress":{
"type":"object",
"properties":{
"lastName":{
"type":"string",
"example":"Muir"
},
"country":{
"type":"string",
"example":"United States"
},
"address3":{
"type":"string",
"example":"Suite 6"
},
"address2":{
"type":"string",
"example":"2 cross"
},
"city":{
"type":"string",
"example":"Boston"
},
"address1":{
"type":"string",
"example":"1 main st"
},
"prefix":{
"type":"string",
"example":"Mr"
},
"companyName":{
"type":"string",
"example":"Oracle"
},
"postalCode":{
"type":"string",
"example":12345
},
"jobTitle":{
"type":"string",
"example":"Manager"
},
"county":{
"type":"string",
"example":"Suffolk"
},
"suffix":{
"type":"string",
"example":"Sr"
},
"firstName":{
"type":"string",
"example":"John"
},
"phoneNumber":{
"type":"number",
"example":1231231234
},
"faxNumber":{
"type":"number",
"example":1231231234
},
"middleName":{
"type":"string",
"example":"Morgan"
},
"state":{
"type":"string",
"example":"MA"
},
"email":{
"type":"string",
"example":"john.muir@oracle.com"
}
}
},
"items":{
"type":"array",
"items":{
"type":"object",
"properties":{
"availablePickupDate":{
"description":"The items available store pickup date.",
"type":"string",
"example":"2018-05-19T13:00:00.000Z"
},
"unitPrice":{
"description":"The unit price.",
"type":"number",
"example":21.99
},
"inventoryLocationId":{
"description":"Defines the inventory location that services the referenced commerce item.",
"type":"string",
"example":"IN123"
},
"quantity":{
"description":"The quantity.",
"type":"number",
"example":1
},
"rawTotalPrice":{
"description":"The raw total price.",
"type":"number",
"example":21.99
},
"returnedQuantity":{
"description":"The returned quantity.",
"type":"number",
"example":0
},
"salePrice":{
"description":"The sale price.",
"type":"number",
"example":0
},
"detailedItemPriceInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean",
"example":false
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number",
"example":0
},
"amount":{
"type":"number",
"example":24.99
},
"quantity":{
"type":"number",
"example":1
},
"tax":{
"type":"number",
"example":0
},
"orderDiscountShare":{
"type":"number",
"example":0
},
"detailedUnitPrice":{
"type":"number",
"example":24.99
},
"currencyCode":{
"type":"string",
"example":"USD"
}
}
}
},
"dynamicProperties":{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string",
"example":"11502"
},
"label":{
"description":"The dynamic property label.",
"type":"string",
"example":"dyn_prop"
},
"value":{
"description":"The dynamic property value.",
"type":"string",
"example":"12"
}
}
}
},
"shippingSurchargeValue":{
"description":"The shipping surcharge if any.",
"type":"number",
"example":0
},
"preferredPickupDate":{
"description":"The items preferred store pickup date.",
"type":"string",
"example":"2018-05-19T13:00:00.000Z"
},
"discountAmount":{
"description":"The discount amount.",
"type":"number",
"example":0
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a third party system.",
"type":"array",
"items":{
"properties":{
"values":{
"description":"The map values associated with an externalData item.",
"type":"object",
"properties":{
"value":{
"description":"Map value defined by external system.",
"type":"string",
"example":"ExternalPropertyVal"
},
"key":{
"description":"Map key defined by external system.",
"type":"string",
"example":"ExternalPropertyKey"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string",
"example":"ExternalProp"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the third party system.",
"type":"string",
"example":"ExternalPropertyAction"
}
}
}
},
"catRefId":{
"description":"The catalog ref id.",
"type":"string",
"example":"SKu_36Fxy"
},
"externalPrice":{
"description":"Individual price of configurable item",
"type":"number"
},
"commerceItemId":{
"description":"Internal commerce item id.",
"type":"string",
"example":"ci200014"
},
"discountInfo":{
"description":"Whether this item is discounted.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"Promotion BAC"
},
"external":{
"description":"if promotion is external",
"type":"boolean",
"example":false
},
"coupon":{
"type":"string",
"example":"CPN123"
},
"promotionLevel":{
"type":"string",
"example":"item"
},
"totalAdjustment":{
"type":"string",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"promotion desc"
},
"promotionId":{
"type":"string",
"example":"PRM123"
},
"giftWithPurchaseDiscountInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"gitWithPurchaseDetail":{
"type":"string",
"example":"details of gift"
},
"gitWithPurchaseIdentifier":{
"type":"number",
"example":1223344
},
"giftWithPurchaseType":{
"description":"the gift type.For example product or sku",
"type":"string",
"example":"product"
},
"promotionDesc":{
"type":"string",
"example":"GWP Promotion description"
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
}
}
}
},
"price":{
"description":"The price.",
"type":"number",
"example":21.99
},
"childItemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding childItems property is truncated. The value for this field will be true always if present",
"type":"boolean"
},
"onSale":{
"description":"Is item on sale.",
"type":"boolean",
"example":false
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"type":"object",
"properties":{
"additionalProperties":{
"type":"string",
"example":"SkinBlonde"
}
}
},
"stateDetailsAsUser":{
"description":"state details.",
"type":"string",
"example":"Description of user"
},
"listPrice":{
"description":"The list price.",
"type":"number",
"example":21.99
},
"status":{
"description":"status.",
"type":"string",
"example":null
}
}
}
},
"email":{
"description":"The email address of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"john.muir@oracle.com"
}
}
}
},
"secondaryCurrencyCode":{
"description":"The currency code of secondary currency.",
"type":"string",
"example":"UK"
},
"secondaryCurrencyShippingAmount":{
"description":"The secondary currency shipping amount and this will be present only if it is a points based order",
"type":"number",
"example":0
},
"creationTime":{
"description":"The creation time of the order.",
"type":"number",
"example":1.532965750184E12
},
"isTaxIncluded":{
"description":"Indicates whether order is inclusive of tax.",
"type":"boolean",
"example":false
},
"orderId":{
"description":"The ID of the order.",
"type":"string",
"example":"o30429"
},
"dynamicProperties":{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string",
"example":"11502"
},
"label":{
"description":"The dynamic property label.",
"type":"string",
"example":"dyn_prop"
},
"value":{
"description":"The dynamic property value.",
"type":"string",
"example":"12"
}
}
}
},
"profile":{
"type":"object",
"properties":{
"lastName":{
"type":"string",
"example":"Muir"
},
"taxExempt":{
"description":"Indicates if user is taxExempt",
"type":"boolean",
"example":false
},
"customerContactId":{
"description":"The external customer contact id.",
"type":"string",
"example":"externalId"
},
"receiveEmail":{
"description":"The string representation of whether the user wants to receive email or not",
"type":"string",
"example":"no"
},
"locale":{
"type":"string",
"example":"en"
},
"taxExemptionCode":{
"type":"string",
"example":"TX123"
},
"sitePropertiesList":{
"description":"The list of site related properties for the profile",
"type":"array",
"items":{
"type":"object",
"properties":{
"site":{
"description":"The site data",
"type":"object",
"properties":{
"id":{
"description":"The id of the site",
"type":"string",
"example":"SiteUS"
}
}
},
"properties":{
"description":"The site related properties for the profile",
"type":"object",
"properties":{
"GDPRProfileP13nConsentDate":{
"description":"The date on which GDPR personalization consent was granted by the user.",
"type":"string",
"example":"null"
},
"GDPRProfileP13nConsentGranted":{
"description":"If user has given consent for his/her profile information to be used for personalization purposes.",
"type":"boolean",
"example":false
},
"receiveEmail":{
"description":"Indicates whether the user should receive marketing emails on the current site. Can be yes or no.",
"type":"string",
"example":"no"
},
"receiveEmailDate":{
"description":"The date on which email marketing consent was granted by the user.",
"type":"string",
"example":"2018-07-30T15:49:10.184Z"
}
}
}
}
}
},
"firstName":{
"type":"string",
"example":"John"
},
"loyaltyPrograms":{
"description":"Loyalty Programs Information",
"type":"array",
"items":{
"type":"object",
"properties":{
"programName":{
"description":"programName of Loyalty Program",
"type":"string",
"example":"Loyalty Program Demo"
},
"repositoryId":{
"description":"repository Id",
"type":"string",
"example":"123345"
},
"membershipId":{
"description":"membershipId of the profile.",
"type":"string",
"example":"MM123"
},
"programId":{
"description":"programId of Loyalty Program",
"type":"string",
"example":"LYT123"
},
"status":{
"description":"status of Enrollment.",
"type":"string",
"example":"Enrolled"
}
}
}
},
"middleName":{
"type":"string",
"example":"Morgan"
},
"id":{
"description":"Id",
"type":"string",
"example":"11169"
},
"email":{
"type":"string",
"example":"john.muir@oracle.com"
},
"daytimeTelephoneNumber":{
"description":"The day time phone number of the profile",
"type":"string",
"example":"781-781-7811"
}
}
},
"orderStatus":{
"description":"The order status.",
"type":"string",
"example":"Incomplete"
},
"creationDate":{
"description":"The order creation date.",
"type":"string",
"example":"2018-07-30T15:49:10.184Z"
},
"currencyConversionEnabled":{
"description":"Indicates whether currency conversion is enabled",
"type":"boolean",
"example":false
},
"orderProfileId":{
"description":"The profile id on the order.",
"type":"string",
"example":"111669"
},
"taxDate":{
"description":"Date when the tax has to be considered. This parameter accepts a date format of dd-MM-yyyy",
"type":"string",
"example":"04-11-2019"
},
"callType":{
"description":"The tax call type.",
"type":"string",
"example":"SalesOrder"
},
"priceInfo":{
"type":"object",
"properties":{
"amount":{
"type":"number",
"example":21.99
},
"total":{
"type":"number",
"example":21.99
},
"shipping":{
"type":"number",
"example":25
},
"shippingSurchargeValue":{
"type":"number",
"example":0
},
"tax":{
"type":"number",
"example":0
},
"subTotal":{
"type":"number",
"example":21.99
},
"currencyCode":{
"type":"string",
"example":"USD"
},
"totalWithoutTax":{
"type":"number",
"example":21.99
}
}
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number",
"example":21.99
},
"total":{
"description":"The total price of the recurring charge.",
"type":"number",
"example":21.99
},
"frequencyAmountTotals":{
"description":"The total for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string",
"example":21.99
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string",
"example":"Monthly"
}
}
}
},
"shipping":{
"description":"Cost of shipping the product.",
"type":"number",
"example":25
},
"tax":{
"description":"Monetary tax amount.",
"type":"number",
"example":0
},
"subTotal":{
"description":"The sub-total price of the recurring charge.",
"type":"number",
"example":21.99
},
"frequencyTaxTotals":{
"description":"The tax for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string",
"example":0
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string",
"example":"Monthly"
}
}
}
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string",
"example":"USD"
},
"totalWithoutTax":{
"description":"Total of recurring amount without tax included.",
"type":"number",
"example":21.99
}
}
},
"discountInfo":{
"description":"The discount information.",
"type":"object",
"properties":{
"unclaimedCouponMultiPromotions":{
"type":"object",
"properties":{
"promotionInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"long desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PRMName"
},
"promotionLevel":{
"type":"string",
"example":"order"
},
"totalAdjustment":{
"type":"number",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"description of the promotion"
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
},
"orderCouponsMap":{
"description":"The list of all the coupons with the order",
"type":"array",
"items":{
"properties":{
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions)",
"type":"boolean",
"example":false
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string",
"example":"0"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string",
"example":"promotion desc"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string",
"example":"promo123"
}
}
}
},
"orderDiscount":{
"description":"The order discount.",
"type":"number",
"example":0
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"number",
"example":5.6
},
"orderImplicitDiscountList":{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"Detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PROMO1"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions)",
"type":"boolean",
"example":true
},
"promotionLevel":{
"description":"promotion level - order or item",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string",
"example":"5.6"
},
"promotionDesc":{
"type":"string",
"example":"the order related promotion"
},
"secondaryCurrencyTotalAdjustment":{
"description":"The total adjustment for secondary currency",
"type":"string",
"example":"0"
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
},
"unclaimedCouponsMap":{
"type":"object",
"properties":{
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
},
"claimedCouponMultiPromotions":{
"type":"object",
"properties":{
"promotions":{
"type":"array",
"items":{
"type":"object",
"properties":{
"totalAdjustment":{
"type":"number",
"example":0
},
"secondaryCurrencyTotalAdjustment":{
"type":"number",
"example":0
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
}
}
},
"shipFromAddress":{
"type":"object",
"properties":{
"lastName":{
"type":"string",
"example":"Muir"
},
"country":{
"type":"string",
"example":"United States"
},
"address3":{
"type":"string",
"example":"Suite 6"
},
"address2":{
"type":"string",
"example":"2 cross"
},
"city":{
"type":"string",
"example":"Cambridge"
},
"address1":{
"type":"string",
"example":"1 main st"
},
"prefix":{
"type":"string",
"example":"Mr"
},
"companyName":{
"type":"string",
"example":"oracle"
},
"postalCode":{
"type":"string",
"example":1122
},
"jobTitle":{
"type":"string",
"example":"Manager"
},
"county":{
"type":"string",
"example":"Suffolk"
},
"suffix":{
"type":"string",
"example":"Sr"
},
"firstName":{
"type":"string",
"example":"John"
},
"phoneNumber":{
"type":"number",
"example":1231231234
},
"faxNumber":{
"type":"number",
"example":123123134
},
"middleName":{
"type":"string",
"example":"Morgan"
},
"state":{
"type":"string",
"example":"MA"
},
"email":{
"type":"string",
"example":"john.muir@oracle.com"
}
}
},
"orderCurrencyCode":{
"description":"The currency code of the order currency",
"type":"string",
"example":"USD"
},
"exchangeRate":{
"description":"The conversion rate between the order currency and base currency.",
"type":"number",
"example":0
},
"giftWithPurchaseInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"giftWithPurchaseQuantityAvailableForSelection":{
"description":"gift quantity available for selection",
"type":"number",
"example":1
},
"giftWithPurchaseType":{
"description":"The type of the gift. (sku, product)",
"type":"string",
"example":"sku"
},
"giftWithPurchaseDetail":{
"description":"String identifying the free gift, usually the repository id of the gift type.",
"type":"string",
"example":"FreePerfumeSku"
},
"promotionId":{
"description":"The gift with purchase promotion id",
"type":"string",
"example":"PROMO123"
},
"giftWithPurchaseIdentifier":{
"description":"An identifier used to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one. example: SKU_986",
"type":"number"
}
}
}
},
"shoppingCart":{
"type":"object",
"properties":{
"itemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding items property is truncated. The value for this field will always be true if present",
"type":"boolean"
},
"numberOfItems":{
"type":"number",
"example":1
},
"items":{
"description":"The array of products in the shopping cart. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook",
"type":"array",
"items":{
"type":"object",
"properties":{
"primaryThumbImageURL":{
"type":"string",
"example":"/ccstore/v1/images/product1.jpg"
},
"rawTotalPrice":{
"type":"number",
"example":21.99
},
"displayName":{
"type":"string",
"example":"The Girl with the Dragon Tattoo"
},
"dynamicProperties":{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string",
"example":"11234"
},
"label":{
"description":"The dynamic property label.",
"type":"string",
"example":"leadActor"
},
"value":{
"description":"The dynamic property value.",
"type":"string",
"example":"women"
}
}
}
},
"shippingSurchargeValue":{
"type":"number",
"example":0
},
"description":{
"type":"string",
"example":"Best movie title"
},
"discountAmount":{
"type":"number",
"example":0
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a third party system.",
"type":"array",
"items":{
"properties":{
"values":{
"description":"The map values associated with an externalData item.",
"type":"object",
"properties":{
"value":{
"description":"Map value defined by external system.",
"type":"string",
"example":"ExtVal1"
},
"key":{
"description":"Map key defined by external system.",
"type":"string",
"example":"ExtKey1"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string",
"example":"Ext1"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the third party system.",
"type":"string",
"example":"ExtAct1"
}
}
}
},
"isItemValid":{
"type":"boolean",
"example":true
},
"childItems":{
"description":"Represents the child commerce items. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook",
"type":"array",
"items":{
"type":"object",
"properties":{
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string",
"example":"configOptIDC1P11536825979556"
},
"addOnItem":{
"description":"Whether this child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean",
"example":"true"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string",
"example":"SkinBlonde"
},
"type":"object"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string",
"example":"configPropIDC1P11536825979556"
}
}
}
},
"configuratorId":{
"type":"string",
"example":"null"
},
"externalPrice":{
"type":"number",
"example":0
},
"commerceItemId":{
"description":"CommerceItem id",
"type":"string",
"example":"ci3000421"
},
"price":{
"type":"number",
"example":21.99
},
"variant":{
"description":"List of variants for the product.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value.",
"type":"string",
"example":"L"
},
"optionName":{
"description":"The variant option name.",
"type":"string",
"example":"size"
}
}
}
},
"childItemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding childItems property is truncated. The value for this field will be true always if present",
"type":"boolean"
},
"onSale":{
"type":"boolean",
"example":false
},
"id":{
"description":"Commerce id of the product",
"type":"string",
"example":"ci3000424"
},
"unitPrice":{
"type":"number",
"example":21.99
},
"amount":{
"type":"number",
"example":21.99
},
"quantity":{
"type":"number",
"example":1
},
"productId":{
"type":"string",
"example":"Product_36Exy"
},
"salePrice":{
"type":"number",
"example":0
},
"detailedItemPriceInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean",
"example":false
},
"amount":{
"type":"number",
"example":21.99
},
"quantity":{
"type":"number",
"example":1
},
"tax":{
"type":"number",
"example":0
},
"orderDiscountShare":{
"type":"number",
"example":0
},
"detailedUnitPrice":{
"type":"number",
"example":21.99
},
"currencyCode":{
"type":"string",
"example":"USD"
}
}
}
},
"giftWithPurchaseCommerceItemMarkers":{
"type":"array",
"items":{
"type":"object",
"properties":{
"selectedQuantity":{
"type":"number",
"example":0
},
"id":{
"type":"string",
"example":"gwp id"
}
}
}
},
"externalPriceQuantity":{
"type":"number",
"example":0
},
"catRefId":{
"type":"string",
"example":"Sku_36Fxy"
},
"skuProperties":{
"type":"object",
"properties":{
"propertyType":{
"type":"string",
"example":"sku-base"
},
"name":{
"type":"string",
"example":"Not Returnable"
},
"id":{
"type":"string",
"example":"nonreturnable"
},
"value":{
"type":"string",
"example":"false"
}
}
},
"discountInfo":{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"coupon":{
"description":"The coupon ID.",
"type":"string",
"example":"CPN1234"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string",
"example":"women lead promotion"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string",
"example":"PROMO123"
}
}
}
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean",
"example":false
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number",
"example":21.99
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"number",
"example":1
},
"tax":{
"description":"Monetary tax amount.",
"type":"number",
"example":0
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number",
"example":0
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number",
"example":21.99
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string",
"example":"USD"
}
}
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"type":"object",
"properties":{
"additionalProperties":{
"type":"string",
"example":"SkinBlonde"
}
}
},
"listPrice":{
"type":"number",
"example":21.99
}
}
}
}
}
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"type":"object",
"properties":{
"additionalProperties":{
"type":"string",
"example":"SkinBlonde"
}
}
}
}
}
}
}
Nested Schema : request
Type: object
Show Source
{
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"The secondary currency tax amount and this will be present only if it is a points based order",
"type":"number",
"example":0
},
"shippingGroups":{
"type":"array",
"items":{
"type":"object",
"properties":{
"lastName":{
"description":"The second name of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"Muir"
},
"firstName":{
"description":"The first name of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"John"
},
"priceInfo":{
"type":"object",
"properties":{
"amount":{
"type":"number",
"example":21.99
},
"total":{
"type":"number",
"example":21.99
},
"lkpValExcludingFreeShip":{
"type":"number",
"example":0
},
"shipping":{
"type":"number",
"example":25
},
"shippingSurchargeValue":{
"type":"number",
"example":0
},
"tax":{
"type":"number",
"example":0
},
"subTotal":{
"type":"number",
"example":21.99
},
"currencyCode":{
"type":"string",
"example":"USD"
},
"totalWithoutTax":{
"type":"number",
"example":21.99
}
}
},
"itemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding items property is truncated. The value for this field will always be true if present",
"type":"boolean"
},
"phoneNumber":{
"description":"The phone number of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"1231231234"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number",
"example":21.99
},
"total":{
"description":"The total price of the recurring charge.",
"type":"number",
"example":21.99
},
"frequencyAmountTotals":{
"description":"The total for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string",
"example":21.99
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string",
"example":"Monthly"
}
}
}
},
"shipping":{
"description":"Cost of shipping the product.",
"type":"number",
"example":25
},
"tax":{
"description":"Monetary tax amount.",
"type":"number",
"example":0
},
"subTotal":{
"description":"The sub-total price of the recurring charge.",
"type":"number",
"example":21.99
},
"frequencyTaxTotals":{
"description":"The tax for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string",
"example":0
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string",
"example":"Monthly"
}
}
}
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string",
"example":"USD"
},
"totalWithoutTax":{
"description":"Total of recurring amount without tax included.",
"type":"number",
"example":21.99
}
}
},
"discountInfo":{
"description":"The discount information.",
"type":"object",
"properties":{
"unclaimedCouponMultiPromotions":{
"type":"object",
"properties":{
"promotionInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"long desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PRMName"
},
"promotionLevel":{
"type":"string",
"example":"order"
},
"totalAdjustment":{
"type":"number",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"description of the promotion"
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
},
"orderCouponsMap":{
"description":"The list of all the coupons with the order",
"type":"array",
"items":{
"type":"object",
"properties":{
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions)",
"type":"boolean",
"example":false
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string",
"example":"0"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string",
"example":"promotion desc"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string",
"example":"promo123"
}
}
}
},
"orderDiscount":{
"description":"The order discount.",
"type":"number",
"example":0
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"number",
"example":5.6
},
"orderImplicitDiscountList":{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"Detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PROMO1"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions)",
"type":"boolean",
"example":true
},
"promotionLevel":{
"description":"promotion level - order or item",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string",
"example":"5.6"
},
"promotionDesc":{
"type":"string",
"example":"the order related promotion"
},
"secondaryCurrencyTotalAdjustment":{
"description":"The total adjustment for secondary currency",
"type":"string",
"example":"0"
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
},
"unclaimedCouponsMap":{
"type":"object",
"properties":{
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
},
"claimedCouponMultiPromotions":{
"type":"object",
"properties":{
"promotions":{
"type":"array",
"items":{
"type":"object",
"properties":{
"totalAdjustment":{
"type":"number",
"example":0
},
"secondaryCurrencyTotalAdjustment":{
"type":"number",
"example":0
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
}
}
},
"shippingMethod":{
"description":"The shipping method details for the order.",
"type":"object",
"properties":{
"shippingTax":{
"description":"The shipping tax.",
"type":"number",
"example":0
},
"cost":{
"description":"The cost of shipping.",
"type":"number",
"example":25
},
"taxCode":{
"description":"The tax code for shipping method.",
"type":"string",
"example":"TX123"
},
"value":{
"description":"The shipping method .",
"type":"string",
"example":"TwoDay"
},
"shippingMethodDescription":{
"description":"The shipping method description.",
"type":"string",
"example":"Two day shipping"
}
}
},
"shippingGroupId":{
"description":"The shipping group id.",
"type":"string",
"example":"sg123"
},
"shippingAddress":{
"type":"object",
"properties":{
"lastName":{
"type":"string",
"example":"Muir"
},
"country":{
"type":"string",
"example":"United States"
},
"address3":{
"type":"string",
"example":"Suite 6"
},
"address2":{
"type":"string",
"example":"2 cross"
},
"city":{
"type":"string",
"example":"Boston"
},
"address1":{
"type":"string",
"example":"1 main st"
},
"prefix":{
"type":"string",
"example":"Mr"
},
"companyName":{
"type":"string",
"example":"Oracle"
},
"postalCode":{
"type":"string",
"example":12345
},
"jobTitle":{
"type":"string",
"example":"Manager"
},
"county":{
"type":"string",
"example":"Suffolk"
},
"suffix":{
"type":"string",
"example":"Sr"
},
"firstName":{
"type":"string",
"example":"John"
},
"phoneNumber":{
"type":"number",
"example":1231231234
},
"faxNumber":{
"type":"number",
"example":1231231234
},
"middleName":{
"type":"string",
"example":"Morgan"
},
"state":{
"type":"string",
"example":"MA"
},
"email":{
"type":"string",
"example":"john.muir@oracle.com"
}
}
},
"items":{
"type":"array",
"items":{
"type":"object",
"properties":{
"availablePickupDate":{
"description":"The items available store pickup date.",
"type":"string",
"example":"2018-05-19T13:00:00.000Z"
},
"unitPrice":{
"description":"The unit price.",
"type":"number",
"example":21.99
},
"inventoryLocationId":{
"description":"Defines the inventory location that services the referenced commerce item.",
"type":"string",
"example":"IN123"
},
"quantity":{
"description":"The quantity.",
"type":"number",
"example":1
},
"rawTotalPrice":{
"description":"The raw total price.",
"type":"number",
"example":21.99
},
"returnedQuantity":{
"description":"The returned quantity.",
"type":"number",
"example":0
},
"salePrice":{
"description":"The sale price.",
"type":"number",
"example":0
},
"detailedItemPriceInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean",
"example":false
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number",
"example":0
},
"amount":{
"type":"number",
"example":24.99
},
"quantity":{
"type":"number",
"example":1
},
"tax":{
"type":"number",
"example":0
},
"orderDiscountShare":{
"type":"number",
"example":0
},
"detailedUnitPrice":{
"type":"number",
"example":24.99
},
"currencyCode":{
"type":"string",
"example":"USD"
}
}
}
},
"dynamicProperties":{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string",
"example":"11502"
},
"label":{
"description":"The dynamic property label.",
"type":"string",
"example":"dyn_prop"
},
"value":{
"description":"The dynamic property value.",
"type":"string",
"example":"12"
}
}
}
},
"shippingSurchargeValue":{
"description":"The shipping surcharge if any.",
"type":"number",
"example":0
},
"preferredPickupDate":{
"description":"The items preferred store pickup date.",
"type":"string",
"example":"2018-05-19T13:00:00.000Z"
},
"discountAmount":{
"description":"The discount amount.",
"type":"number",
"example":0
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a third party system.",
"type":"array",
"items":{
"properties":{
"values":{
"description":"The map values associated with an externalData item.",
"type":"object",
"properties":{
"value":{
"description":"Map value defined by external system.",
"type":"string",
"example":"ExternalPropertyVal"
},
"key":{
"description":"Map key defined by external system.",
"type":"string",
"example":"ExternalPropertyKey"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string",
"example":"ExternalProp"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the third party system.",
"type":"string",
"example":"ExternalPropertyAction"
}
}
}
},
"catRefId":{
"description":"The catalog ref id.",
"type":"string",
"example":"SKu_36Fxy"
},
"externalPrice":{
"description":"Individual price of configurable item",
"type":"number"
},
"commerceItemId":{
"description":"Internal commerce item id.",
"type":"string",
"example":"ci200014"
},
"discountInfo":{
"description":"Whether this item is discounted.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"Promotion BAC"
},
"external":{
"description":"if promotion is external",
"type":"boolean",
"example":false
},
"coupon":{
"type":"string",
"example":"CPN123"
},
"promotionLevel":{
"type":"string",
"example":"item"
},
"totalAdjustment":{
"type":"string",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"promotion desc"
},
"promotionId":{
"type":"string",
"example":"PRM123"
},
"giftWithPurchaseDiscountInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"gitWithPurchaseDetail":{
"type":"string",
"example":"details of gift"
},
"gitWithPurchaseIdentifier":{
"type":"number",
"example":1223344
},
"giftWithPurchaseType":{
"description":"the gift type.For example product or sku",
"type":"string",
"example":"product"
},
"promotionDesc":{
"type":"string",
"example":"GWP Promotion description"
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
}
}
}
},
"price":{
"description":"The price.",
"type":"number",
"example":21.99
},
"childItemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding childItems property is truncated. The value for this field will be true always if present",
"type":"boolean"
},
"onSale":{
"description":"Is item on sale.",
"type":"boolean",
"example":false
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"type":"object",
"properties":{
"additionalProperties":{
"type":"string",
"example":"SkinBlonde"
}
}
},
"stateDetailsAsUser":{
"description":"state details.",
"type":"string",
"example":"Description of user"
},
"listPrice":{
"description":"The list price.",
"type":"number",
"example":21.99
},
"status":{
"description":"status.",
"type":"string",
"example":null
}
}
}
},
"email":{
"description":"The email address of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"john.muir@oracle.com"
}
}
}
},
"secondaryCurrencyCode":{
"description":"The currency code of secondary currency.",
"type":"string",
"example":"UK"
},
"secondaryCurrencyShippingAmount":{
"description":"The secondary currency shipping amount and this will be present only if it is a points based order",
"type":"number",
"example":0
},
"creationTime":{
"description":"The creation time of the order.",
"type":"number",
"example":1.532965750184E12
},
"isTaxIncluded":{
"description":"Indicates whether order is inclusive of tax.",
"type":"boolean",
"example":false
},
"orderId":{
"description":"The ID of the order.",
"type":"string",
"example":"o30429"
},
"dynamicProperties":{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string",
"example":"11502"
},
"label":{
"description":"The dynamic property label.",
"type":"string",
"example":"dyn_prop"
},
"value":{
"description":"The dynamic property value.",
"type":"string",
"example":"12"
}
}
}
},
"profile":{
"type":"object",
"properties":{
"lastName":{
"type":"string",
"example":"Muir"
},
"taxExempt":{
"description":"Indicates if user is taxExempt",
"type":"boolean",
"example":false
},
"customerContactId":{
"description":"The external customer contact id.",
"type":"string",
"example":"externalId"
},
"receiveEmail":{
"description":"The string representation of whether the user wants to receive email or not",
"type":"string",
"example":"no"
},
"locale":{
"type":"string",
"example":"en"
},
"taxExemptionCode":{
"type":"string",
"example":"TX123"
},
"sitePropertiesList":{
"description":"The list of site related properties for the profile",
"type":"array",
"items":{
"type":"object",
"properties":{
"site":{
"description":"The site data",
"type":"object",
"properties":{
"id":{
"description":"The id of the site",
"type":"string",
"example":"SiteUS"
}
}
},
"properties":{
"description":"The site related properties for the profile",
"type":"object",
"properties":{
"GDPRProfileP13nConsentDate":{
"description":"The date on which GDPR personalization consent was granted by the user.",
"type":"string",
"example":"null"
},
"GDPRProfileP13nConsentGranted":{
"description":"If user has given consent for his/her profile information to be used for personalization purposes.",
"type":"boolean",
"example":false
},
"receiveEmail":{
"description":"Indicates whether the user should receive marketing emails on the current site. Can be yes or no.",
"type":"string",
"example":"no"
},
"receiveEmailDate":{
"description":"The date on which email marketing consent was granted by the user.",
"type":"string",
"example":"2018-07-30T15:49:10.184Z"
}
}
}
}
}
},
"firstName":{
"type":"string",
"example":"John"
},
"loyaltyPrograms":{
"description":"Loyalty Programs Information",
"type":"array",
"items":{
"type":"object",
"properties":{
"programName":{
"description":"programName of Loyalty Program",
"type":"string",
"example":"Loyalty Program Demo"
},
"repositoryId":{
"description":"repository Id",
"type":"string",
"example":"123345"
},
"membershipId":{
"description":"membershipId of the profile.",
"type":"string",
"example":"MM123"
},
"programId":{
"description":"programId of Loyalty Program",
"type":"string",
"example":"LYT123"
},
"status":{
"description":"status of Enrollment.",
"type":"string",
"example":"Enrolled"
}
}
}
},
"middleName":{
"type":"string",
"example":"Morgan"
},
"id":{
"description":"Id",
"type":"string",
"example":"11169"
},
"email":{
"type":"string",
"example":"john.muir@oracle.com"
},
"daytimeTelephoneNumber":{
"description":"The day time phone number of the profile",
"type":"string",
"example":"781-781-7811"
}
}
},
"orderStatus":{
"description":"The order status.",
"type":"string",
"example":"Incomplete"
},
"creationDate":{
"description":"The order creation date.",
"type":"string",
"example":"2018-07-30T15:49:10.184Z"
},
"currencyConversionEnabled":{
"description":"Indicates whether currency conversion is enabled",
"type":"boolean",
"example":false
},
"orderProfileId":{
"description":"The profile id on the order.",
"type":"string",
"example":"111669"
},
"taxDate":{
"description":"Date when the tax has to be considered. This parameter accepts a date format of dd-MM-yyyy",
"type":"string",
"example":"04-11-2019"
},
"callType":{
"description":"The tax call type.",
"type":"string",
"example":"SalesOrder"
},
"priceInfo":{
"type":"object",
"properties":{
"amount":{
"type":"number",
"example":21.99
},
"total":{
"type":"number",
"example":21.99
},
"shipping":{
"type":"number",
"example":25
},
"shippingSurchargeValue":{
"type":"number",
"example":0
},
"tax":{
"type":"number",
"example":0
},
"subTotal":{
"type":"number",
"example":21.99
},
"currencyCode":{
"type":"string",
"example":"USD"
},
"totalWithoutTax":{
"type":"number",
"example":21.99
}
}
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number",
"example":21.99
},
"total":{
"description":"The total price of the recurring charge.",
"type":"number",
"example":21.99
},
"frequencyAmountTotals":{
"description":"The total for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string",
"example":21.99
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string",
"example":"Monthly"
}
}
}
},
"shipping":{
"description":"Cost of shipping the product.",
"type":"number",
"example":25
},
"tax":{
"description":"Monetary tax amount.",
"type":"number",
"example":0
},
"subTotal":{
"description":"The sub-total price of the recurring charge.",
"type":"number",
"example":21.99
},
"frequencyTaxTotals":{
"description":"The tax for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string",
"example":0
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string",
"example":"Monthly"
}
}
}
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string",
"example":"USD"
},
"totalWithoutTax":{
"description":"Total of recurring amount without tax included.",
"type":"number",
"example":21.99
}
}
},
"discountInfo":{
"description":"The discount information.",
"type":"object",
"properties":{
"unclaimedCouponMultiPromotions":{
"type":"object",
"properties":{
"promotionInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"long desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PRMName"
},
"promotionLevel":{
"type":"string",
"example":"order"
},
"totalAdjustment":{
"type":"number",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"description of the promotion"
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
},
"orderCouponsMap":{
"description":"The list of all the coupons with the order",
"type":"array",
"items":{
"properties":{
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions)",
"type":"boolean",
"example":false
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string",
"example":"0"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string",
"example":"promotion desc"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string",
"example":"promo123"
}
}
}
},
"orderDiscount":{
"description":"The order discount.",
"type":"number",
"example":0
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"number",
"example":5.6
},
"orderImplicitDiscountList":{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"Detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PROMO1"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions)",
"type":"boolean",
"example":true
},
"promotionLevel":{
"description":"promotion level - order or item",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string",
"example":"5.6"
},
"promotionDesc":{
"type":"string",
"example":"the order related promotion"
},
"secondaryCurrencyTotalAdjustment":{
"description":"The total adjustment for secondary currency",
"type":"string",
"example":"0"
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
},
"unclaimedCouponsMap":{
"type":"object",
"properties":{
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
},
"claimedCouponMultiPromotions":{
"type":"object",
"properties":{
"promotions":{
"type":"array",
"items":{
"type":"object",
"properties":{
"totalAdjustment":{
"type":"number",
"example":0
},
"secondaryCurrencyTotalAdjustment":{
"type":"number",
"example":0
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
}
}
},
"shipFromAddress":{
"type":"object",
"properties":{
"lastName":{
"type":"string",
"example":"Muir"
},
"country":{
"type":"string",
"example":"United States"
},
"address3":{
"type":"string",
"example":"Suite 6"
},
"address2":{
"type":"string",
"example":"2 cross"
},
"city":{
"type":"string",
"example":"Cambridge"
},
"address1":{
"type":"string",
"example":"1 main st"
},
"prefix":{
"type":"string",
"example":"Mr"
},
"companyName":{
"type":"string",
"example":"oracle"
},
"postalCode":{
"type":"string",
"example":1122
},
"jobTitle":{
"type":"string",
"example":"Manager"
},
"county":{
"type":"string",
"example":"Suffolk"
},
"suffix":{
"type":"string",
"example":"Sr"
},
"firstName":{
"type":"string",
"example":"John"
},
"phoneNumber":{
"type":"number",
"example":1231231234
},
"faxNumber":{
"type":"number",
"example":123123134
},
"middleName":{
"type":"string",
"example":"Morgan"
},
"state":{
"type":"string",
"example":"MA"
},
"email":{
"type":"string",
"example":"john.muir@oracle.com"
}
}
},
"orderCurrencyCode":{
"description":"The currency code of the order currency",
"type":"string",
"example":"USD"
},
"exchangeRate":{
"description":"The conversion rate between the order currency and base currency.",
"type":"number",
"example":0
},
"giftWithPurchaseInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"giftWithPurchaseQuantityAvailableForSelection":{
"description":"gift quantity available for selection",
"type":"number",
"example":1
},
"giftWithPurchaseType":{
"description":"The type of the gift. (sku, product)",
"type":"string",
"example":"sku"
},
"giftWithPurchaseDetail":{
"description":"String identifying the free gift, usually the repository id of the gift type.",
"type":"string",
"example":"FreePerfumeSku"
},
"promotionId":{
"description":"The gift with purchase promotion id",
"type":"string",
"example":"PROMO123"
},
"giftWithPurchaseIdentifier":{
"description":"An identifier used to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one. example: SKU_986",
"type":"number"
}
}
}
},
"shoppingCart":{
"type":"object",
"properties":{
"itemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding items property is truncated. The value for this field will always be true if present",
"type":"boolean"
},
"numberOfItems":{
"type":"number",
"example":1
},
"items":{
"description":"The array of products in the shopping cart. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook",
"type":"array",
"items":{
"type":"object",
"properties":{
"primaryThumbImageURL":{
"type":"string",
"example":"/ccstore/v1/images/product1.jpg"
},
"rawTotalPrice":{
"type":"number",
"example":21.99
},
"displayName":{
"type":"string",
"example":"The Girl with the Dragon Tattoo"
},
"dynamicProperties":{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string",
"example":"11234"
},
"label":{
"description":"The dynamic property label.",
"type":"string",
"example":"leadActor"
},
"value":{
"description":"The dynamic property value.",
"type":"string",
"example":"women"
}
}
}
},
"shippingSurchargeValue":{
"type":"number",
"example":0
},
"description":{
"type":"string",
"example":"Best movie title"
},
"discountAmount":{
"type":"number",
"example":0
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a third party system.",
"type":"array",
"items":{
"properties":{
"values":{
"description":"The map values associated with an externalData item.",
"type":"object",
"properties":{
"value":{
"description":"Map value defined by external system.",
"type":"string",
"example":"ExtVal1"
},
"key":{
"description":"Map key defined by external system.",
"type":"string",
"example":"ExtKey1"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string",
"example":"Ext1"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the third party system.",
"type":"string",
"example":"ExtAct1"
}
}
}
},
"isItemValid":{
"type":"boolean",
"example":true
},
"childItems":{
"description":"Represents the child commerce items. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook",
"type":"array",
"items":{
"type":"object",
"properties":{
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string",
"example":"configOptIDC1P11536825979556"
},
"addOnItem":{
"description":"Whether this child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean",
"example":"true"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string",
"example":"SkinBlonde"
},
"type":"object"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string",
"example":"configPropIDC1P11536825979556"
}
}
}
},
"configuratorId":{
"type":"string",
"example":"null"
},
"externalPrice":{
"type":"number",
"example":0
},
"commerceItemId":{
"description":"CommerceItem id",
"type":"string",
"example":"ci3000421"
},
"price":{
"type":"number",
"example":21.99
},
"variant":{
"description":"List of variants for the product.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value.",
"type":"string",
"example":"L"
},
"optionName":{
"description":"The variant option name.",
"type":"string",
"example":"size"
}
}
}
},
"childItemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding childItems property is truncated. The value for this field will be true always if present",
"type":"boolean"
},
"onSale":{
"type":"boolean",
"example":false
},
"id":{
"description":"Commerce id of the product",
"type":"string",
"example":"ci3000424"
},
"unitPrice":{
"type":"number",
"example":21.99
},
"amount":{
"type":"number",
"example":21.99
},
"quantity":{
"type":"number",
"example":1
},
"productId":{
"type":"string",
"example":"Product_36Exy"
},
"salePrice":{
"type":"number",
"example":0
},
"detailedItemPriceInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean",
"example":false
},
"amount":{
"type":"number",
"example":21.99
},
"quantity":{
"type":"number",
"example":1
},
"tax":{
"type":"number",
"example":0
},
"orderDiscountShare":{
"type":"number",
"example":0
},
"detailedUnitPrice":{
"type":"number",
"example":21.99
},
"currencyCode":{
"type":"string",
"example":"USD"
}
}
}
},
"giftWithPurchaseCommerceItemMarkers":{
"type":"array",
"items":{
"type":"object",
"properties":{
"selectedQuantity":{
"type":"number",
"example":0
},
"id":{
"type":"string",
"example":"gwp id"
}
}
}
},
"externalPriceQuantity":{
"type":"number",
"example":0
},
"catRefId":{
"type":"string",
"example":"Sku_36Fxy"
},
"skuProperties":{
"type":"object",
"properties":{
"propertyType":{
"type":"string",
"example":"sku-base"
},
"name":{
"type":"string",
"example":"Not Returnable"
},
"id":{
"type":"string",
"example":"nonreturnable"
},
"value":{
"type":"string",
"example":"false"
}
}
},
"discountInfo":{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"coupon":{
"description":"The coupon ID.",
"type":"string",
"example":"CPN1234"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string",
"example":"women lead promotion"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string",
"example":"PROMO123"
}
}
}
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean",
"example":false
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number",
"example":21.99
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"number",
"example":1
},
"tax":{
"description":"Monetary tax amount.",
"type":"number",
"example":0
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number",
"example":0
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number",
"example":21.99
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string",
"example":"USD"
}
}
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"type":"object",
"properties":{
"additionalProperties":{
"type":"string",
"example":"SkinBlonde"
}
}
},
"listPrice":{
"type":"number",
"example":21.99
}
}
}
}
}
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"type":"object",
"properties":{
"additionalProperties":{
"type":"string",
"example":"SkinBlonde"
}
}
}
}
}
Nested Schema : discountInfo
Type: object
The discount information.
Show Source
{
"description":"The discount information.",
"type":"object",
"properties":{
"unclaimedCouponMultiPromotions":{
"type":"object",
"properties":{
"promotionInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"long desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PRMName"
},
"promotionLevel":{
"type":"string",
"example":"order"
},
"totalAdjustment":{
"type":"number",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"description of the promotion"
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
},
"orderCouponsMap":{
"description":"The list of all the coupons with the order",
"type":"array",
"items":{
"properties":{
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions)",
"type":"boolean",
"example":false
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string",
"example":"0"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string",
"example":"promotion desc"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string",
"example":"promo123"
}
}
}
},
"orderDiscount":{
"description":"The order discount.",
"type":"number",
"example":0
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"number",
"example":5.6
},
"orderImplicitDiscountList":{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"Detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PROMO1"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions)",
"type":"boolean",
"example":true
},
"promotionLevel":{
"description":"promotion level - order or item",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string",
"example":"5.6"
},
"promotionDesc":{
"type":"string",
"example":"the order related promotion"
},
"secondaryCurrencyTotalAdjustment":{
"description":"The total adjustment for secondary currency",
"type":"string",
"example":"0"
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
},
"unclaimedCouponsMap":{
"type":"object",
"properties":{
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
},
"claimedCouponMultiPromotions":{
"type":"object",
"properties":{
"promotions":{
"type":"array",
"items":{
"type":"object",
"properties":{
"totalAdjustment":{
"type":"number",
"example":0
},
"secondaryCurrencyTotalAdjustment":{
"type":"number",
"example":0
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
}
}
}
Nested Schema : dynamicProperties
Type: array
List of dynamic properties at line item level.
Show Source
{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string",
"example":"11502"
},
"label":{
"description":"The dynamic property label.",
"type":"string",
"example":"dyn_prop"
},
"value":{
"description":"The dynamic property value.",
"type":"string",
"example":"12"
}
}
}
}
Nested Schema : giftWithPurchaseInfo
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"giftWithPurchaseQuantityAvailableForSelection":{
"description":"gift quantity available for selection",
"type":"number",
"example":1
},
"giftWithPurchaseType":{
"description":"The type of the gift. (sku, product)",
"type":"string",
"example":"sku"
},
"giftWithPurchaseDetail":{
"description":"String identifying the free gift, usually the repository id of the gift type.",
"type":"string",
"example":"FreePerfumeSku"
},
"promotionId":{
"description":"The gift with purchase promotion id",
"type":"string",
"example":"PROMO123"
},
"giftWithPurchaseIdentifier":{
"description":"An identifier used to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one. example: SKU_986",
"type":"number"
}
}
}
}
Nested Schema : priceInfo
Type: object
Show Source
{
"type":"object",
"properties":{
"amount":{
"type":"number",
"example":21.99
},
"total":{
"type":"number",
"example":21.99
},
"shipping":{
"type":"number",
"example":25
},
"shippingSurchargeValue":{
"type":"number",
"example":0
},
"tax":{
"type":"number",
"example":0
},
"subTotal":{
"type":"number",
"example":21.99
},
"currencyCode":{
"type":"string",
"example":"USD"
},
"totalWithoutTax":{
"type":"number",
"example":21.99
}
}
}
Nested Schema : profile
Type: object
Show Source
{
"type":"object",
"properties":{
"lastName":{
"type":"string",
"example":"Muir"
},
"taxExempt":{
"description":"Indicates if user is taxExempt",
"type":"boolean",
"example":false
},
"customerContactId":{
"description":"The external customer contact id.",
"type":"string",
"example":"externalId"
},
"receiveEmail":{
"description":"The string representation of whether the user wants to receive email or not",
"type":"string",
"example":"no"
},
"locale":{
"type":"string",
"example":"en"
},
"taxExemptionCode":{
"type":"string",
"example":"TX123"
},
"sitePropertiesList":{
"description":"The list of site related properties for the profile",
"type":"array",
"items":{
"type":"object",
"properties":{
"site":{
"description":"The site data",
"type":"object",
"properties":{
"id":{
"description":"The id of the site",
"type":"string",
"example":"SiteUS"
}
}
},
"properties":{
"description":"The site related properties for the profile",
"type":"object",
"properties":{
"GDPRProfileP13nConsentDate":{
"description":"The date on which GDPR personalization consent was granted by the user.",
"type":"string",
"example":"null"
},
"GDPRProfileP13nConsentGranted":{
"description":"If user has given consent for his/her profile information to be used for personalization purposes.",
"type":"boolean",
"example":false
},
"receiveEmail":{
"description":"Indicates whether the user should receive marketing emails on the current site. Can be yes or no.",
"type":"string",
"example":"no"
},
"receiveEmailDate":{
"description":"The date on which email marketing consent was granted by the user.",
"type":"string",
"example":"2018-07-30T15:49:10.184Z"
}
}
}
}
}
},
"firstName":{
"type":"string",
"example":"John"
},
"loyaltyPrograms":{
"description":"Loyalty Programs Information",
"type":"array",
"items":{
"type":"object",
"properties":{
"programName":{
"description":"programName of Loyalty Program",
"type":"string",
"example":"Loyalty Program Demo"
},
"repositoryId":{
"description":"repository Id",
"type":"string",
"example":"123345"
},
"membershipId":{
"description":"membershipId of the profile.",
"type":"string",
"example":"MM123"
},
"programId":{
"description":"programId of Loyalty Program",
"type":"string",
"example":"LYT123"
},
"status":{
"description":"status of Enrollment.",
"type":"string",
"example":"Enrolled"
}
}
}
},
"middleName":{
"type":"string",
"example":"Morgan"
},
"id":{
"description":"Id",
"type":"string",
"example":"11169"
},
"email":{
"type":"string",
"example":"john.muir@oracle.com"
},
"daytimeTelephoneNumber":{
"description":"The day time phone number of the profile",
"type":"string",
"example":"781-781-7811"
}
}
}
Nested Schema : recurringChargePriceInfo
Type: object
Recurring charge price information.
Show Source
{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number",
"example":21.99
},
"total":{
"description":"The total price of the recurring charge.",
"type":"number",
"example":21.99
},
"frequencyAmountTotals":{
"description":"The total for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string",
"example":21.99
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string",
"example":"Monthly"
}
}
}
},
"shipping":{
"description":"Cost of shipping the product.",
"type":"number",
"example":25
},
"tax":{
"description":"Monetary tax amount.",
"type":"number",
"example":0
},
"subTotal":{
"description":"The sub-total price of the recurring charge.",
"type":"number",
"example":21.99
},
"frequencyTaxTotals":{
"description":"The tax for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string",
"example":0
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string",
"example":"Monthly"
}
}
}
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string",
"example":"USD"
},
"totalWithoutTax":{
"description":"Total of recurring amount without tax included.",
"type":"number",
"example":21.99
}
}
}
Nested Schema : shipFromAddress
Type: object
Show Source
{
"type":"object",
"properties":{
"lastName":{
"type":"string",
"example":"Muir"
},
"country":{
"type":"string",
"example":"United States"
},
"address3":{
"type":"string",
"example":"Suite 6"
},
"address2":{
"type":"string",
"example":"2 cross"
},
"city":{
"type":"string",
"example":"Cambridge"
},
"address1":{
"type":"string",
"example":"1 main st"
},
"prefix":{
"type":"string",
"example":"Mr"
},
"companyName":{
"type":"string",
"example":"oracle"
},
"postalCode":{
"type":"string",
"example":1122
},
"jobTitle":{
"type":"string",
"example":"Manager"
},
"county":{
"type":"string",
"example":"Suffolk"
},
"suffix":{
"type":"string",
"example":"Sr"
},
"firstName":{
"type":"string",
"example":"John"
},
"phoneNumber":{
"type":"number",
"example":1231231234
},
"faxNumber":{
"type":"number",
"example":123123134
},
"middleName":{
"type":"string",
"example":"Morgan"
},
"state":{
"type":"string",
"example":"MA"
},
"email":{
"type":"string",
"example":"john.muir@oracle.com"
}
}
}
Nested Schema : shippingGroups
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"lastName":{
"description":"The second name of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"Muir"
},
"firstName":{
"description":"The first name of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"John"
},
"priceInfo":{
"type":"object",
"properties":{
"amount":{
"type":"number",
"example":21.99
},
"total":{
"type":"number",
"example":21.99
},
"lkpValExcludingFreeShip":{
"type":"number",
"example":0
},
"shipping":{
"type":"number",
"example":25
},
"shippingSurchargeValue":{
"type":"number",
"example":0
},
"tax":{
"type":"number",
"example":0
},
"subTotal":{
"type":"number",
"example":21.99
},
"currencyCode":{
"type":"string",
"example":"USD"
},
"totalWithoutTax":{
"type":"number",
"example":21.99
}
}
},
"itemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding items property is truncated. The value for this field will always be true if present",
"type":"boolean"
},
"phoneNumber":{
"description":"The phone number of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"1231231234"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number",
"example":21.99
},
"total":{
"description":"The total price of the recurring charge.",
"type":"number",
"example":21.99
},
"frequencyAmountTotals":{
"description":"The total for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string",
"example":21.99
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string",
"example":"Monthly"
}
}
}
},
"shipping":{
"description":"Cost of shipping the product.",
"type":"number",
"example":25
},
"tax":{
"description":"Monetary tax amount.",
"type":"number",
"example":0
},
"subTotal":{
"description":"The sub-total price of the recurring charge.",
"type":"number",
"example":21.99
},
"frequencyTaxTotals":{
"description":"The tax for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string",
"example":0
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string",
"example":"Monthly"
}
}
}
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string",
"example":"USD"
},
"totalWithoutTax":{
"description":"Total of recurring amount without tax included.",
"type":"number",
"example":21.99
}
}
},
"discountInfo":{
"description":"The discount information.",
"type":"object",
"properties":{
"unclaimedCouponMultiPromotions":{
"type":"object",
"properties":{
"promotionInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"long desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PRMName"
},
"promotionLevel":{
"type":"string",
"example":"order"
},
"totalAdjustment":{
"type":"number",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"description of the promotion"
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
},
"orderCouponsMap":{
"description":"The list of all the coupons with the order",
"type":"array",
"items":{
"type":"object",
"properties":{
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions)",
"type":"boolean",
"example":false
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string",
"example":"0"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string",
"example":"promotion desc"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string",
"example":"promo123"
}
}
}
},
"orderDiscount":{
"description":"The order discount.",
"type":"number",
"example":0
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"number",
"example":5.6
},
"orderImplicitDiscountList":{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"Detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PROMO1"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions)",
"type":"boolean",
"example":true
},
"promotionLevel":{
"description":"promotion level - order or item",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string",
"example":"5.6"
},
"promotionDesc":{
"type":"string",
"example":"the order related promotion"
},
"secondaryCurrencyTotalAdjustment":{
"description":"The total adjustment for secondary currency",
"type":"string",
"example":"0"
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
},
"unclaimedCouponsMap":{
"type":"object",
"properties":{
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
},
"claimedCouponMultiPromotions":{
"type":"object",
"properties":{
"promotions":{
"type":"array",
"items":{
"type":"object",
"properties":{
"totalAdjustment":{
"type":"number",
"example":0
},
"secondaryCurrencyTotalAdjustment":{
"type":"number",
"example":0
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
}
}
},
"shippingMethod":{
"description":"The shipping method details for the order.",
"type":"object",
"properties":{
"shippingTax":{
"description":"The shipping tax.",
"type":"number",
"example":0
},
"cost":{
"description":"The cost of shipping.",
"type":"number",
"example":25
},
"taxCode":{
"description":"The tax code for shipping method.",
"type":"string",
"example":"TX123"
},
"value":{
"description":"The shipping method .",
"type":"string",
"example":"TwoDay"
},
"shippingMethodDescription":{
"description":"The shipping method description.",
"type":"string",
"example":"Two day shipping"
}
}
},
"shippingGroupId":{
"description":"The shipping group id.",
"type":"string",
"example":"sg123"
},
"shippingAddress":{
"type":"object",
"properties":{
"lastName":{
"type":"string",
"example":"Muir"
},
"country":{
"type":"string",
"example":"United States"
},
"address3":{
"type":"string",
"example":"Suite 6"
},
"address2":{
"type":"string",
"example":"2 cross"
},
"city":{
"type":"string",
"example":"Boston"
},
"address1":{
"type":"string",
"example":"1 main st"
},
"prefix":{
"type":"string",
"example":"Mr"
},
"companyName":{
"type":"string",
"example":"Oracle"
},
"postalCode":{
"type":"string",
"example":12345
},
"jobTitle":{
"type":"string",
"example":"Manager"
},
"county":{
"type":"string",
"example":"Suffolk"
},
"suffix":{
"type":"string",
"example":"Sr"
},
"firstName":{
"type":"string",
"example":"John"
},
"phoneNumber":{
"type":"number",
"example":1231231234
},
"faxNumber":{
"type":"number",
"example":1231231234
},
"middleName":{
"type":"string",
"example":"Morgan"
},
"state":{
"type":"string",
"example":"MA"
},
"email":{
"type":"string",
"example":"john.muir@oracle.com"
}
}
},
"items":{
"type":"array",
"items":{
"type":"object",
"properties":{
"availablePickupDate":{
"description":"The items available store pickup date.",
"type":"string",
"example":"2018-05-19T13:00:00.000Z"
},
"unitPrice":{
"description":"The unit price.",
"type":"number",
"example":21.99
},
"inventoryLocationId":{
"description":"Defines the inventory location that services the referenced commerce item.",
"type":"string",
"example":"IN123"
},
"quantity":{
"description":"The quantity.",
"type":"number",
"example":1
},
"rawTotalPrice":{
"description":"The raw total price.",
"type":"number",
"example":21.99
},
"returnedQuantity":{
"description":"The returned quantity.",
"type":"number",
"example":0
},
"salePrice":{
"description":"The sale price.",
"type":"number",
"example":0
},
"detailedItemPriceInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean",
"example":false
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number",
"example":0
},
"amount":{
"type":"number",
"example":24.99
},
"quantity":{
"type":"number",
"example":1
},
"tax":{
"type":"number",
"example":0
},
"orderDiscountShare":{
"type":"number",
"example":0
},
"detailedUnitPrice":{
"type":"number",
"example":24.99
},
"currencyCode":{
"type":"string",
"example":"USD"
}
}
}
},
"dynamicProperties":{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string",
"example":"11502"
},
"label":{
"description":"The dynamic property label.",
"type":"string",
"example":"dyn_prop"
},
"value":{
"description":"The dynamic property value.",
"type":"string",
"example":"12"
}
}
}
},
"shippingSurchargeValue":{
"description":"The shipping surcharge if any.",
"type":"number",
"example":0
},
"preferredPickupDate":{
"description":"The items preferred store pickup date.",
"type":"string",
"example":"2018-05-19T13:00:00.000Z"
},
"discountAmount":{
"description":"The discount amount.",
"type":"number",
"example":0
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a third party system.",
"type":"array",
"items":{
"properties":{
"values":{
"description":"The map values associated with an externalData item.",
"type":"object",
"properties":{
"value":{
"description":"Map value defined by external system.",
"type":"string",
"example":"ExternalPropertyVal"
},
"key":{
"description":"Map key defined by external system.",
"type":"string",
"example":"ExternalPropertyKey"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string",
"example":"ExternalProp"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the third party system.",
"type":"string",
"example":"ExternalPropertyAction"
}
}
}
},
"catRefId":{
"description":"The catalog ref id.",
"type":"string",
"example":"SKu_36Fxy"
},
"externalPrice":{
"description":"Individual price of configurable item",
"type":"number"
},
"commerceItemId":{
"description":"Internal commerce item id.",
"type":"string",
"example":"ci200014"
},
"discountInfo":{
"description":"Whether this item is discounted.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"Promotion BAC"
},
"external":{
"description":"if promotion is external",
"type":"boolean",
"example":false
},
"coupon":{
"type":"string",
"example":"CPN123"
},
"promotionLevel":{
"type":"string",
"example":"item"
},
"totalAdjustment":{
"type":"string",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"promotion desc"
},
"promotionId":{
"type":"string",
"example":"PRM123"
},
"giftWithPurchaseDiscountInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"gitWithPurchaseDetail":{
"type":"string",
"example":"details of gift"
},
"gitWithPurchaseIdentifier":{
"type":"number",
"example":1223344
},
"giftWithPurchaseType":{
"description":"the gift type.For example product or sku",
"type":"string",
"example":"product"
},
"promotionDesc":{
"type":"string",
"example":"GWP Promotion description"
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
}
}
}
},
"price":{
"description":"The price.",
"type":"number",
"example":21.99
},
"childItemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding childItems property is truncated. The value for this field will be true always if present",
"type":"boolean"
},
"onSale":{
"description":"Is item on sale.",
"type":"boolean",
"example":false
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"type":"object",
"properties":{
"additionalProperties":{
"type":"string",
"example":"SkinBlonde"
}
}
},
"stateDetailsAsUser":{
"description":"state details.",
"type":"string",
"example":"Description of user"
},
"listPrice":{
"description":"The list price.",
"type":"number",
"example":21.99
},
"status":{
"description":"status.",
"type":"string",
"example":null
}
}
}
},
"email":{
"description":"The email address of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"john.muir@oracle.com"
}
}
}
}
Nested Schema : shopperInput
Type: object
Map of shopper input keys to values
Show Source
{
"description":"Map of shopper input keys to values",
"type":"object",
"properties":{
"additionalProperties":{
"type":"string",
"example":"SkinBlonde"
}
}
}
Nested Schema : shoppingCart
Type: object
Show Source
{
"type":"object",
"properties":{
"itemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding items property is truncated. The value for this field will always be true if present",
"type":"boolean"
},
"numberOfItems":{
"type":"number",
"example":1
},
"items":{
"description":"The array of products in the shopping cart. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook",
"type":"array",
"items":{
"type":"object",
"properties":{
"primaryThumbImageURL":{
"type":"string",
"example":"/ccstore/v1/images/product1.jpg"
},
"rawTotalPrice":{
"type":"number",
"example":21.99
},
"displayName":{
"type":"string",
"example":"The Girl with the Dragon Tattoo"
},
"dynamicProperties":{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string",
"example":"11234"
},
"label":{
"description":"The dynamic property label.",
"type":"string",
"example":"leadActor"
},
"value":{
"description":"The dynamic property value.",
"type":"string",
"example":"women"
}
}
}
},
"shippingSurchargeValue":{
"type":"number",
"example":0
},
"description":{
"type":"string",
"example":"Best movie title"
},
"discountAmount":{
"type":"number",
"example":0
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a third party system.",
"type":"array",
"items":{
"properties":{
"values":{
"description":"The map values associated with an externalData item.",
"type":"object",
"properties":{
"value":{
"description":"Map value defined by external system.",
"type":"string",
"example":"ExtVal1"
},
"key":{
"description":"Map key defined by external system.",
"type":"string",
"example":"ExtKey1"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string",
"example":"Ext1"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the third party system.",
"type":"string",
"example":"ExtAct1"
}
}
}
},
"isItemValid":{
"type":"boolean",
"example":true
},
"childItems":{
"description":"Represents the child commerce items. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook",
"type":"array",
"items":{
"type":"object",
"properties":{
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string",
"example":"configOptIDC1P11536825979556"
},
"addOnItem":{
"description":"Whether this child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean",
"example":"true"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string",
"example":"SkinBlonde"
},
"type":"object"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string",
"example":"configPropIDC1P11536825979556"
}
}
}
},
"configuratorId":{
"type":"string",
"example":"null"
},
"externalPrice":{
"type":"number",
"example":0
},
"commerceItemId":{
"description":"CommerceItem id",
"type":"string",
"example":"ci3000421"
},
"price":{
"type":"number",
"example":21.99
},
"variant":{
"description":"List of variants for the product.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value.",
"type":"string",
"example":"L"
},
"optionName":{
"description":"The variant option name.",
"type":"string",
"example":"size"
}
}
}
},
"childItemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding childItems property is truncated. The value for this field will be true always if present",
"type":"boolean"
},
"onSale":{
"type":"boolean",
"example":false
},
"id":{
"description":"Commerce id of the product",
"type":"string",
"example":"ci3000424"
},
"unitPrice":{
"type":"number",
"example":21.99
},
"amount":{
"type":"number",
"example":21.99
},
"quantity":{
"type":"number",
"example":1
},
"productId":{
"type":"string",
"example":"Product_36Exy"
},
"salePrice":{
"type":"number",
"example":0
},
"detailedItemPriceInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean",
"example":false
},
"amount":{
"type":"number",
"example":21.99
},
"quantity":{
"type":"number",
"example":1
},
"tax":{
"type":"number",
"example":0
},
"orderDiscountShare":{
"type":"number",
"example":0
},
"detailedUnitPrice":{
"type":"number",
"example":21.99
},
"currencyCode":{
"type":"string",
"example":"USD"
}
}
}
},
"giftWithPurchaseCommerceItemMarkers":{
"type":"array",
"items":{
"type":"object",
"properties":{
"selectedQuantity":{
"type":"number",
"example":0
},
"id":{
"type":"string",
"example":"gwp id"
}
}
}
},
"externalPriceQuantity":{
"type":"number",
"example":0
},
"catRefId":{
"type":"string",
"example":"Sku_36Fxy"
},
"skuProperties":{
"type":"object",
"properties":{
"propertyType":{
"type":"string",
"example":"sku-base"
},
"name":{
"type":"string",
"example":"Not Returnable"
},
"id":{
"type":"string",
"example":"nonreturnable"
},
"value":{
"type":"string",
"example":"false"
}
}
},
"discountInfo":{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"coupon":{
"description":"The coupon ID.",
"type":"string",
"example":"CPN1234"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string",
"example":"women lead promotion"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string",
"example":"PROMO123"
}
}
}
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean",
"example":false
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number",
"example":21.99
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"number",
"example":1
},
"tax":{
"description":"Monetary tax amount.",
"type":"number",
"example":0
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number",
"example":0
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number",
"example":21.99
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string",
"example":"USD"
}
}
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"type":"object",
"properties":{
"additionalProperties":{
"type":"string",
"example":"SkinBlonde"
}
}
},
"listPrice":{
"type":"number",
"example":21.99
}
}
}
}
}
}
Nested Schema : claimedCouponMultiPromotions
Type: object
Show Source
{
"type":"object",
"properties":{
"promotions":{
"type":"array",
"items":{
"type":"object",
"properties":{
"totalAdjustment":{
"type":"number",
"example":0
},
"secondaryCurrencyTotalAdjustment":{
"type":"number",
"example":0
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
}
Nested Schema : orderCouponsMap
Type: array
The list of all the coupons with the order
Show Source
{
"description":"The list of all the coupons with the order",
"type":"array",
"items":{
"properties":{
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions)",
"type":"boolean",
"example":false
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string",
"example":"0"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string",
"example":"promotion desc"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string",
"example":"promo123"
}
}
}
}
Nested Schema : orderImplicitDiscountList
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"Detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PROMO1"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions)",
"type":"boolean",
"example":true
},
"promotionLevel":{
"description":"promotion level - order or item",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string",
"example":"5.6"
},
"promotionDesc":{
"type":"string",
"example":"the order related promotion"
},
"secondaryCurrencyTotalAdjustment":{
"description":"The total adjustment for secondary currency",
"type":"string",
"example":"0"
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
}
Nested Schema : unclaimedCouponMultiPromotions
Type: object
Show Source
{
"type":"object",
"properties":{
"promotionInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"long desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PRMName"
},
"promotionLevel":{
"type":"string",
"example":"order"
},
"totalAdjustment":{
"type":"number",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"description of the promotion"
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
}
Nested Schema : unclaimedCouponsMap
Type: object
Show Source
{
"type":"object",
"properties":{
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
}
Nested Schema : promotions
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"totalAdjustment":{
"type":"number",
"example":0
},
"secondaryCurrencyTotalAdjustment":{
"type":"number",
"example":0
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"totalAdjustment":{
"type":"number",
"example":0
},
"secondaryCurrencyTotalAdjustment":{
"type":"number",
"example":0
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"properties":{
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions)",
"type":"boolean",
"example":false
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string",
"example":"0"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string",
"example":"promotion desc"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string",
"example":"promo123"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"Detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PROMO1"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions)",
"type":"boolean",
"example":true
},
"promotionLevel":{
"description":"promotion level - order or item",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string",
"example":"5.6"
},
"promotionDesc":{
"type":"string",
"example":"the order related promotion"
},
"secondaryCurrencyTotalAdjustment":{
"description":"The total adjustment for secondary currency",
"type":"string",
"example":"0"
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
Nested Schema : promotionInfo
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"long desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PRMName"
},
"promotionLevel":{
"type":"string",
"example":"order"
},
"totalAdjustment":{
"type":"number",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"description of the promotion"
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"long desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PRMName"
},
"promotionLevel":{
"type":"string",
"example":"order"
},
"totalAdjustment":{
"type":"number",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"description of the promotion"
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string",
"example":"11502"
},
"label":{
"description":"The dynamic property label.",
"type":"string",
"example":"dyn_prop"
},
"value":{
"description":"The dynamic property value.",
"type":"string",
"example":"12"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"giftWithPurchaseQuantityAvailableForSelection":{
"description":"gift quantity available for selection",
"type":"number",
"example":1
},
"giftWithPurchaseType":{
"description":"The type of the gift. (sku, product)",
"type":"string",
"example":"sku"
},
"giftWithPurchaseDetail":{
"description":"String identifying the free gift, usually the repository id of the gift type.",
"type":"string",
"example":"FreePerfumeSku"
},
"promotionId":{
"description":"The gift with purchase promotion id",
"type":"string",
"example":"PROMO123"
},
"giftWithPurchaseIdentifier":{
"description":"An identifier used to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one. example: SKU_986",
"type":"number"
}
}
}
Nested Schema : loyaltyPrograms
Type: array
Loyalty Programs Information
Show Source
{
"description":"Loyalty Programs Information",
"type":"array",
"items":{
"type":"object",
"properties":{
"programName":{
"description":"programName of Loyalty Program",
"type":"string",
"example":"Loyalty Program Demo"
},
"repositoryId":{
"description":"repository Id",
"type":"string",
"example":"123345"
},
"membershipId":{
"description":"membershipId of the profile.",
"type":"string",
"example":"MM123"
},
"programId":{
"description":"programId of Loyalty Program",
"type":"string",
"example":"LYT123"
},
"status":{
"description":"status of Enrollment.",
"type":"string",
"example":"Enrolled"
}
}
}
}
Nested Schema : sitePropertiesList
Type: array
The list of site related properties for the profile
Show Source
{
"description":"The list of site related properties for the profile",
"type":"array",
"items":{
"type":"object",
"properties":{
"site":{
"description":"The site data",
"type":"object",
"properties":{
"id":{
"description":"The id of the site",
"type":"string",
"example":"SiteUS"
}
}
},
"properties":{
"description":"The site related properties for the profile",
"type":"object",
"properties":{
"GDPRProfileP13nConsentDate":{
"description":"The date on which GDPR personalization consent was granted by the user.",
"type":"string",
"example":"null"
},
"GDPRProfileP13nConsentGranted":{
"description":"If user has given consent for his/her profile information to be used for personalization purposes.",
"type":"boolean",
"example":false
},
"receiveEmail":{
"description":"Indicates whether the user should receive marketing emails on the current site. Can be yes or no.",
"type":"string",
"example":"no"
},
"receiveEmailDate":{
"description":"The date on which email marketing consent was granted by the user.",
"type":"string",
"example":"2018-07-30T15:49:10.184Z"
}
}
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"programName":{
"description":"programName of Loyalty Program",
"type":"string",
"example":"Loyalty Program Demo"
},
"repositoryId":{
"description":"repository Id",
"type":"string",
"example":"123345"
},
"membershipId":{
"description":"membershipId of the profile.",
"type":"string",
"example":"MM123"
},
"programId":{
"description":"programId of Loyalty Program",
"type":"string",
"example":"LYT123"
},
"status":{
"description":"status of Enrollment.",
"type":"string",
"example":"Enrolled"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"site":{
"description":"The site data",
"type":"object",
"properties":{
"id":{
"description":"The id of the site",
"type":"string",
"example":"SiteUS"
}
}
},
"properties":{
"description":"The site related properties for the profile",
"type":"object",
"properties":{
"GDPRProfileP13nConsentDate":{
"description":"The date on which GDPR personalization consent was granted by the user.",
"type":"string",
"example":"null"
},
"GDPRProfileP13nConsentGranted":{
"description":"If user has given consent for his/her profile information to be used for personalization purposes.",
"type":"boolean",
"example":false
},
"receiveEmail":{
"description":"Indicates whether the user should receive marketing emails on the current site. Can be yes or no.",
"type":"string",
"example":"no"
},
"receiveEmailDate":{
"description":"The date on which email marketing consent was granted by the user.",
"type":"string",
"example":"2018-07-30T15:49:10.184Z"
}
}
}
}
}
Nested Schema : properties
Type: object
The site related properties for the profile
Show Source
{
"description":"The site related properties for the profile",
"type":"object",
"properties":{
"GDPRProfileP13nConsentDate":{
"description":"The date on which GDPR personalization consent was granted by the user.",
"type":"string",
"example":"null"
},
"GDPRProfileP13nConsentGranted":{
"description":"If user has given consent for his/her profile information to be used for personalization purposes.",
"type":"boolean",
"example":false
},
"receiveEmail":{
"description":"Indicates whether the user should receive marketing emails on the current site. Can be yes or no.",
"type":"string",
"example":"no"
},
"receiveEmailDate":{
"description":"The date on which email marketing consent was granted by the user.",
"type":"string",
"example":"2018-07-30T15:49:10.184Z"
}
}
}
Nested Schema : site
Type: object
The site data
Show Source
{
"description":"The site data",
"type":"object",
"properties":{
"id":{
"description":"The id of the site",
"type":"string",
"example":"SiteUS"
}
}
}
Nested Schema : frequencyAmountTotals
Type: array
The total for each recurring charge frequency
Show Source
{
"description":"The total for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string",
"example":21.99
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string",
"example":"Monthly"
}
}
}
}
Nested Schema : frequencyTaxTotals
Type: array
The tax for each recurring charge frequency
Show Source
{
"description":"The tax for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string",
"example":0
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string",
"example":"Monthly"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string",
"example":21.99
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string",
"example":"Monthly"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string",
"example":0
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string",
"example":"Monthly"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"lastName":{
"description":"The second name of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"Muir"
},
"firstName":{
"description":"The first name of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"John"
},
"priceInfo":{
"type":"object",
"properties":{
"amount":{
"type":"number",
"example":21.99
},
"total":{
"type":"number",
"example":21.99
},
"lkpValExcludingFreeShip":{
"type":"number",
"example":0
},
"shipping":{
"type":"number",
"example":25
},
"shippingSurchargeValue":{
"type":"number",
"example":0
},
"tax":{
"type":"number",
"example":0
},
"subTotal":{
"type":"number",
"example":21.99
},
"currencyCode":{
"type":"string",
"example":"USD"
},
"totalWithoutTax":{
"type":"number",
"example":21.99
}
}
},
"itemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding items property is truncated. The value for this field will always be true if present",
"type":"boolean"
},
"phoneNumber":{
"description":"The phone number of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"1231231234"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number",
"example":21.99
},
"total":{
"description":"The total price of the recurring charge.",
"type":"number",
"example":21.99
},
"frequencyAmountTotals":{
"description":"The total for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string",
"example":21.99
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string",
"example":"Monthly"
}
}
}
},
"shipping":{
"description":"Cost of shipping the product.",
"type":"number",
"example":25
},
"tax":{
"description":"Monetary tax amount.",
"type":"number",
"example":0
},
"subTotal":{
"description":"The sub-total price of the recurring charge.",
"type":"number",
"example":21.99
},
"frequencyTaxTotals":{
"description":"The tax for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string",
"example":0
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string",
"example":"Monthly"
}
}
}
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string",
"example":"USD"
},
"totalWithoutTax":{
"description":"Total of recurring amount without tax included.",
"type":"number",
"example":21.99
}
}
},
"discountInfo":{
"description":"The discount information.",
"type":"object",
"properties":{
"unclaimedCouponMultiPromotions":{
"type":"object",
"properties":{
"promotionInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"long desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PRMName"
},
"promotionLevel":{
"type":"string",
"example":"order"
},
"totalAdjustment":{
"type":"number",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"description of the promotion"
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
},
"orderCouponsMap":{
"description":"The list of all the coupons with the order",
"type":"array",
"items":{
"type":"object",
"properties":{
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions)",
"type":"boolean",
"example":false
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string",
"example":"0"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string",
"example":"promotion desc"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string",
"example":"promo123"
}
}
}
},
"orderDiscount":{
"description":"The order discount.",
"type":"number",
"example":0
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"number",
"example":5.6
},
"orderImplicitDiscountList":{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"Detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PROMO1"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions)",
"type":"boolean",
"example":true
},
"promotionLevel":{
"description":"promotion level - order or item",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string",
"example":"5.6"
},
"promotionDesc":{
"type":"string",
"example":"the order related promotion"
},
"secondaryCurrencyTotalAdjustment":{
"description":"The total adjustment for secondary currency",
"type":"string",
"example":"0"
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
},
"unclaimedCouponsMap":{
"type":"object",
"properties":{
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
},
"claimedCouponMultiPromotions":{
"type":"object",
"properties":{
"promotions":{
"type":"array",
"items":{
"type":"object",
"properties":{
"totalAdjustment":{
"type":"number",
"example":0
},
"secondaryCurrencyTotalAdjustment":{
"type":"number",
"example":0
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
}
}
},
"shippingMethod":{
"description":"The shipping method details for the order.",
"type":"object",
"properties":{
"shippingTax":{
"description":"The shipping tax.",
"type":"number",
"example":0
},
"cost":{
"description":"The cost of shipping.",
"type":"number",
"example":25
},
"taxCode":{
"description":"The tax code for shipping method.",
"type":"string",
"example":"TX123"
},
"value":{
"description":"The shipping method .",
"type":"string",
"example":"TwoDay"
},
"shippingMethodDescription":{
"description":"The shipping method description.",
"type":"string",
"example":"Two day shipping"
}
}
},
"shippingGroupId":{
"description":"The shipping group id.",
"type":"string",
"example":"sg123"
},
"shippingAddress":{
"type":"object",
"properties":{
"lastName":{
"type":"string",
"example":"Muir"
},
"country":{
"type":"string",
"example":"United States"
},
"address3":{
"type":"string",
"example":"Suite 6"
},
"address2":{
"type":"string",
"example":"2 cross"
},
"city":{
"type":"string",
"example":"Boston"
},
"address1":{
"type":"string",
"example":"1 main st"
},
"prefix":{
"type":"string",
"example":"Mr"
},
"companyName":{
"type":"string",
"example":"Oracle"
},
"postalCode":{
"type":"string",
"example":12345
},
"jobTitle":{
"type":"string",
"example":"Manager"
},
"county":{
"type":"string",
"example":"Suffolk"
},
"suffix":{
"type":"string",
"example":"Sr"
},
"firstName":{
"type":"string",
"example":"John"
},
"phoneNumber":{
"type":"number",
"example":1231231234
},
"faxNumber":{
"type":"number",
"example":1231231234
},
"middleName":{
"type":"string",
"example":"Morgan"
},
"state":{
"type":"string",
"example":"MA"
},
"email":{
"type":"string",
"example":"john.muir@oracle.com"
}
}
},
"items":{
"type":"array",
"items":{
"type":"object",
"properties":{
"availablePickupDate":{
"description":"The items available store pickup date.",
"type":"string",
"example":"2018-05-19T13:00:00.000Z"
},
"unitPrice":{
"description":"The unit price.",
"type":"number",
"example":21.99
},
"inventoryLocationId":{
"description":"Defines the inventory location that services the referenced commerce item.",
"type":"string",
"example":"IN123"
},
"quantity":{
"description":"The quantity.",
"type":"number",
"example":1
},
"rawTotalPrice":{
"description":"The raw total price.",
"type":"number",
"example":21.99
},
"returnedQuantity":{
"description":"The returned quantity.",
"type":"number",
"example":0
},
"salePrice":{
"description":"The sale price.",
"type":"number",
"example":0
},
"detailedItemPriceInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean",
"example":false
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number",
"example":0
},
"amount":{
"type":"number",
"example":24.99
},
"quantity":{
"type":"number",
"example":1
},
"tax":{
"type":"number",
"example":0
},
"orderDiscountShare":{
"type":"number",
"example":0
},
"detailedUnitPrice":{
"type":"number",
"example":24.99
},
"currencyCode":{
"type":"string",
"example":"USD"
}
}
}
},
"dynamicProperties":{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string",
"example":"11502"
},
"label":{
"description":"The dynamic property label.",
"type":"string",
"example":"dyn_prop"
},
"value":{
"description":"The dynamic property value.",
"type":"string",
"example":"12"
}
}
}
},
"shippingSurchargeValue":{
"description":"The shipping surcharge if any.",
"type":"number",
"example":0
},
"preferredPickupDate":{
"description":"The items preferred store pickup date.",
"type":"string",
"example":"2018-05-19T13:00:00.000Z"
},
"discountAmount":{
"description":"The discount amount.",
"type":"number",
"example":0
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a third party system.",
"type":"array",
"items":{
"properties":{
"values":{
"description":"The map values associated with an externalData item.",
"type":"object",
"properties":{
"value":{
"description":"Map value defined by external system.",
"type":"string",
"example":"ExternalPropertyVal"
},
"key":{
"description":"Map key defined by external system.",
"type":"string",
"example":"ExternalPropertyKey"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string",
"example":"ExternalProp"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the third party system.",
"type":"string",
"example":"ExternalPropertyAction"
}
}
}
},
"catRefId":{
"description":"The catalog ref id.",
"type":"string",
"example":"SKu_36Fxy"
},
"externalPrice":{
"description":"Individual price of configurable item",
"type":"number"
},
"commerceItemId":{
"description":"Internal commerce item id.",
"type":"string",
"example":"ci200014"
},
"discountInfo":{
"description":"Whether this item is discounted.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"Promotion BAC"
},
"external":{
"description":"if promotion is external",
"type":"boolean",
"example":false
},
"coupon":{
"type":"string",
"example":"CPN123"
},
"promotionLevel":{
"type":"string",
"example":"item"
},
"totalAdjustment":{
"type":"string",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"promotion desc"
},
"promotionId":{
"type":"string",
"example":"PRM123"
},
"giftWithPurchaseDiscountInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"gitWithPurchaseDetail":{
"type":"string",
"example":"details of gift"
},
"gitWithPurchaseIdentifier":{
"type":"number",
"example":1223344
},
"giftWithPurchaseType":{
"description":"the gift type.For example product or sku",
"type":"string",
"example":"product"
},
"promotionDesc":{
"type":"string",
"example":"GWP Promotion description"
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
}
}
}
},
"price":{
"description":"The price.",
"type":"number",
"example":21.99
},
"childItemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding childItems property is truncated. The value for this field will be true always if present",
"type":"boolean"
},
"onSale":{
"description":"Is item on sale.",
"type":"boolean",
"example":false
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"type":"object",
"properties":{
"additionalProperties":{
"type":"string",
"example":"SkinBlonde"
}
}
},
"stateDetailsAsUser":{
"description":"state details.",
"type":"string",
"example":"Description of user"
},
"listPrice":{
"description":"The list price.",
"type":"number",
"example":21.99
},
"status":{
"description":"status.",
"type":"string",
"example":null
}
}
}
},
"email":{
"description":"The email address of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"john.muir@oracle.com"
}
}
}
Nested Schema : discountInfo
Type: object
The discount information.
Show Source
{
"description":"The discount information.",
"type":"object",
"properties":{
"unclaimedCouponMultiPromotions":{
"type":"object",
"properties":{
"promotionInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"long desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PRMName"
},
"promotionLevel":{
"type":"string",
"example":"order"
},
"totalAdjustment":{
"type":"number",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"description of the promotion"
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
},
"orderCouponsMap":{
"description":"The list of all the coupons with the order",
"type":"array",
"items":{
"type":"object",
"properties":{
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions)",
"type":"boolean",
"example":false
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string",
"example":"0"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string",
"example":"promotion desc"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string",
"example":"promo123"
}
}
}
},
"orderDiscount":{
"description":"The order discount.",
"type":"number",
"example":0
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"number",
"example":5.6
},
"orderImplicitDiscountList":{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"Detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PROMO1"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions)",
"type":"boolean",
"example":true
},
"promotionLevel":{
"description":"promotion level - order or item",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string",
"example":"5.6"
},
"promotionDesc":{
"type":"string",
"example":"the order related promotion"
},
"secondaryCurrencyTotalAdjustment":{
"description":"The total adjustment for secondary currency",
"type":"string",
"example":"0"
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
},
"unclaimedCouponsMap":{
"type":"object",
"properties":{
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
},
"claimedCouponMultiPromotions":{
"type":"object",
"properties":{
"promotions":{
"type":"array",
"items":{
"type":"object",
"properties":{
"totalAdjustment":{
"type":"number",
"example":0
},
"secondaryCurrencyTotalAdjustment":{
"type":"number",
"example":0
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
}
}
}
Nested Schema : items
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"availablePickupDate":{
"description":"The items available store pickup date.",
"type":"string",
"example":"2018-05-19T13:00:00.000Z"
},
"unitPrice":{
"description":"The unit price.",
"type":"number",
"example":21.99
},
"inventoryLocationId":{
"description":"Defines the inventory location that services the referenced commerce item.",
"type":"string",
"example":"IN123"
},
"quantity":{
"description":"The quantity.",
"type":"number",
"example":1
},
"rawTotalPrice":{
"description":"The raw total price.",
"type":"number",
"example":21.99
},
"returnedQuantity":{
"description":"The returned quantity.",
"type":"number",
"example":0
},
"salePrice":{
"description":"The sale price.",
"type":"number",
"example":0
},
"detailedItemPriceInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean",
"example":false
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number",
"example":0
},
"amount":{
"type":"number",
"example":24.99
},
"quantity":{
"type":"number",
"example":1
},
"tax":{
"type":"number",
"example":0
},
"orderDiscountShare":{
"type":"number",
"example":0
},
"detailedUnitPrice":{
"type":"number",
"example":24.99
},
"currencyCode":{
"type":"string",
"example":"USD"
}
}
}
},
"dynamicProperties":{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string",
"example":"11502"
},
"label":{
"description":"The dynamic property label.",
"type":"string",
"example":"dyn_prop"
},
"value":{
"description":"The dynamic property value.",
"type":"string",
"example":"12"
}
}
}
},
"shippingSurchargeValue":{
"description":"The shipping surcharge if any.",
"type":"number",
"example":0
},
"preferredPickupDate":{
"description":"The items preferred store pickup date.",
"type":"string",
"example":"2018-05-19T13:00:00.000Z"
},
"discountAmount":{
"description":"The discount amount.",
"type":"number",
"example":0
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a third party system.",
"type":"array",
"items":{
"properties":{
"values":{
"description":"The map values associated with an externalData item.",
"type":"object",
"properties":{
"value":{
"description":"Map value defined by external system.",
"type":"string",
"example":"ExternalPropertyVal"
},
"key":{
"description":"Map key defined by external system.",
"type":"string",
"example":"ExternalPropertyKey"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string",
"example":"ExternalProp"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the third party system.",
"type":"string",
"example":"ExternalPropertyAction"
}
}
}
},
"catRefId":{
"description":"The catalog ref id.",
"type":"string",
"example":"SKu_36Fxy"
},
"externalPrice":{
"description":"Individual price of configurable item",
"type":"number"
},
"commerceItemId":{
"description":"Internal commerce item id.",
"type":"string",
"example":"ci200014"
},
"discountInfo":{
"description":"Whether this item is discounted.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"Promotion BAC"
},
"external":{
"description":"if promotion is external",
"type":"boolean",
"example":false
},
"coupon":{
"type":"string",
"example":"CPN123"
},
"promotionLevel":{
"type":"string",
"example":"item"
},
"totalAdjustment":{
"type":"string",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"promotion desc"
},
"promotionId":{
"type":"string",
"example":"PRM123"
},
"giftWithPurchaseDiscountInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"gitWithPurchaseDetail":{
"type":"string",
"example":"details of gift"
},
"gitWithPurchaseIdentifier":{
"type":"number",
"example":1223344
},
"giftWithPurchaseType":{
"description":"the gift type.For example product or sku",
"type":"string",
"example":"product"
},
"promotionDesc":{
"type":"string",
"example":"GWP Promotion description"
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
}
}
}
},
"price":{
"description":"The price.",
"type":"number",
"example":21.99
},
"childItemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding childItems property is truncated. The value for this field will be true always if present",
"type":"boolean"
},
"onSale":{
"description":"Is item on sale.",
"type":"boolean",
"example":false
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"type":"object",
"properties":{
"additionalProperties":{
"type":"string",
"example":"SkinBlonde"
}
}
},
"stateDetailsAsUser":{
"description":"state details.",
"type":"string",
"example":"Description of user"
},
"listPrice":{
"description":"The list price.",
"type":"number",
"example":21.99
},
"status":{
"description":"status.",
"type":"string",
"example":null
}
}
}
}
Nested Schema : priceInfo
Type: object
Show Source
{
"type":"object",
"properties":{
"amount":{
"type":"number",
"example":21.99
},
"total":{
"type":"number",
"example":21.99
},
"lkpValExcludingFreeShip":{
"type":"number",
"example":0
},
"shipping":{
"type":"number",
"example":25
},
"shippingSurchargeValue":{
"type":"number",
"example":0
},
"tax":{
"type":"number",
"example":0
},
"subTotal":{
"type":"number",
"example":21.99
},
"currencyCode":{
"type":"string",
"example":"USD"
},
"totalWithoutTax":{
"type":"number",
"example":21.99
}
}
}
Nested Schema : recurringChargePriceInfo
Type: object
Recurring charge price information.
Show Source
{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number",
"example":21.99
},
"total":{
"description":"The total price of the recurring charge.",
"type":"number",
"example":21.99
},
"frequencyAmountTotals":{
"description":"The total for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string",
"example":21.99
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string",
"example":"Monthly"
}
}
}
},
"shipping":{
"description":"Cost of shipping the product.",
"type":"number",
"example":25
},
"tax":{
"description":"Monetary tax amount.",
"type":"number",
"example":0
},
"subTotal":{
"description":"The sub-total price of the recurring charge.",
"type":"number",
"example":21.99
},
"frequencyTaxTotals":{
"description":"The tax for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string",
"example":0
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string",
"example":"Monthly"
}
}
}
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string",
"example":"USD"
},
"totalWithoutTax":{
"description":"Total of recurring amount without tax included.",
"type":"number",
"example":21.99
}
}
}
Nested Schema : shippingAddress
Type: object
Show Source
{
"type":"object",
"properties":{
"lastName":{
"type":"string",
"example":"Muir"
},
"country":{
"type":"string",
"example":"United States"
},
"address3":{
"type":"string",
"example":"Suite 6"
},
"address2":{
"type":"string",
"example":"2 cross"
},
"city":{
"type":"string",
"example":"Boston"
},
"address1":{
"type":"string",
"example":"1 main st"
},
"prefix":{
"type":"string",
"example":"Mr"
},
"companyName":{
"type":"string",
"example":"Oracle"
},
"postalCode":{
"type":"string",
"example":12345
},
"jobTitle":{
"type":"string",
"example":"Manager"
},
"county":{
"type":"string",
"example":"Suffolk"
},
"suffix":{
"type":"string",
"example":"Sr"
},
"firstName":{
"type":"string",
"example":"John"
},
"phoneNumber":{
"type":"number",
"example":1231231234
},
"faxNumber":{
"type":"number",
"example":1231231234
},
"middleName":{
"type":"string",
"example":"Morgan"
},
"state":{
"type":"string",
"example":"MA"
},
"email":{
"type":"string",
"example":"john.muir@oracle.com"
}
}
}
Nested Schema : shippingMethod
Type: object
The shipping method details for the order.
Show Source
{
"description":"The shipping method details for the order.",
"type":"object",
"properties":{
"shippingTax":{
"description":"The shipping tax.",
"type":"number",
"example":0
},
"cost":{
"description":"The cost of shipping.",
"type":"number",
"example":25
},
"taxCode":{
"description":"The tax code for shipping method.",
"type":"string",
"example":"TX123"
},
"value":{
"description":"The shipping method .",
"type":"string",
"example":"TwoDay"
},
"shippingMethodDescription":{
"description":"The shipping method description.",
"type":"string",
"example":"Two day shipping"
}
}
}
Nested Schema : claimedCouponMultiPromotions
Type: object
Show Source
{
"type":"object",
"properties":{
"promotions":{
"type":"array",
"items":{
"type":"object",
"properties":{
"totalAdjustment":{
"type":"number",
"example":0
},
"secondaryCurrencyTotalAdjustment":{
"type":"number",
"example":0
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
}
Nested Schema : orderCouponsMap
Type: array
The list of all the coupons with the order
Show Source
{
"description":"The list of all the coupons with the order",
"type":"array",
"items":{
"type":"object",
"properties":{
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions)",
"type":"boolean",
"example":false
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string",
"example":"0"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string",
"example":"promotion desc"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string",
"example":"promo123"
}
}
}
}
Nested Schema : orderImplicitDiscountList
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"Detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PROMO1"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions)",
"type":"boolean",
"example":true
},
"promotionLevel":{
"description":"promotion level - order or item",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string",
"example":"5.6"
},
"promotionDesc":{
"type":"string",
"example":"the order related promotion"
},
"secondaryCurrencyTotalAdjustment":{
"description":"The total adjustment for secondary currency",
"type":"string",
"example":"0"
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
}
Nested Schema : unclaimedCouponMultiPromotions
Type: object
Show Source
{
"type":"object",
"properties":{
"promotionInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"long desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PRMName"
},
"promotionLevel":{
"type":"string",
"example":"order"
},
"totalAdjustment":{
"type":"number",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"description of the promotion"
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
}
Nested Schema : unclaimedCouponsMap
Type: object
Show Source
{
"type":"object",
"properties":{
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
}
Nested Schema : promotions
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"totalAdjustment":{
"type":"number",
"example":0
},
"secondaryCurrencyTotalAdjustment":{
"type":"number",
"example":0
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"totalAdjustment":{
"type":"number",
"example":0
},
"secondaryCurrencyTotalAdjustment":{
"type":"number",
"example":0
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions)",
"type":"boolean",
"example":false
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string",
"example":"0"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string",
"example":"promotion desc"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string",
"example":"promo123"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"Detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PROMO1"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions)",
"type":"boolean",
"example":true
},
"promotionLevel":{
"description":"promotion level - order or item",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string",
"example":"5.6"
},
"promotionDesc":{
"type":"string",
"example":"the order related promotion"
},
"secondaryCurrencyTotalAdjustment":{
"description":"The total adjustment for secondary currency",
"type":"string",
"example":"0"
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
Nested Schema : promotionInfo
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"long desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PRMName"
},
"promotionLevel":{
"type":"string",
"example":"order"
},
"totalAdjustment":{
"type":"number",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"description of the promotion"
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"long desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PRMName"
},
"promotionLevel":{
"type":"string",
"example":"order"
},
"totalAdjustment":{
"type":"number",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"description of the promotion"
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"availablePickupDate":{
"description":"The items available store pickup date.",
"type":"string",
"example":"2018-05-19T13:00:00.000Z"
},
"unitPrice":{
"description":"The unit price.",
"type":"number",
"example":21.99
},
"inventoryLocationId":{
"description":"Defines the inventory location that services the referenced commerce item.",
"type":"string",
"example":"IN123"
},
"quantity":{
"description":"The quantity.",
"type":"number",
"example":1
},
"rawTotalPrice":{
"description":"The raw total price.",
"type":"number",
"example":21.99
},
"returnedQuantity":{
"description":"The returned quantity.",
"type":"number",
"example":0
},
"salePrice":{
"description":"The sale price.",
"type":"number",
"example":0
},
"detailedItemPriceInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean",
"example":false
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number",
"example":0
},
"amount":{
"type":"number",
"example":24.99
},
"quantity":{
"type":"number",
"example":1
},
"tax":{
"type":"number",
"example":0
},
"orderDiscountShare":{
"type":"number",
"example":0
},
"detailedUnitPrice":{
"type":"number",
"example":24.99
},
"currencyCode":{
"type":"string",
"example":"USD"
}
}
}
},
"dynamicProperties":{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string",
"example":"11502"
},
"label":{
"description":"The dynamic property label.",
"type":"string",
"example":"dyn_prop"
},
"value":{
"description":"The dynamic property value.",
"type":"string",
"example":"12"
}
}
}
},
"shippingSurchargeValue":{
"description":"The shipping surcharge if any.",
"type":"number",
"example":0
},
"preferredPickupDate":{
"description":"The items preferred store pickup date.",
"type":"string",
"example":"2018-05-19T13:00:00.000Z"
},
"discountAmount":{
"description":"The discount amount.",
"type":"number",
"example":0
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a third party system.",
"type":"array",
"items":{
"properties":{
"values":{
"description":"The map values associated with an externalData item.",
"type":"object",
"properties":{
"value":{
"description":"Map value defined by external system.",
"type":"string",
"example":"ExternalPropertyVal"
},
"key":{
"description":"Map key defined by external system.",
"type":"string",
"example":"ExternalPropertyKey"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string",
"example":"ExternalProp"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the third party system.",
"type":"string",
"example":"ExternalPropertyAction"
}
}
}
},
"catRefId":{
"description":"The catalog ref id.",
"type":"string",
"example":"SKu_36Fxy"
},
"externalPrice":{
"description":"Individual price of configurable item",
"type":"number"
},
"commerceItemId":{
"description":"Internal commerce item id.",
"type":"string",
"example":"ci200014"
},
"discountInfo":{
"description":"Whether this item is discounted.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"Promotion BAC"
},
"external":{
"description":"if promotion is external",
"type":"boolean",
"example":false
},
"coupon":{
"type":"string",
"example":"CPN123"
},
"promotionLevel":{
"type":"string",
"example":"item"
},
"totalAdjustment":{
"type":"string",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"promotion desc"
},
"promotionId":{
"type":"string",
"example":"PRM123"
},
"giftWithPurchaseDiscountInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"gitWithPurchaseDetail":{
"type":"string",
"example":"details of gift"
},
"gitWithPurchaseIdentifier":{
"type":"number",
"example":1223344
},
"giftWithPurchaseType":{
"description":"the gift type.For example product or sku",
"type":"string",
"example":"product"
},
"promotionDesc":{
"type":"string",
"example":"GWP Promotion description"
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
}
}
}
},
"price":{
"description":"The price.",
"type":"number",
"example":21.99
},
"childItemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding childItems property is truncated. The value for this field will be true always if present",
"type":"boolean"
},
"onSale":{
"description":"Is item on sale.",
"type":"boolean",
"example":false
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"type":"object",
"properties":{
"additionalProperties":{
"type":"string",
"example":"SkinBlonde"
}
}
},
"stateDetailsAsUser":{
"description":"state details.",
"type":"string",
"example":"Description of user"
},
"listPrice":{
"description":"The list price.",
"type":"number",
"example":21.99
},
"status":{
"description":"status.",
"type":"string",
"example":null
}
}
}
Nested Schema : detailedItemPriceInfo
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean",
"example":false
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number",
"example":0
},
"amount":{
"type":"number",
"example":24.99
},
"quantity":{
"type":"number",
"example":1
},
"tax":{
"type":"number",
"example":0
},
"orderDiscountShare":{
"type":"number",
"example":0
},
"detailedUnitPrice":{
"type":"number",
"example":24.99
},
"currencyCode":{
"type":"string",
"example":"USD"
}
}
}
}
Nested Schema : discountInfo
Type: array
Whether this item is discounted.
Show Source
{
"description":"Whether this item is discounted.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"Promotion BAC"
},
"external":{
"description":"if promotion is external",
"type":"boolean",
"example":false
},
"coupon":{
"type":"string",
"example":"CPN123"
},
"promotionLevel":{
"type":"string",
"example":"item"
},
"totalAdjustment":{
"type":"string",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"promotion desc"
},
"promotionId":{
"type":"string",
"example":"PRM123"
},
"giftWithPurchaseDiscountInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"gitWithPurchaseDetail":{
"type":"string",
"example":"details of gift"
},
"gitWithPurchaseIdentifier":{
"type":"number",
"example":1223344
},
"giftWithPurchaseType":{
"description":"the gift type.For example product or sku",
"type":"string",
"example":"product"
},
"promotionDesc":{
"type":"string",
"example":"GWP Promotion description"
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
}
}
}
}
Nested Schema : dynamicProperties
Type: array
List of dynamic properties at line item level.
Show Source
{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string",
"example":"11502"
},
"label":{
"description":"The dynamic property label.",
"type":"string",
"example":"dyn_prop"
},
"value":{
"description":"The dynamic property value.",
"type":"string",
"example":"12"
}
}
}
}
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a third party system.
Show Source
{
"description":"External data to be associated with a commerce item, provided by a third party system.",
"type":"array",
"items":{
"properties":{
"values":{
"description":"The map values associated with an externalData item.",
"type":"object",
"properties":{
"value":{
"description":"Map value defined by external system.",
"type":"string",
"example":"ExternalPropertyVal"
},
"key":{
"description":"Map key defined by external system.",
"type":"string",
"example":"ExternalPropertyKey"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string",
"example":"ExternalProp"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the third party system.",
"type":"string",
"example":"ExternalPropertyAction"
}
}
}
}
Nested Schema : shopperInput
Type: object
Map of shopper input keys to values
Show Source
{
"description":"Map of shopper input keys to values",
"type":"object",
"properties":{
"additionalProperties":{
"type":"string",
"example":"SkinBlonde"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"discounted":{
"type":"boolean",
"example":false
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number",
"example":0
},
"amount":{
"type":"number",
"example":24.99
},
"quantity":{
"type":"number",
"example":1
},
"tax":{
"type":"number",
"example":0
},
"orderDiscountShare":{
"type":"number",
"example":0
},
"detailedUnitPrice":{
"type":"number",
"example":24.99
},
"currencyCode":{
"type":"string",
"example":"USD"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"Promotion BAC"
},
"external":{
"description":"if promotion is external",
"type":"boolean",
"example":false
},
"coupon":{
"type":"string",
"example":"CPN123"
},
"promotionLevel":{
"type":"string",
"example":"item"
},
"totalAdjustment":{
"type":"string",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"promotion desc"
},
"promotionId":{
"type":"string",
"example":"PRM123"
},
"giftWithPurchaseDiscountInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"gitWithPurchaseDetail":{
"type":"string",
"example":"details of gift"
},
"gitWithPurchaseIdentifier":{
"type":"number",
"example":1223344
},
"giftWithPurchaseType":{
"description":"the gift type.For example product or sku",
"type":"string",
"example":"product"
},
"promotionDesc":{
"type":"string",
"example":"GWP Promotion description"
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
}
}
}
Nested Schema : giftWithPurchaseDiscountInfo
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"gitWithPurchaseDetail":{
"type":"string",
"example":"details of gift"
},
"gitWithPurchaseIdentifier":{
"type":"number",
"example":1223344
},
"giftWithPurchaseType":{
"description":"the gift type.For example product or sku",
"type":"string",
"example":"product"
},
"promotionDesc":{
"type":"string",
"example":"GWP Promotion description"
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"gitWithPurchaseDetail":{
"type":"string",
"example":"details of gift"
},
"gitWithPurchaseIdentifier":{
"type":"number",
"example":1223344
},
"giftWithPurchaseType":{
"description":"the gift type.For example product or sku",
"type":"string",
"example":"product"
},
"promotionDesc":{
"type":"string",
"example":"GWP Promotion description"
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string",
"example":"11502"
},
"label":{
"description":"The dynamic property label.",
"type":"string",
"example":"dyn_prop"
},
"value":{
"description":"The dynamic property value.",
"type":"string",
"example":"12"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"properties":{
"values":{
"description":"The map values associated with an externalData item.",
"type":"object",
"properties":{
"value":{
"description":"Map value defined by external system.",
"type":"string",
"example":"ExternalPropertyVal"
},
"key":{
"description":"Map key defined by external system.",
"type":"string",
"example":"ExternalPropertyKey"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string",
"example":"ExternalProp"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the third party system.",
"type":"string",
"example":"ExternalPropertyAction"
}
}
}
Nested Schema : values
Type: object
The map values associated with an externalData item.
Show Source
{
"description":"The map values associated with an externalData item.",
"type":"object",
"properties":{
"value":{
"description":"Map value defined by external system.",
"type":"string",
"example":"ExternalPropertyVal"
},
"key":{
"description":"Map key defined by external system.",
"type":"string",
"example":"ExternalPropertyKey"
}
}
}
Nested Schema : frequencyAmountTotals
Type: array
The total for each recurring charge frequency
Show Source
{
"description":"The total for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string",
"example":21.99
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string",
"example":"Monthly"
}
}
}
}
Nested Schema : frequencyTaxTotals
Type: array
The tax for each recurring charge frequency
Show Source
{
"description":"The tax for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string",
"example":0
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string",
"example":"Monthly"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string",
"example":21.99
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string",
"example":"Monthly"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string",
"example":0
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string",
"example":"Monthly"
}
}
}
Nested Schema : items
Type: array
The array of products in the shopping cart. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook
Show Source
{
"description":"The array of products in the shopping cart. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook",
"type":"array",
"items":{
"type":"object",
"properties":{
"primaryThumbImageURL":{
"type":"string",
"example":"/ccstore/v1/images/product1.jpg"
},
"rawTotalPrice":{
"type":"number",
"example":21.99
},
"displayName":{
"type":"string",
"example":"The Girl with the Dragon Tattoo"
},
"dynamicProperties":{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string",
"example":"11234"
},
"label":{
"description":"The dynamic property label.",
"type":"string",
"example":"leadActor"
},
"value":{
"description":"The dynamic property value.",
"type":"string",
"example":"women"
}
}
}
},
"shippingSurchargeValue":{
"type":"number",
"example":0
},
"description":{
"type":"string",
"example":"Best movie title"
},
"discountAmount":{
"type":"number",
"example":0
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a third party system.",
"type":"array",
"items":{
"properties":{
"values":{
"description":"The map values associated with an externalData item.",
"type":"object",
"properties":{
"value":{
"description":"Map value defined by external system.",
"type":"string",
"example":"ExtVal1"
},
"key":{
"description":"Map key defined by external system.",
"type":"string",
"example":"ExtKey1"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string",
"example":"Ext1"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the third party system.",
"type":"string",
"example":"ExtAct1"
}
}
}
},
"isItemValid":{
"type":"boolean",
"example":true
},
"childItems":{
"description":"Represents the child commerce items. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook",
"type":"array",
"items":{
"type":"object",
"properties":{
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string",
"example":"configOptIDC1P11536825979556"
},
"addOnItem":{
"description":"Whether this child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean",
"example":"true"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string",
"example":"SkinBlonde"
},
"type":"object"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string",
"example":"configPropIDC1P11536825979556"
}
}
}
},
"configuratorId":{
"type":"string",
"example":"null"
},
"externalPrice":{
"type":"number",
"example":0
},
"commerceItemId":{
"description":"CommerceItem id",
"type":"string",
"example":"ci3000421"
},
"price":{
"type":"number",
"example":21.99
},
"variant":{
"description":"List of variants for the product.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value.",
"type":"string",
"example":"L"
},
"optionName":{
"description":"The variant option name.",
"type":"string",
"example":"size"
}
}
}
},
"childItemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding childItems property is truncated. The value for this field will be true always if present",
"type":"boolean"
},
"onSale":{
"type":"boolean",
"example":false
},
"id":{
"description":"Commerce id of the product",
"type":"string",
"example":"ci3000424"
},
"unitPrice":{
"type":"number",
"example":21.99
},
"amount":{
"type":"number",
"example":21.99
},
"quantity":{
"type":"number",
"example":1
},
"productId":{
"type":"string",
"example":"Product_36Exy"
},
"salePrice":{
"type":"number",
"example":0
},
"detailedItemPriceInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean",
"example":false
},
"amount":{
"type":"number",
"example":21.99
},
"quantity":{
"type":"number",
"example":1
},
"tax":{
"type":"number",
"example":0
},
"orderDiscountShare":{
"type":"number",
"example":0
},
"detailedUnitPrice":{
"type":"number",
"example":21.99
},
"currencyCode":{
"type":"string",
"example":"USD"
}
}
}
},
"giftWithPurchaseCommerceItemMarkers":{
"type":"array",
"items":{
"type":"object",
"properties":{
"selectedQuantity":{
"type":"number",
"example":0
},
"id":{
"type":"string",
"example":"gwp id"
}
}
}
},
"externalPriceQuantity":{
"type":"number",
"example":0
},
"catRefId":{
"type":"string",
"example":"Sku_36Fxy"
},
"skuProperties":{
"type":"object",
"properties":{
"propertyType":{
"type":"string",
"example":"sku-base"
},
"name":{
"type":"string",
"example":"Not Returnable"
},
"id":{
"type":"string",
"example":"nonreturnable"
},
"value":{
"type":"string",
"example":"false"
}
}
},
"discountInfo":{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"coupon":{
"description":"The coupon ID.",
"type":"string",
"example":"CPN1234"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string",
"example":"women lead promotion"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string",
"example":"PROMO123"
}
}
}
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean",
"example":false
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number",
"example":21.99
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"number",
"example":1
},
"tax":{
"description":"Monetary tax amount.",
"type":"number",
"example":0
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number",
"example":0
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number",
"example":21.99
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string",
"example":"USD"
}
}
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"type":"object",
"properties":{
"additionalProperties":{
"type":"string",
"example":"SkinBlonde"
}
}
},
"listPrice":{
"type":"number",
"example":21.99
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"primaryThumbImageURL":{
"type":"string",
"example":"/ccstore/v1/images/product1.jpg"
},
"rawTotalPrice":{
"type":"number",
"example":21.99
},
"displayName":{
"type":"string",
"example":"The Girl with the Dragon Tattoo"
},
"dynamicProperties":{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string",
"example":"11234"
},
"label":{
"description":"The dynamic property label.",
"type":"string",
"example":"leadActor"
},
"value":{
"description":"The dynamic property value.",
"type":"string",
"example":"women"
}
}
}
},
"shippingSurchargeValue":{
"type":"number",
"example":0
},
"description":{
"type":"string",
"example":"Best movie title"
},
"discountAmount":{
"type":"number",
"example":0
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a third party system.",
"type":"array",
"items":{
"properties":{
"values":{
"description":"The map values associated with an externalData item.",
"type":"object",
"properties":{
"value":{
"description":"Map value defined by external system.",
"type":"string",
"example":"ExtVal1"
},
"key":{
"description":"Map key defined by external system.",
"type":"string",
"example":"ExtKey1"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string",
"example":"Ext1"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the third party system.",
"type":"string",
"example":"ExtAct1"
}
}
}
},
"isItemValid":{
"type":"boolean",
"example":true
},
"childItems":{
"description":"Represents the child commerce items. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook",
"type":"array",
"items":{
"type":"object",
"properties":{
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string",
"example":"configOptIDC1P11536825979556"
},
"addOnItem":{
"description":"Whether this child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean",
"example":"true"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string",
"example":"SkinBlonde"
},
"type":"object"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string",
"example":"configPropIDC1P11536825979556"
}
}
}
},
"configuratorId":{
"type":"string",
"example":"null"
},
"externalPrice":{
"type":"number",
"example":0
},
"commerceItemId":{
"description":"CommerceItem id",
"type":"string",
"example":"ci3000421"
},
"price":{
"type":"number",
"example":21.99
},
"variant":{
"description":"List of variants for the product.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value.",
"type":"string",
"example":"L"
},
"optionName":{
"description":"The variant option name.",
"type":"string",
"example":"size"
}
}
}
},
"childItemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding childItems property is truncated. The value for this field will be true always if present",
"type":"boolean"
},
"onSale":{
"type":"boolean",
"example":false
},
"id":{
"description":"Commerce id of the product",
"type":"string",
"example":"ci3000424"
},
"unitPrice":{
"type":"number",
"example":21.99
},
"amount":{
"type":"number",
"example":21.99
},
"quantity":{
"type":"number",
"example":1
},
"productId":{
"type":"string",
"example":"Product_36Exy"
},
"salePrice":{
"type":"number",
"example":0
},
"detailedItemPriceInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean",
"example":false
},
"amount":{
"type":"number",
"example":21.99
},
"quantity":{
"type":"number",
"example":1
},
"tax":{
"type":"number",
"example":0
},
"orderDiscountShare":{
"type":"number",
"example":0
},
"detailedUnitPrice":{
"type":"number",
"example":21.99
},
"currencyCode":{
"type":"string",
"example":"USD"
}
}
}
},
"giftWithPurchaseCommerceItemMarkers":{
"type":"array",
"items":{
"type":"object",
"properties":{
"selectedQuantity":{
"type":"number",
"example":0
},
"id":{
"type":"string",
"example":"gwp id"
}
}
}
},
"externalPriceQuantity":{
"type":"number",
"example":0
},
"catRefId":{
"type":"string",
"example":"Sku_36Fxy"
},
"skuProperties":{
"type":"object",
"properties":{
"propertyType":{
"type":"string",
"example":"sku-base"
},
"name":{
"type":"string",
"example":"Not Returnable"
},
"id":{
"type":"string",
"example":"nonreturnable"
},
"value":{
"type":"string",
"example":"false"
}
}
},
"discountInfo":{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"coupon":{
"description":"The coupon ID.",
"type":"string",
"example":"CPN1234"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string",
"example":"women lead promotion"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string",
"example":"PROMO123"
}
}
}
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean",
"example":false
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number",
"example":21.99
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"number",
"example":1
},
"tax":{
"description":"Monetary tax amount.",
"type":"number",
"example":0
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number",
"example":0
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number",
"example":21.99
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string",
"example":"USD"
}
}
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"type":"object",
"properties":{
"additionalProperties":{
"type":"string",
"example":"SkinBlonde"
}
}
},
"listPrice":{
"type":"number",
"example":21.99
}
}
}
Nested Schema : childItems
Type: array
Represents the child commerce items. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook
Show Source
{
"description":"Represents the child commerce items. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook",
"type":"array",
"items":{
"type":"object",
"properties":{
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string",
"example":"configOptIDC1P11536825979556"
},
"addOnItem":{
"description":"Whether this child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean",
"example":"true"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string",
"example":"SkinBlonde"
},
"type":"object"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string",
"example":"configPropIDC1P11536825979556"
}
}
}
}
Nested Schema : detailedItemPriceInfo
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean",
"example":false
},
"amount":{
"type":"number",
"example":21.99
},
"quantity":{
"type":"number",
"example":1
},
"tax":{
"type":"number",
"example":0
},
"orderDiscountShare":{
"type":"number",
"example":0
},
"detailedUnitPrice":{
"type":"number",
"example":21.99
},
"currencyCode":{
"type":"string",
"example":"USD"
}
}
}
}
Nested Schema : detailedRecurringChargeInfo
Type: object
Detailed Item Price Information.
Show Source
{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean",
"example":false
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number",
"example":21.99
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"number",
"example":1
},
"tax":{
"description":"Monetary tax amount.",
"type":"number",
"example":0
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number",
"example":0
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number",
"example":21.99
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string",
"example":"USD"
}
}
}
Nested Schema : discountInfo
Type: array
The discount information.
Show Source
{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"coupon":{
"description":"The coupon ID.",
"type":"string",
"example":"CPN1234"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string",
"example":"women lead promotion"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string",
"example":"PROMO123"
}
}
}
}
Nested Schema : dynamicProperties
Type: array
List of dynamic properties at line item level.
Show Source
{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string",
"example":"11234"
},
"label":{
"description":"The dynamic property label.",
"type":"string",
"example":"leadActor"
},
"value":{
"description":"The dynamic property value.",
"type":"string",
"example":"women"
}
}
}
}
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a third party system.
Show Source
{
"description":"External data to be associated with a commerce item, provided by a third party system.",
"type":"array",
"items":{
"properties":{
"values":{
"description":"The map values associated with an externalData item.",
"type":"object",
"properties":{
"value":{
"description":"Map value defined by external system.",
"type":"string",
"example":"ExtVal1"
},
"key":{
"description":"Map key defined by external system.",
"type":"string",
"example":"ExtKey1"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string",
"example":"Ext1"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the third party system.",
"type":"string",
"example":"ExtAct1"
}
}
}
}
Nested Schema : giftWithPurchaseCommerceItemMarkers
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"selectedQuantity":{
"type":"number",
"example":0
},
"id":{
"type":"string",
"example":"gwp id"
}
}
}
}
Nested Schema : shopperInput
Type: object
Map of shopper input keys to values
Show Source
{
"description":"Map of shopper input keys to values",
"type":"object",
"properties":{
"additionalProperties":{
"type":"string",
"example":"SkinBlonde"
}
}
}
Nested Schema : skuProperties
Type: object
Show Source
{
"type":"object",
"properties":{
"propertyType":{
"type":"string",
"example":"sku-base"
},
"name":{
"type":"string",
"example":"Not Returnable"
},
"id":{
"type":"string",
"example":"nonreturnable"
},
"value":{
"type":"string",
"example":"false"
}
}
}
Nested Schema : variant
Type: array
List of variants for the product.
Show Source
{
"description":"List of variants for the product.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value.",
"type":"string",
"example":"L"
},
"optionName":{
"description":"The variant option name.",
"type":"string",
"example":"size"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string",
"example":"configOptIDC1P11536825979556"
},
"addOnItem":{
"description":"Whether this child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean",
"example":"true"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string",
"example":"SkinBlonde"
},
"type":"object"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string",
"example":"configPropIDC1P11536825979556"
}
}
}
Nested Schema : shopperInput
Type: object
Additional Properties Allowed
Show Source
{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string",
"example":"SkinBlonde"
},
"type":"object"
}
Map of shopper input keys to values
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"discounted":{
"type":"boolean",
"example":false
},
"amount":{
"type":"number",
"example":21.99
},
"quantity":{
"type":"number",
"example":1
},
"tax":{
"type":"number",
"example":0
},
"orderDiscountShare":{
"type":"number",
"example":0
},
"detailedUnitPrice":{
"type":"number",
"example":21.99
},
"currencyCode":{
"type":"string",
"example":"USD"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"coupon":{
"description":"The coupon ID.",
"type":"string",
"example":"CPN1234"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string",
"example":"women lead promotion"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string",
"example":"PROMO123"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string",
"example":"11234"
},
"label":{
"description":"The dynamic property label.",
"type":"string",
"example":"leadActor"
},
"value":{
"description":"The dynamic property value.",
"type":"string",
"example":"women"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"properties":{
"values":{
"description":"The map values associated with an externalData item.",
"type":"object",
"properties":{
"value":{
"description":"Map value defined by external system.",
"type":"string",
"example":"ExtVal1"
},
"key":{
"description":"Map key defined by external system.",
"type":"string",
"example":"ExtKey1"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string",
"example":"Ext1"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the third party system.",
"type":"string",
"example":"ExtAct1"
}
}
}
Nested Schema : values
Type: object
The map values associated with an externalData item.
Show Source
{
"description":"The map values associated with an externalData item.",
"type":"object",
"properties":{
"value":{
"description":"Map value defined by external system.",
"type":"string",
"example":"ExtVal1"
},
"key":{
"description":"Map key defined by external system.",
"type":"string",
"example":"ExtKey1"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"selectedQuantity":{
"type":"number",
"example":0
},
"id":{
"type":"string",
"example":"gwp id"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value.",
"type":"string",
"example":"L"
},
"optionName":{
"description":"The variant option name.",
"type":"string",
"example":"size"
}
}
}