Root Schema : idleCart_request
Type: object
The details of the idle cart
Show Source
{
"description":"The details of the idle cart",
"properties":{
"idleCart":{
"properties":{
"taxPriceInfo":{
"description":"The shipping address details.",
"type":"object",
"properties":{
"cityTax":{
"description":"City Tax",
"type":"number"
},
"secondaryCurrencyTaxAmount":{
"description":"taxAmount in secondaryCurrency",
"type":"number"
},
"amount":{
"description":"The total order amount.",
"type":"number"
},
"valueAddedTax":{
"description":"Value Added Tax.",
"type":"number"
},
"countyTax":{
"description":"County Tax.",
"type":"number"
},
"isTaxIncluded":{
"description":"If Tax is included?",
"type":"boolean"
},
"miscTax":{
"description":"Misc Tax.",
"type":"number"
},
"districtTax":{
"description":"District Tax.",
"type":"number"
},
"stateTax":{
"description":"State Tax.",
"type":"number"
},
"countryTax":{
"description":"Country Tax.",
"type":"number"
}
}
},
"secondaryCurrencyCode":{
"description":"Secondary currencyCode",
"type":"string"
},
"shippingGroups":{
"type":"array",
"items":{
"type":"object",
"properties":{
"taxPriceInfo":{
"description":"The shipping address details.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"taxAmount in secondaryCurrency",
"type":"number",
"example":0
},
"cityTax":{
"description":"City Tax",
"type":"number",
"example":3.9
},
"amount":{
"description":"The total order amount.",
"type":"number",
"example":5.99
},
"valueAddedTax":{
"description":"Value Added Tax.",
"type":"number",
"example":0
},
"countyTax":{
"description":"County Tax.",
"type":"number",
"example":0
},
"isTaxIncluded":{
"description":"If Tax is included?",
"type":"boolean",
"example":false
},
"miscTax":{
"description":"Misc Tax.",
"type":"number",
"example":1.87
},
"districtTax":{
"description":"District Tax.",
"type":"number",
"example":0
},
"stateTax":{
"description":"State Tax.",
"type":"number",
"example":3.9
},
"countryTax":{
"description":"Country Tax.",
"type":"number",
"example":0
}
}
},
"lastName":{
"description":"The second name of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"Muir"
},
"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"
},
"shippingMethod":{
"description":"The shipping method details for the order.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"shippingTax":{
"type":"number"
},
"cost":{
"description":"The total cost of shipping.",
"type":"number"
},
"taxCode":{
"type":"string"
},
"value":{
"description":"The shipping method applied to the order.",
"type":"string"
},
"shippingMethodDescription":{
"type":"string"
}
}
},
"shippingGroupId":{
"description":"The shipping Group id",
"type":"string",
"example":"sg1234"
},
"store":{
"description":"The store is present in the request if the type is inStorePickupShippingGroup.",
"type":"object",
"properties":{
"country":{
"description":"The country of the store",
"type":"string",
"example":"USA"
},
"hours":{
"description":"The store's opening hours.",
"type":"string",
"example":"Mon - Sat 10AM - 7PM Sun 11AM - 6 PM"
},
"address3":{
"description":"Address line 3 of store.",
"type":"string",
"example":"Main Street"
},
"address2":{
"description":"Address line 2 of store.",
"type":"string",
"example":"4th Floor"
},
"city":{
"description":"The store's city.",
"type":"string",
"example":"Boston"
},
"address1":{
"description":"Address line 1 of store.",
"type":"string",
"example":"One Beacon Street"
},
"stateAddress":{
"description":"The store's state address.",
"type":"string",
"example":"MA"
},
"county":{
"description":"The store's county",
"type":"string",
"example":"MA"
},
"phoneNumber":{
"description":"The store's phone number.",
"type":"string",
"example":"(617) 386-1201"
},
"locationId":{
"description":"The store's location Id.",
"type":"string",
"example":"Boston138"
},
"name":{
"description":"The store's name.",
"type":"string",
"example":"Boston Store #138"
},
"faxNumber":{
"description":"Fax number.",
"type":"string",
"example":"(617) 386-1200"
},
"postCode":{
"description":"The store's post code.",
"type":"string",
"example":"2108"
},
"email":{
"description":"The store's email address.",
"type":"string",
"example":"store138@example.com"
}
}
},
"type":{
"description":"the shippingGroup type",
"type":"string",
"example":"inStorePickupShippingGroup"
},
"firstName":{
"description":"The first name of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"John"
},
"priceInfo":{
"description":"The price information.",
"type":"object",
"properties":{
"amount":{
"description":"The total order amount.",
"type":"number",
"example":24.99
},
"total":{
"description":"The order total.",
"type":"number",
"example":47.93
},
"lkpValExcludingFreeShip":{
"description":"The total shipping cost excluding items with free shipping.",
"type":"number",
"example":0
},
"shipping":{
"description":"The total shipping cost.",
"type":"number",
"example":14.95
},
"shippingSurchargeValue":{
"description":"Extra handling costs for shipping the products",
"type":"number",
"example":0
},
"tax":{
"description":"The total tax amount.",
"type":"number",
"example":7.99
},
"subTotal":{
"description":"Sub-total.",
"type":"number",
"example":24.99
},
"currencyCode":{
"description":"The currency code.",
"type":"string",
"example":"USD"
},
"totalWithoutTax":{
"description":"The total amount without tax.",
"type":"number",
"example":39.49
}
}
},
"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"
},
"total":{
"description":"The total price of the recurring charge.",
"type":"number"
},
"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"
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string"
}
}
}
},
"shipping":{
"description":"Cost of shipping the product.",
"type":"number"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"subTotal":{
"description":"The sub-total price of the recurring charge.",
"type":"number"
},
"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"
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string"
}
}
}
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"totalWithoutTax":{
"description":"Total of recurring amount without tax included.",
"type":"number"
}
}
},
"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":"integer",
"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":"integer",
"example":0
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"integer",
"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":"integer",
"example":0
},
"secondaryCurrencyTotalAdjustment":{
"type":"integer",
"example":0
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
}
}
},
"shippingAddress":{
"description":"The shipping address details.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name.",
"type":"string",
"example":"Muir"
},
"country":{
"description":"Country.",
"type":"string"
},
"address3":{
"description":"Address snippet.",
"type":"string"
},
"address2":{
"description":"Address snippet.",
"type":"string"
},
"city":{
"description":"City.",
"type":"string",
"example":"Cambridge"
},
"address1":{
"description":"Address snippet.",
"type":"string",
"example":"1 main st"
},
"prefix":{
"description":"Name prefix.",
"type":"string"
},
"companyName":{
"description":"Company name.",
"type":"string",
"example":"oracle"
},
"postalCode":{
"description":"Postal code.",
"type":"string",
"example":1122
},
"jobTitle":{
"description":"Job title.",
"type":"string",
"example":"manager"
},
"county":{
"description":"County.",
"type":"string"
},
"suffix":{
"description":"Name suffix.",
"type":"string"
},
"firstName":{
"description":"First name",
"type":"string",
"example":"John"
},
"phoneNumber":{
"description":"Phone number.",
"type":"string",
"example":1111111111
},
"faxNumber":{
"description":"Fax number.",
"type":"string"
},
"middleName":{
"description":"Middle name.",
"type":"string",
"example":"Morgan"
},
"state":{
"description":"State.",
"type":"string",
"example":"MA"
},
"email":{
"description":"Email address.",
"type":"string",
"example":"john.muir@oracle.com"
}
}
},
"items":{
"type":"array",
"items":{
"properties":{
"availablePickupDate":{
"format":"date-time",
"description":"The items available store pickup date.",
"type":"string",
"example":"2018-05-19T13:00:00.000Z"
},
"inventoryLocationId":{
"description":"Defines the inventory location that services the referenced commerce item.",
"type":"string"
},
"rawTotalPrice":{
"description":"The raw total price.",
"type":"number",
"example":24.99
},
"returnedQuantity":{
"type":"integer",
"example":0
},
"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":"Extra handling cost for shipping the product.",
"type":"number",
"example":0
},
"availabilityDate":{
"format":"date-time",
"description":"The availability date for preOrdered/backOrdered quantity.",
"type":"string",
"example":"2018-06-13T18:09:53.493Z"
},
"discountAmount":{
"description":"The monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal. (read-only)",
"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"
},
"key":{
"description":"Map key defined by external system.",
"type":"string"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the third party system.",
"type":"string"
}
}
}
},
"preOrderQuantity":{
"description":"The pre ordered quantity included.",
"type":"integer",
"example":0
},
"childItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
}
}
},
"configuratorId":{
"type":"string"
},
"commerceItemId":{
"description":"Commerce Item ID for this commerce item.",
"type":"string",
"example":"ci123545"
},
"price":{
"type":"number",
"example":24.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":"Whether is on sale.",
"type":"boolean",
"example":false
},
"actionCode":{
"description":"The action code that has been set on the item by the third party system.",
"type":"string"
},
"commerceId":{
"description":"Commerce ID for this commerce item.",
"type":"string",
"example":"ci12343"
},
"stateDetailsAsUser":{
"type":"string",
"example":"details of shippingItem"
},
"unitPrice":{
"type":"number",
"example":24.99
},
"amount":{
"description":"The monetary amount.",
"type":"number",
"example":24.99
},
"quantity":{
"description":"The number of items covered by this price info",
"type":"integer",
"example":1
},
"productId":{
"description":"The ID of the product.",
"type":"string",
"example":"product_9e"
},
"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":"integer",
"example":1
},
"tax":{
"type":"number",
"example":0
},
"orderDiscountShare":{
"type":"integer",
"example":0
},
"detailedUnitPrice":{
"type":"number",
"example":24.99
},
"currencyCode":{
"type":"string",
"example":"USD"
}
}
}
},
"preferredPickupDate":{
"format":"date-time",
"description":"The items preferred store pickup date.",
"type":"string",
"example":"2018-05-19T13:00:00.000Z"
},
"catRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string",
"example":"Sku_9F"
},
"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":"integer",
"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"
}
}
}
}
}
}
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"backOrderQuantity":{
"description":"The back ordered quantity included.",
"type":"integer",
"example":0
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number",
"example":24.99
},
"status":{
"type":"string",
"example":"INITIAL"
}
}
}
},
"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"
}
}
}
},
"lastModifiedTime":{
"description":"The last modified time in long seconds",
"type":"integer"
},
"cartUrl":{
"description":"The cart url",
"type":"string"
},
"creationTime":{
"description":"The creation time in long seconds",
"type":"integer"
},
"lastModifiedDate":{
"description":"The last modified date",
"type":"string"
},
"orderId":{
"description":"The order id",
"type":"string"
},
"creationSiteId":{
"description":"The ID of the site on which the order was created on. This may differ to siteId value if the site is part of a cart sharing group.",
"type":"string"
},
"shippingMethod":{
"description":"The shipping method details for the order.",
"type":"object",
"properties":{
"cost":{
"description":"The total cost of shipping.",
"type":"number"
},
"value":{
"description":"The shipping method applied to the order.",
"type":"string"
}
}
},
"payments":{
"description":"The payment information.",
"type":"array",
"items":{
"type":"object",
"properties":{
}
}
},
"profile":{
"description":"The details of customer profile created on Oracle Commerce Cloud. This includes the email, first name and last name of the customer.",
"type":"object",
"properties":{
"lastName":{
"description":"Last Name",
"type":"string"
},
"firstName":{
"description":"First Name",
"type":"string"
},
"customerContactId":{
"description":"The external customer contact id.",
"type":"string"
},
"creditCards":{
"type":"object",
"properties":{
"cardType":{
"type":"object",
"properties":{
"expirationYear":{
"type":"string"
},
"tokenExpiryDate":{
"type":"string"
},
"gatewayConfigId":{
"type":"string"
},
"expirationMonth":{
"type":"string"
},
"source":{
"type":"string"
},
"creditCardType":{
"type":"string"
},
"token":{
"type":"string"
},
"iin":{
"type":"string"
},
"cardProps":{
"type":"object",
"properties":{
}
},
"nameOnCard":{
"type":"string"
},
"creditCardNumber":{
"type":"string"
},
"tokenCreatedDate":{
"type":"string"
},
"cardSavedDate":{
"type":"string"
},
"id":{
"type":"string"
},
"billingAddress":{
"description":"Default billing address of the profile",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the billing address",
"type":"string"
},
"firstName":{
"description":"the first name of the billing address",
"type":"string"
},
"externalAddressId":{
"description":"External ID of the address",
"type":"string"
},
"country":{
"description":"the country of the billing address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the billing address",
"type":"string"
},
"address2":{
"description":"the address2 of the billing address",
"type":"string"
},
"city":{
"description":"the city of the billing address",
"type":"string"
},
"address1":{
"description":"the address1 of the billing address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the billing address",
"type":"string"
},
"county":{
"description":"the county of the billing address",
"type":"string"
},
"repositoryId":{
"description":"the id of the billing address",
"type":"string"
},
"state":{
"description":"the state of the billing address",
"type":"string"
}
}
},
"expirationDayOfMonth":{
"type":"string"
}
}
}
}
},
"loyaltyPrograms":{
"description":"Loyalty Programs Information",
"type":"array",
"items":{
"type":"object",
"properties":{
"programName":{
"description":"programName of Loyalty Program",
"type":"string"
},
"repositoryId":{
"description":"repository Id",
"type":"string"
},
"membershipId":{
"description":"membershipId of the profile.",
"type":"string"
},
"programId":{
"description":"programId of Loyalty Program",
"type":"string"
},
"status":{
"description":"status of Enrollment",
"type":"string"
}
}
}
},
"receiveEmail":{
"description":"If User wants email notification?",
"type":"string"
},
"id":{
"description":"The profile-id of the order",
"type":"string"
},
"locale":{
"description":"Locale",
"type":"string"
},
"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"
}
}
},
"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"
},
"GDPRProfileP13nConsentGranted":{
"description":"If user has given consent for his/her profile information to be used for personalization purposes.",
"type":"boolean"
},
"receiveEmail":{
"description":"Indicates whether the user should receive marketing emails on the current site. Can be yes or no.",
"type":"string"
},
"receiveEmailDate":{
"description":"The date on which email marketing consent was granted by the user.",
"type":"string"
}
}
}
}
}
},
"email":{
"description":"email of the user.",
"type":"string"
},
"daytimeTelephoneNumber":{
"description":"The telephone number",
"type":"string"
}
}
},
"orderStatus":{
"description":"Status of the order",
"type":"string"
},
"cartName":{
"description":"Cart name for this order.",
"type":"string"
},
"creationDate":{
"description":"The creation date in ISO format",
"type":"string"
},
"orderProfileId":{
"description":"The profile-id of the order",
"type":"string"
},
"priceInfo":{
"description":"The price information.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"The secondary currency tax amount.",
"type":"number"
},
"amount":{
"description":"The total order amount.",
"type":"number"
},
"total":{
"description":"The order total.",
"type":"number"
},
"secondaryCurrencyShippingAmount":{
"description":"The secondary currency shipping amount.",
"type":"number"
},
"shipping":{
"description":"The total shipping cost.",
"type":"number"
},
"secondaryCurrencyTotal":{
"description":"The secondary currency total amount..",
"type":"number"
},
"primaryCurrencyTotal":{
"description":"The primary currency total amount..",
"type":"number"
},
"shippingSurchargeValue":{
"description":"Extra handling costs for shipping the products",
"type":"number"
},
"tax":{
"description":"The total tax amount.",
"type":"number"
},
"subTotal":{
"description":"Sub-total.",
"type":"number"
},
"currencyCode":{
"description":"The currency code.",
"type":"string"
},
"totalWithoutTax":{
"description":"The total amount without tax.",
"type":"number"
}
}
},
"site":{
"type":"object",
"properties":{
"siteURL":{
"description":"The production URL of the site where the order is placed",
"type":"string"
},
"siteName":{
"description":"The name of the site where order is placed",
"type":"string"
}
}
},
"discountInfo":{
"description":"The discount information.",
"type":"object",
"properties":{
"orderCouponsMap":{
"description":"The list of all the coupons with the order.",
"type":"object"
},
"orderDiscount":{
"description":"The order discount.",
"type":"number"
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"number"
},
"orderImplicitDiscountList":{
"description":"Order Implicit Discount List.",
"type":"array",
"items":{
"type":"object",
"properties":{
}
}
},
"unclaimedCouponsMap":{
"description":"The unclaimed coupons with the order.",
"type":"object"
}
}
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"total":{
"description":"The total price of the recurring charge.",
"type":"number"
},
"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"
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string"
}
}
}
},
"shipping":{
"description":"Cost of shipping the product.",
"type":"number"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"subTotal":{
"description":"The sub-total price of the recurring charge.",
"type":"number"
},
"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"
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string"
}
}
}
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"totalWithoutTax":{
"description":"Total of recurring amount without tax included.",
"type":"number"
}
}
},
"exchangeRate":{
"description":"exchangeRate",
"type":"number"
},
"shoppingCart":{
"description":"The shopping-cart or order contents of the current order.",
"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":{
"description":"Total no of items.",
"type":"integer"
},
"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":{
"unitPrice":{
"description":"The unit price of the product.",
"type":"number"
},
"primaryThumbImageURL":{
"description":"Image url of the product",
"type":"string"
},
"quantity":{
"description":"The quantity of the product.",
"type":"integer"
},
"productId":{
"description":"ID of the product in the cart.",
"type":"string"
},
"rawTotalPrice":{
"description":"The raw price of the product.",
"type":"number"
},
"dynamicProperties":{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string"
},
"label":{
"description":"The dynamic property label.",
"type":"string"
},
"value":{
"description":"The dynamic property value.",
"type":"string"
}
}
}
},
"detailedItemPriceInfo":{
"description":"The unit price of the product.",
"type":"array",
"items":{
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"taxAmount in secondaryCurrency",
"type":"number"
},
"discounted":{
"description":"If discounted?",
"type":"boolean"
},
"amount":{
"description":"The total order amount.",
"type":"number"
},
"quantity":{
"description":"Quantity.",
"type":"integer"
},
"tax":{
"description":"The total tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order discount share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price.",
"type":"number"
},
"currencyCode":{
"description":"The currency code.",
"type":"string"
}
}
}
},
"displayName":{
"description":"The name of the product.",
"type":"string"
},
"shippingSurchargeValue":{
"description":"tax applied on shipping",
"type":"number"
},
"isItemValid":{
"description":"if item is valid",
"type":"boolean"
},
"description":{
"description":"Description about the product.",
"type":"string"
},
"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":{
"properties":{
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"addOnItem":{
"description":"Whether this child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"quantity":{
"description":"The quantity of this child item included.",
"type":"integer"
},
"productId":{
"description":"The product ID of the child item.",
"type":"string"
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this child commerce item references. Typically the SKU id.",
"type":"string"
}
}
}
},
"catRefId":{
"description":"The category to which the product belongs.",
"type":"string"
},
"configuratorId":{
"description":"Configuration ID for this commerce item.",
"type":"string"
},
"discountInfo":{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
}
}
},
"price":{
"description":"The actual price of the product.",
"type":"number"
},
"variant":{
"description":"List of variants for the product.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value.",
"type":"string"
},
"optionName":{
"description":"The variant option name.",
"type":"string"
}
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"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":"if item is on sale",
"type":"boolean"
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
}
}
}
}
}
},
"shippingAddress":{
"description":"The shipping address details.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name.",
"type":"string"
},
"country":{
"description":"Country.",
"type":"string"
},
"address3":{
"description":"Address snippet.",
"type":"string"
},
"address2":{
"description":"Address snippet.",
"type":"string"
},
"city":{
"description":"City.",
"type":"string"
},
"address1":{
"description":"Address snippet.",
"type":"string"
},
"prefix":{
"description":"Name prefix.",
"type":"string"
},
"companyName":{
"description":"Company name.",
"type":"string"
},
"postalCode":{
"description":"Postal code.",
"type":"string"
},
"jobTitle":{
"description":"Job title.",
"type":"string"
},
"county":{
"description":"County.",
"type":"string"
},
"suffix":{
"description":"Name suffix.",
"type":"string"
},
"firstName":{
"description":"First name",
"type":"string"
},
"phoneNumber":{
"description":"Phone number.",
"type":"string"
},
"faxNumber":{
"description":"Fax number.",
"type":"string"
},
"middleName":{
"description":"Middle name.",
"type":"string"
},
"state":{
"description":"State.",
"type":"string"
},
"email":{
"description":"Email address.",
"type":"string"
}
}
},
"siteId":{
"description":"The id of the site associated with this cart",
"type":"string"
}
}
}
},
"example":{
"idleCart":{
"taxPriceInfo":{
"cityTax":0,
"amount":0,
"valueAddedTax":0,
"countyTax":0,
"isTaxIncluded":false,
"miscTax":0,
"districtTax":0,
"stateTax":0,
"countryTax":0
},
"shippingGroups":[
{
"lastName":"Anderson",
"firstName":"Kim",
"discountInfo":{
"orderDiscount":0,
"shippingDiscount":0,
"discountDescList":[
]
},
"phoneNumber":"212-555-1977",
"shippingMethod":{
"secondaryCurrencyTaxAmount":0,
"shippingTax":0,
"cost":0,
"taxIncluded":true,
"taxCode":"",
"value":"inStorePickupShippingGroup",
"shippingMethodDescription":"inStorePickupShippingGroup"
},
"shippingGroupId":"sg50499",
"store":{
"country":"USA",
"hours":"Mon - Sat 10AM - 7PM Sun 11AM - 6 PM",
"address3":null,
"address2":"4th Floor",
"city":"Boston",
"address1":"One Beacon Street",
"postalCode":"2108",
"county":null,
"stateAddress":"MA",
"phoneNumber":"(617) 386-1200",
"locationId":"Boston138",
"name":"CRS Home - Boston #138",
"faxNumber":"(617) 386-1200",
"email":"store138@example.com"
},
"type":"inStorePickupShippingGroup",
"items":[
{
"availablePickupDate":"2018-05-19T13:00:00.000Z",
"inventoryLocationId":"Boston138",
"rawTotalPrice":0,
"returnedQuantity":0,
"dynamicProperties":[
],
"shippingSurchargeValue":0,
"externalData":[
],
"discountAmount":0,
"preOrderQuantity":0,
"commerceItemId":"ci3000471",
"price":0,
"onSale":false,
"stateDetailsAsUser":"The item has been initialized within the shipping group",
"commerceId":"ci4000450",
"unitPrice":0,
"amount":0,
"quantity":3,
"productId":"Product_36Exy",
"salePrice":0,
"preferredPickupDate":"2018-05-19T13:00:00.000Z",
"catRefId":"Sku_36Fxy",
"discountInfo":[
],
"siteId":"siteUS",
"shopperInput":{
},
"backOrderQuantity":0,
"listPrice":0,
"status":"INITIAL"
}
],
"email":"kim@example.com"
}
],
"lastModifiedTime":1.499083822557E12,
"creationTime":1.499083808886E12,
"cartUrl":"http://kkm00ali:8080/cart",
"orderId":"o30412",
"lastModifiedDate":"2017-07-03T12:10:22.557Z",
"creationSiteId":"siteUS",
"dynamicProperties":[
],
"shippingMethod":{
"shippingTax":0,
"cost":0,
"value":"hardgoodShippingGroup"
},
"profile":{
"firstName":"neha",
"lastName":"abc",
"creditCards":{
"Visa":{
"expirationYear":"2017",
"tokenExpiryDate":null,
"gatewayConfigId":null,
"expirationMonth":"1",
"source":null,
"creditCardType":"Visa",
"token":null,
"iin":null,
"cardProps":{
},
"nameOnCard":null,
"creditCardNumber":"4539082039396288",
"tokenCreatedDate":"2019-02-28T16:51:04.404Z",
"cardSavedDate":null,
"id":"se-usercc110031",
"billingAddress":{
"country":"US",
"lastName":"Anderson",
"address3":null,
"city":"Buffalo",
"address2":null,
"prefix":null,
"address1":"451 Brooks Ave",
"companyName":null,
"postalCode":"14201",
"county":null,
"suffix":null,
"externalAddressId":null,
"firstName":"Kim",
"phoneNumber":"212-555-2150",
"faxNumber":null,
"middleName":null,
"id":"se-990031",
"state":"NY"
},
"expirationDayOfMonth":null
}
},
"customerContactId":"externalId",
"receiveEmail":"no",
"id":"120660",
"locale":"en",
"email":"neha@ca.com",
"sitePropertiesList":[
{
"site":{
"id":"siteUS"
},
"properties":{
"GDPRProfileP13nConsentDate":null,
"GDPRProfileP13nConsentGranted":false,
"receiveEmail":"no",
"receiveEmailDate":null
}
}
],
"daytimeTelephoneNumber":""
},
"orderStatus":"Incomplete",
"cartName":"My Cart",
"creationDate":"2017-07-03T12:10:08.886Z",
"orderProfileId":"120660",
"priceInfo":{
"amount":14.99,
"total":14.99,
"shipping":0,
"shippingSurchargeValue":0,
"tax":0,
"subTotal":14.99,
"currencyCode":"USD",
"totalWithoutTax":14.99
},
"discountInfo":{
"unclaimedCouponMultiPromotions":{
},
"orderCouponsMap":{
},
"orderDiscount":0,
"shippingDiscount":0,
"orderImplicitDiscountList":[
],
"unclaimedCouponsMap":{
},
"claimedCouponMultiPromotions":{
}
},
"shoppingCart":{
"numberOfItems":1,
"items":[
{
"primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v320598425551039087/products/liberty-heights_LARGE.jpg&height=100&width=100",
"rawTotalPrice":14.99,
"displayName":"Liberty Heights",
"dynamicProperties":[
],
"shippingSurchargeValue":0,
"discountAmount":0,
"externalData":[
],
"description":"A really great movie that you should not miss.",
"isItemValid":true,
"childItems":[
{
"configurationOptionId":"configOptIDC1P11536825979556",
"addOnItem":true,
"quantity":5,
"priceListGroupId":"price_list_group_1536825979556",
"productId":"child1P1Prod1536825979556",
"siteId":"siteUS",
"childItems":[
],
"configurablePropertyId":"configPropIDC1P11536825979556",
"shopperInput":{
"fontSIID1536825979556":"Times New Roman",
"shrtTxtSIID1536825979556":"This is the P1parent1Prod1536825979556"
},
"catRefId":"child1P1Sku1536825979556"
}
],
"commerceItemId":"ci3000412",
"price":14.99,
"variant":[
],
"onSale":false,
"actionCode":null,
"id":"ci3000413",
"unitPrice":14.99,
"quantity":1,
"productId":"Product_1Ci",
"salePrice":0,
"detailedItemPriceInfo":[
{
"discounted":false,
"amount":14.99,
"quantity":1,
"tax":0,
"orderDiscountShare":0,
"detailedUnitPrice":14.99,
"currencyCode":"USD"
}
],
"giftWithPurchaseCommerceItemMarkers":[
],
"taxCode":null,
"catRefId":"Sku_1Di",
"skuProperties":[
{
"propertyType":"sku-base",
"name":"Name",
"id":"displayName",
"value":null
},
{
"propertyType":"sku-base",
"name":"Active",
"id":"active",
"value":true
},
{
"propertyType":"sku-base",
"name":"Id",
"id":"id",
"value":"Sku_1Di"
}
],
"discountInfo":[
],
"siteId":"siteUS",
"listPrice":14.99
}
]
},
"giftWithPurchaseInfo":[
],
"siteId":"100003",
"shippingAddress":{
"lastName":null,
"country":null,
"address3":null,
"address2":null,
"city":null,
"prefix":null,
"address1":null,
"postalCode":null,
"companyName":null,
"jobTitle":null,
"county":null,
"suffix":null,
"firstName":null,
"phoneNumber":null,
"faxNumber":null,
"alias":null,
"middleName":null,
"state":null,
"email":null
}
},
"site":{
"siteURL":"http://kkm00ali:8080",
"siteName":"CloudLake US Site test"
}
}
}
Example:
{
"idleCart":{
"taxPriceInfo":{
"cityTax":0,
"amount":0,
"valueAddedTax":0,
"countyTax":0,
"isTaxIncluded":false,
"miscTax":0,
"districtTax":0,
"stateTax":0,
"countryTax":0
},
"shippingGroups":[
{
"lastName":"Anderson",
"firstName":"Kim",
"discountInfo":{
"orderDiscount":0,
"shippingDiscount":0,
"discountDescList":[
]
},
"phoneNumber":"212-555-1977",
"shippingMethod":{
"secondaryCurrencyTaxAmount":0,
"shippingTax":0,
"cost":0,
"taxIncluded":true,
"taxCode":"",
"value":"inStorePickupShippingGroup",
"shippingMethodDescription":"inStorePickupShippingGroup"
},
"shippingGroupId":"sg50499",
"store":{
"country":"USA",
"hours":"Mon - Sat 10AM - 7PM Sun 11AM - 6 PM",
"address3":null,
"address2":"4th Floor",
"city":"Boston",
"address1":"One Beacon Street",
"postalCode":"2108",
"county":null,
"stateAddress":"MA",
"phoneNumber":"(617) 386-1200",
"locationId":"Boston138",
"name":"CRS Home - Boston #138",
"faxNumber":"(617) 386-1200",
"email":"store138@example.com"
},
"type":"inStorePickupShippingGroup",
"items":[
{
"availablePickupDate":"2018-05-19T13:00:00.000Z",
"inventoryLocationId":"Boston138",
"rawTotalPrice":0,
"returnedQuantity":0,
"dynamicProperties":[
],
"shippingSurchargeValue":0,
"externalData":[
],
"discountAmount":0,
"preOrderQuantity":0,
"commerceItemId":"ci3000471",
"price":0,
"onSale":false,
"stateDetailsAsUser":"The item has been initialized within the shipping group",
"commerceId":"ci4000450",
"unitPrice":0,
"amount":0,
"quantity":3,
"productId":"Product_36Exy",
"salePrice":0,
"preferredPickupDate":"2018-05-19T13:00:00.000Z",
"catRefId":"Sku_36Fxy",
"discountInfo":[
],
"siteId":"siteUS",
"shopperInput":{
},
"backOrderQuantity":0,
"listPrice":0,
"status":"INITIAL"
}
],
"email":"kim@example.com"
}
],
"lastModifiedTime":1.499083822557E12,
"creationTime":1.499083808886E12,
"cartUrl":"http://kkm00ali:8080/cart",
"orderId":"o30412",
"lastModifiedDate":"2017-07-03T12:10:22.557Z",
"creationSiteId":"siteUS",
"dynamicProperties":[
],
"shippingMethod":{
"shippingTax":0,
"cost":0,
"value":"hardgoodShippingGroup"
},
"profile":{
"firstName":"neha",
"lastName":"abc",
"creditCards":{
"Visa":{
"expirationYear":"2017",
"tokenExpiryDate":null,
"gatewayConfigId":null,
"expirationMonth":"1",
"source":null,
"creditCardType":"Visa",
"token":null,
"iin":null,
"cardProps":{
},
"nameOnCard":null,
"creditCardNumber":"4539082039396288",
"tokenCreatedDate":"2019-02-28T16:51:04.404Z",
"cardSavedDate":null,
"id":"se-usercc110031",
"billingAddress":{
"country":"US",
"lastName":"Anderson",
"address3":null,
"city":"Buffalo",
"address2":null,
"prefix":null,
"address1":"451 Brooks Ave",
"companyName":null,
"postalCode":"14201",
"county":null,
"suffix":null,
"externalAddressId":null,
"firstName":"Kim",
"phoneNumber":"212-555-2150",
"faxNumber":null,
"middleName":null,
"id":"se-990031",
"state":"NY"
},
"expirationDayOfMonth":null
}
},
"customerContactId":"externalId",
"receiveEmail":"no",
"id":"120660",
"locale":"en",
"email":"neha@ca.com",
"sitePropertiesList":[
{
"site":{
"id":"siteUS"
},
"properties":{
"GDPRProfileP13nConsentDate":null,
"GDPRProfileP13nConsentGranted":false,
"receiveEmail":"no",
"receiveEmailDate":null
}
}
],
"daytimeTelephoneNumber":""
},
"orderStatus":"Incomplete",
"cartName":"My Cart",
"creationDate":"2017-07-03T12:10:08.886Z",
"orderProfileId":"120660",
"priceInfo":{
"amount":14.99,
"total":14.99,
"shipping":0,
"shippingSurchargeValue":0,
"tax":0,
"subTotal":14.99,
"currencyCode":"USD",
"totalWithoutTax":14.99
},
"discountInfo":{
"unclaimedCouponMultiPromotions":{
},
"orderCouponsMap":{
},
"orderDiscount":0,
"shippingDiscount":0,
"orderImplicitDiscountList":[
],
"unclaimedCouponsMap":{
},
"claimedCouponMultiPromotions":{
}
},
"shoppingCart":{
"numberOfItems":1,
"items":[
{
"primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v320598425551039087/products/liberty-heights_LARGE.jpg&height=100&width=100",
"rawTotalPrice":14.99,
"displayName":"Liberty Heights",
"dynamicProperties":[
],
"shippingSurchargeValue":0,
"discountAmount":0,
"externalData":[
],
"description":"A really great movie that you should not miss.",
"isItemValid":true,
"childItems":[
{
"configurationOptionId":"configOptIDC1P11536825979556",
"addOnItem":true,
"quantity":5,
"priceListGroupId":"price_list_group_1536825979556",
"productId":"child1P1Prod1536825979556",
"siteId":"siteUS",
"childItems":[
],
"configurablePropertyId":"configPropIDC1P11536825979556",
"shopperInput":{
"fontSIID1536825979556":"Times New Roman",
"shrtTxtSIID1536825979556":"This is the P1parent1Prod1536825979556"
},
"catRefId":"child1P1Sku1536825979556"
}
],
"commerceItemId":"ci3000412",
"price":14.99,
"variant":[
],
"onSale":false,
"actionCode":null,
"id":"ci3000413",
"unitPrice":14.99,
"quantity":1,
"productId":"Product_1Ci",
"salePrice":0,
"detailedItemPriceInfo":[
{
"discounted":false,
"amount":14.99,
"quantity":1,
"tax":0,
"orderDiscountShare":0,
"detailedUnitPrice":14.99,
"currencyCode":"USD"
}
],
"giftWithPurchaseCommerceItemMarkers":[
],
"taxCode":null,
"catRefId":"Sku_1Di",
"skuProperties":[
{
"propertyType":"sku-base",
"name":"Name",
"id":"displayName",
"value":null
},
{
"propertyType":"sku-base",
"name":"Active",
"id":"active",
"value":true
},
{
"propertyType":"sku-base",
"name":"Id",
"id":"id",
"value":"Sku_1Di"
}
],
"discountInfo":[
],
"siteId":"siteUS",
"listPrice":14.99
}
]
},
"giftWithPurchaseInfo":[
],
"siteId":"100003",
"shippingAddress":{
"lastName":null,
"country":null,
"address3":null,
"address2":null,
"city":null,
"prefix":null,
"address1":null,
"postalCode":null,
"companyName":null,
"jobTitle":null,
"county":null,
"suffix":null,
"firstName":null,
"phoneNumber":null,
"faxNumber":null,
"alias":null,
"middleName":null,
"state":null,
"email":null
}
},
"site":{
"siteURL":"http://kkm00ali:8080",
"siteName":"CloudLake US Site test"
}
}
Nested Schema : idleCart
Type: object
Show Source
{
"properties":{
"taxPriceInfo":{
"description":"The shipping address details.",
"type":"object",
"properties":{
"cityTax":{
"description":"City Tax",
"type":"number"
},
"secondaryCurrencyTaxAmount":{
"description":"taxAmount in secondaryCurrency",
"type":"number"
},
"amount":{
"description":"The total order amount.",
"type":"number"
},
"valueAddedTax":{
"description":"Value Added Tax.",
"type":"number"
},
"countyTax":{
"description":"County Tax.",
"type":"number"
},
"isTaxIncluded":{
"description":"If Tax is included?",
"type":"boolean"
},
"miscTax":{
"description":"Misc Tax.",
"type":"number"
},
"districtTax":{
"description":"District Tax.",
"type":"number"
},
"stateTax":{
"description":"State Tax.",
"type":"number"
},
"countryTax":{
"description":"Country Tax.",
"type":"number"
}
}
},
"secondaryCurrencyCode":{
"description":"Secondary currencyCode",
"type":"string"
},
"shippingGroups":{
"type":"array",
"items":{
"type":"object",
"properties":{
"taxPriceInfo":{
"description":"The shipping address details.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"taxAmount in secondaryCurrency",
"type":"number",
"example":0
},
"cityTax":{
"description":"City Tax",
"type":"number",
"example":3.9
},
"amount":{
"description":"The total order amount.",
"type":"number",
"example":5.99
},
"valueAddedTax":{
"description":"Value Added Tax.",
"type":"number",
"example":0
},
"countyTax":{
"description":"County Tax.",
"type":"number",
"example":0
},
"isTaxIncluded":{
"description":"If Tax is included?",
"type":"boolean",
"example":false
},
"miscTax":{
"description":"Misc Tax.",
"type":"number",
"example":1.87
},
"districtTax":{
"description":"District Tax.",
"type":"number",
"example":0
},
"stateTax":{
"description":"State Tax.",
"type":"number",
"example":3.9
},
"countryTax":{
"description":"Country Tax.",
"type":"number",
"example":0
}
}
},
"lastName":{
"description":"The second name of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"Muir"
},
"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"
},
"shippingMethod":{
"description":"The shipping method details for the order.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"shippingTax":{
"type":"number"
},
"cost":{
"description":"The total cost of shipping.",
"type":"number"
},
"taxCode":{
"type":"string"
},
"value":{
"description":"The shipping method applied to the order.",
"type":"string"
},
"shippingMethodDescription":{
"type":"string"
}
}
},
"shippingGroupId":{
"description":"The shipping Group id",
"type":"string",
"example":"sg1234"
},
"store":{
"description":"The store is present in the request if the type is inStorePickupShippingGroup.",
"type":"object",
"properties":{
"country":{
"description":"The country of the store",
"type":"string",
"example":"USA"
},
"hours":{
"description":"The store's opening hours.",
"type":"string",
"example":"Mon - Sat 10AM - 7PM Sun 11AM - 6 PM"
},
"address3":{
"description":"Address line 3 of store.",
"type":"string",
"example":"Main Street"
},
"address2":{
"description":"Address line 2 of store.",
"type":"string",
"example":"4th Floor"
},
"city":{
"description":"The store's city.",
"type":"string",
"example":"Boston"
},
"address1":{
"description":"Address line 1 of store.",
"type":"string",
"example":"One Beacon Street"
},
"stateAddress":{
"description":"The store's state address.",
"type":"string",
"example":"MA"
},
"county":{
"description":"The store's county",
"type":"string",
"example":"MA"
},
"phoneNumber":{
"description":"The store's phone number.",
"type":"string",
"example":"(617) 386-1201"
},
"locationId":{
"description":"The store's location Id.",
"type":"string",
"example":"Boston138"
},
"name":{
"description":"The store's name.",
"type":"string",
"example":"Boston Store #138"
},
"faxNumber":{
"description":"Fax number.",
"type":"string",
"example":"(617) 386-1200"
},
"postCode":{
"description":"The store's post code.",
"type":"string",
"example":"2108"
},
"email":{
"description":"The store's email address.",
"type":"string",
"example":"store138@example.com"
}
}
},
"type":{
"description":"the shippingGroup type",
"type":"string",
"example":"inStorePickupShippingGroup"
},
"firstName":{
"description":"The first name of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"John"
},
"priceInfo":{
"description":"The price information.",
"type":"object",
"properties":{
"amount":{
"description":"The total order amount.",
"type":"number",
"example":24.99
},
"total":{
"description":"The order total.",
"type":"number",
"example":47.93
},
"lkpValExcludingFreeShip":{
"description":"The total shipping cost excluding items with free shipping.",
"type":"number",
"example":0
},
"shipping":{
"description":"The total shipping cost.",
"type":"number",
"example":14.95
},
"shippingSurchargeValue":{
"description":"Extra handling costs for shipping the products",
"type":"number",
"example":0
},
"tax":{
"description":"The total tax amount.",
"type":"number",
"example":7.99
},
"subTotal":{
"description":"Sub-total.",
"type":"number",
"example":24.99
},
"currencyCode":{
"description":"The currency code.",
"type":"string",
"example":"USD"
},
"totalWithoutTax":{
"description":"The total amount without tax.",
"type":"number",
"example":39.49
}
}
},
"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"
},
"total":{
"description":"The total price of the recurring charge.",
"type":"number"
},
"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"
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string"
}
}
}
},
"shipping":{
"description":"Cost of shipping the product.",
"type":"number"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"subTotal":{
"description":"The sub-total price of the recurring charge.",
"type":"number"
},
"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"
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string"
}
}
}
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"totalWithoutTax":{
"description":"Total of recurring amount without tax included.",
"type":"number"
}
}
},
"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":"integer",
"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":"integer",
"example":0
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"integer",
"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":"integer",
"example":0
},
"secondaryCurrencyTotalAdjustment":{
"type":"integer",
"example":0
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
}
}
},
"shippingAddress":{
"description":"The shipping address details.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name.",
"type":"string",
"example":"Muir"
},
"country":{
"description":"Country.",
"type":"string"
},
"address3":{
"description":"Address snippet.",
"type":"string"
},
"address2":{
"description":"Address snippet.",
"type":"string"
},
"city":{
"description":"City.",
"type":"string",
"example":"Cambridge"
},
"address1":{
"description":"Address snippet.",
"type":"string",
"example":"1 main st"
},
"prefix":{
"description":"Name prefix.",
"type":"string"
},
"companyName":{
"description":"Company name.",
"type":"string",
"example":"oracle"
},
"postalCode":{
"description":"Postal code.",
"type":"string",
"example":1122
},
"jobTitle":{
"description":"Job title.",
"type":"string",
"example":"manager"
},
"county":{
"description":"County.",
"type":"string"
},
"suffix":{
"description":"Name suffix.",
"type":"string"
},
"firstName":{
"description":"First name",
"type":"string",
"example":"John"
},
"phoneNumber":{
"description":"Phone number.",
"type":"string",
"example":1111111111
},
"faxNumber":{
"description":"Fax number.",
"type":"string"
},
"middleName":{
"description":"Middle name.",
"type":"string",
"example":"Morgan"
},
"state":{
"description":"State.",
"type":"string",
"example":"MA"
},
"email":{
"description":"Email address.",
"type":"string",
"example":"john.muir@oracle.com"
}
}
},
"items":{
"type":"array",
"items":{
"properties":{
"availablePickupDate":{
"format":"date-time",
"description":"The items available store pickup date.",
"type":"string",
"example":"2018-05-19T13:00:00.000Z"
},
"inventoryLocationId":{
"description":"Defines the inventory location that services the referenced commerce item.",
"type":"string"
},
"rawTotalPrice":{
"description":"The raw total price.",
"type":"number",
"example":24.99
},
"returnedQuantity":{
"type":"integer",
"example":0
},
"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":"Extra handling cost for shipping the product.",
"type":"number",
"example":0
},
"availabilityDate":{
"format":"date-time",
"description":"The availability date for preOrdered/backOrdered quantity.",
"type":"string",
"example":"2018-06-13T18:09:53.493Z"
},
"discountAmount":{
"description":"The monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal. (read-only)",
"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"
},
"key":{
"description":"Map key defined by external system.",
"type":"string"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the third party system.",
"type":"string"
}
}
}
},
"preOrderQuantity":{
"description":"The pre ordered quantity included.",
"type":"integer",
"example":0
},
"childItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
}
}
},
"configuratorId":{
"type":"string"
},
"commerceItemId":{
"description":"Commerce Item ID for this commerce item.",
"type":"string",
"example":"ci123545"
},
"price":{
"type":"number",
"example":24.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":"Whether is on sale.",
"type":"boolean",
"example":false
},
"actionCode":{
"description":"The action code that has been set on the item by the third party system.",
"type":"string"
},
"commerceId":{
"description":"Commerce ID for this commerce item.",
"type":"string",
"example":"ci12343"
},
"stateDetailsAsUser":{
"type":"string",
"example":"details of shippingItem"
},
"unitPrice":{
"type":"number",
"example":24.99
},
"amount":{
"description":"The monetary amount.",
"type":"number",
"example":24.99
},
"quantity":{
"description":"The number of items covered by this price info",
"type":"integer",
"example":1
},
"productId":{
"description":"The ID of the product.",
"type":"string",
"example":"product_9e"
},
"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":"integer",
"example":1
},
"tax":{
"type":"number",
"example":0
},
"orderDiscountShare":{
"type":"integer",
"example":0
},
"detailedUnitPrice":{
"type":"number",
"example":24.99
},
"currencyCode":{
"type":"string",
"example":"USD"
}
}
}
},
"preferredPickupDate":{
"format":"date-time",
"description":"The items preferred store pickup date.",
"type":"string",
"example":"2018-05-19T13:00:00.000Z"
},
"catRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string",
"example":"Sku_9F"
},
"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":"integer",
"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"
}
}
}
}
}
}
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"backOrderQuantity":{
"description":"The back ordered quantity included.",
"type":"integer",
"example":0
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number",
"example":24.99
},
"status":{
"type":"string",
"example":"INITIAL"
}
}
}
},
"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"
}
}
}
},
"lastModifiedTime":{
"description":"The last modified time in long seconds",
"type":"integer"
},
"cartUrl":{
"description":"The cart url",
"type":"string"
},
"creationTime":{
"description":"The creation time in long seconds",
"type":"integer"
},
"lastModifiedDate":{
"description":"The last modified date",
"type":"string"
},
"orderId":{
"description":"The order id",
"type":"string"
},
"creationSiteId":{
"description":"The ID of the site on which the order was created on. This may differ to siteId value if the site is part of a cart sharing group.",
"type":"string"
},
"shippingMethod":{
"description":"The shipping method details for the order.",
"type":"object",
"properties":{
"cost":{
"description":"The total cost of shipping.",
"type":"number"
},
"value":{
"description":"The shipping method applied to the order.",
"type":"string"
}
}
},
"payments":{
"description":"The payment information.",
"type":"array",
"items":{
"type":"object",
"properties":{
}
}
},
"profile":{
"description":"The details of customer profile created on Oracle Commerce Cloud. This includes the email, first name and last name of the customer.",
"type":"object",
"properties":{
"lastName":{
"description":"Last Name",
"type":"string"
},
"firstName":{
"description":"First Name",
"type":"string"
},
"customerContactId":{
"description":"The external customer contact id.",
"type":"string"
},
"creditCards":{
"type":"object",
"properties":{
"cardType":{
"type":"object",
"properties":{
"expirationYear":{
"type":"string"
},
"tokenExpiryDate":{
"type":"string"
},
"gatewayConfigId":{
"type":"string"
},
"expirationMonth":{
"type":"string"
},
"source":{
"type":"string"
},
"creditCardType":{
"type":"string"
},
"token":{
"type":"string"
},
"iin":{
"type":"string"
},
"cardProps":{
"type":"object",
"properties":{
}
},
"nameOnCard":{
"type":"string"
},
"creditCardNumber":{
"type":"string"
},
"tokenCreatedDate":{
"type":"string"
},
"cardSavedDate":{
"type":"string"
},
"id":{
"type":"string"
},
"billingAddress":{
"description":"Default billing address of the profile",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the billing address",
"type":"string"
},
"firstName":{
"description":"the first name of the billing address",
"type":"string"
},
"externalAddressId":{
"description":"External ID of the address",
"type":"string"
},
"country":{
"description":"the country of the billing address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the billing address",
"type":"string"
},
"address2":{
"description":"the address2 of the billing address",
"type":"string"
},
"city":{
"description":"the city of the billing address",
"type":"string"
},
"address1":{
"description":"the address1 of the billing address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the billing address",
"type":"string"
},
"county":{
"description":"the county of the billing address",
"type":"string"
},
"repositoryId":{
"description":"the id of the billing address",
"type":"string"
},
"state":{
"description":"the state of the billing address",
"type":"string"
}
}
},
"expirationDayOfMonth":{
"type":"string"
}
}
}
}
},
"loyaltyPrograms":{
"description":"Loyalty Programs Information",
"type":"array",
"items":{
"type":"object",
"properties":{
"programName":{
"description":"programName of Loyalty Program",
"type":"string"
},
"repositoryId":{
"description":"repository Id",
"type":"string"
},
"membershipId":{
"description":"membershipId of the profile.",
"type":"string"
},
"programId":{
"description":"programId of Loyalty Program",
"type":"string"
},
"status":{
"description":"status of Enrollment",
"type":"string"
}
}
}
},
"receiveEmail":{
"description":"If User wants email notification?",
"type":"string"
},
"id":{
"description":"The profile-id of the order",
"type":"string"
},
"locale":{
"description":"Locale",
"type":"string"
},
"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"
}
}
},
"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"
},
"GDPRProfileP13nConsentGranted":{
"description":"If user has given consent for his/her profile information to be used for personalization purposes.",
"type":"boolean"
},
"receiveEmail":{
"description":"Indicates whether the user should receive marketing emails on the current site. Can be yes or no.",
"type":"string"
},
"receiveEmailDate":{
"description":"The date on which email marketing consent was granted by the user.",
"type":"string"
}
}
}
}
}
},
"email":{
"description":"email of the user.",
"type":"string"
},
"daytimeTelephoneNumber":{
"description":"The telephone number",
"type":"string"
}
}
},
"orderStatus":{
"description":"Status of the order",
"type":"string"
},
"cartName":{
"description":"Cart name for this order.",
"type":"string"
},
"creationDate":{
"description":"The creation date in ISO format",
"type":"string"
},
"orderProfileId":{
"description":"The profile-id of the order",
"type":"string"
},
"priceInfo":{
"description":"The price information.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"The secondary currency tax amount.",
"type":"number"
},
"amount":{
"description":"The total order amount.",
"type":"number"
},
"total":{
"description":"The order total.",
"type":"number"
},
"secondaryCurrencyShippingAmount":{
"description":"The secondary currency shipping amount.",
"type":"number"
},
"shipping":{
"description":"The total shipping cost.",
"type":"number"
},
"secondaryCurrencyTotal":{
"description":"The secondary currency total amount..",
"type":"number"
},
"primaryCurrencyTotal":{
"description":"The primary currency total amount..",
"type":"number"
},
"shippingSurchargeValue":{
"description":"Extra handling costs for shipping the products",
"type":"number"
},
"tax":{
"description":"The total tax amount.",
"type":"number"
},
"subTotal":{
"description":"Sub-total.",
"type":"number"
},
"currencyCode":{
"description":"The currency code.",
"type":"string"
},
"totalWithoutTax":{
"description":"The total amount without tax.",
"type":"number"
}
}
},
"site":{
"type":"object",
"properties":{
"siteURL":{
"description":"The production URL of the site where the order is placed",
"type":"string"
},
"siteName":{
"description":"The name of the site where order is placed",
"type":"string"
}
}
},
"discountInfo":{
"description":"The discount information.",
"type":"object",
"properties":{
"orderCouponsMap":{
"description":"The list of all the coupons with the order.",
"type":"object"
},
"orderDiscount":{
"description":"The order discount.",
"type":"number"
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"number"
},
"orderImplicitDiscountList":{
"description":"Order Implicit Discount List.",
"type":"array",
"items":{
"type":"object",
"properties":{
}
}
},
"unclaimedCouponsMap":{
"description":"The unclaimed coupons with the order.",
"type":"object"
}
}
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"total":{
"description":"The total price of the recurring charge.",
"type":"number"
},
"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"
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string"
}
}
}
},
"shipping":{
"description":"Cost of shipping the product.",
"type":"number"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"subTotal":{
"description":"The sub-total price of the recurring charge.",
"type":"number"
},
"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"
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string"
}
}
}
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"totalWithoutTax":{
"description":"Total of recurring amount without tax included.",
"type":"number"
}
}
},
"exchangeRate":{
"description":"exchangeRate",
"type":"number"
},
"shoppingCart":{
"description":"The shopping-cart or order contents of the current order.",
"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":{
"description":"Total no of items.",
"type":"integer"
},
"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":{
"unitPrice":{
"description":"The unit price of the product.",
"type":"number"
},
"primaryThumbImageURL":{
"description":"Image url of the product",
"type":"string"
},
"quantity":{
"description":"The quantity of the product.",
"type":"integer"
},
"productId":{
"description":"ID of the product in the cart.",
"type":"string"
},
"rawTotalPrice":{
"description":"The raw price of the product.",
"type":"number"
},
"dynamicProperties":{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string"
},
"label":{
"description":"The dynamic property label.",
"type":"string"
},
"value":{
"description":"The dynamic property value.",
"type":"string"
}
}
}
},
"detailedItemPriceInfo":{
"description":"The unit price of the product.",
"type":"array",
"items":{
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"taxAmount in secondaryCurrency",
"type":"number"
},
"discounted":{
"description":"If discounted?",
"type":"boolean"
},
"amount":{
"description":"The total order amount.",
"type":"number"
},
"quantity":{
"description":"Quantity.",
"type":"integer"
},
"tax":{
"description":"The total tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order discount share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price.",
"type":"number"
},
"currencyCode":{
"description":"The currency code.",
"type":"string"
}
}
}
},
"displayName":{
"description":"The name of the product.",
"type":"string"
},
"shippingSurchargeValue":{
"description":"tax applied on shipping",
"type":"number"
},
"isItemValid":{
"description":"if item is valid",
"type":"boolean"
},
"description":{
"description":"Description about the product.",
"type":"string"
},
"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":{
"properties":{
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"addOnItem":{
"description":"Whether this child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"quantity":{
"description":"The quantity of this child item included.",
"type":"integer"
},
"productId":{
"description":"The product ID of the child item.",
"type":"string"
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this child commerce item references. Typically the SKU id.",
"type":"string"
}
}
}
},
"catRefId":{
"description":"The category to which the product belongs.",
"type":"string"
},
"configuratorId":{
"description":"Configuration ID for this commerce item.",
"type":"string"
},
"discountInfo":{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
}
}
},
"price":{
"description":"The actual price of the product.",
"type":"number"
},
"variant":{
"description":"List of variants for the product.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value.",
"type":"string"
},
"optionName":{
"description":"The variant option name.",
"type":"string"
}
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"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":"if item is on sale",
"type":"boolean"
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
}
}
}
}
}
},
"shippingAddress":{
"description":"The shipping address details.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name.",
"type":"string"
},
"country":{
"description":"Country.",
"type":"string"
},
"address3":{
"description":"Address snippet.",
"type":"string"
},
"address2":{
"description":"Address snippet.",
"type":"string"
},
"city":{
"description":"City.",
"type":"string"
},
"address1":{
"description":"Address snippet.",
"type":"string"
},
"prefix":{
"description":"Name prefix.",
"type":"string"
},
"companyName":{
"description":"Company name.",
"type":"string"
},
"postalCode":{
"description":"Postal code.",
"type":"string"
},
"jobTitle":{
"description":"Job title.",
"type":"string"
},
"county":{
"description":"County.",
"type":"string"
},
"suffix":{
"description":"Name suffix.",
"type":"string"
},
"firstName":{
"description":"First name",
"type":"string"
},
"phoneNumber":{
"description":"Phone number.",
"type":"string"
},
"faxNumber":{
"description":"Fax number.",
"type":"string"
},
"middleName":{
"description":"Middle name.",
"type":"string"
},
"state":{
"description":"State.",
"type":"string"
},
"email":{
"description":"Email address.",
"type":"string"
}
}
},
"siteId":{
"description":"The id of the site associated with this cart",
"type":"string"
}
}
}
Nested Schema : discountInfo
Type: object
The discount information.
Show Source
{
"description":"The discount information.",
"type":"object",
"properties":{
"orderCouponsMap":{
"description":"The list of all the coupons with the order.",
"type":"object"
},
"orderDiscount":{
"description":"The order discount.",
"type":"number"
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"number"
},
"orderImplicitDiscountList":{
"description":"Order Implicit Discount List.",
"type":"array",
"items":{
"type":"object",
"properties":{
}
}
},
"unclaimedCouponsMap":{
"description":"The unclaimed coupons with the order.",
"type":"object"
}
}
}
Nested Schema : payments
Type: array
The payment information.
Show Source
{
"description":"The payment information.",
"type":"array",
"items":{
"type":"object",
"properties":{
}
}
}
Nested Schema : priceInfo
Type: object
The price information.
Show Source
{
"description":"The price information.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"The secondary currency tax amount.",
"type":"number"
},
"amount":{
"description":"The total order amount.",
"type":"number"
},
"total":{
"description":"The order total.",
"type":"number"
},
"secondaryCurrencyShippingAmount":{
"description":"The secondary currency shipping amount.",
"type":"number"
},
"shipping":{
"description":"The total shipping cost.",
"type":"number"
},
"secondaryCurrencyTotal":{
"description":"The secondary currency total amount..",
"type":"number"
},
"primaryCurrencyTotal":{
"description":"The primary currency total amount..",
"type":"number"
},
"shippingSurchargeValue":{
"description":"Extra handling costs for shipping the products",
"type":"number"
},
"tax":{
"description":"The total tax amount.",
"type":"number"
},
"subTotal":{
"description":"Sub-total.",
"type":"number"
},
"currencyCode":{
"description":"The currency code.",
"type":"string"
},
"totalWithoutTax":{
"description":"The total amount without tax.",
"type":"number"
}
}
}
Nested Schema : profile
Type: object
The details of customer profile created on Oracle Commerce Cloud. This includes the email, first name and last name of the customer.
Show Source
{
"description":"The details of customer profile created on Oracle Commerce Cloud. This includes the email, first name and last name of the customer.",
"type":"object",
"properties":{
"lastName":{
"description":"Last Name",
"type":"string"
},
"firstName":{
"description":"First Name",
"type":"string"
},
"customerContactId":{
"description":"The external customer contact id.",
"type":"string"
},
"creditCards":{
"type":"object",
"properties":{
"cardType":{
"type":"object",
"properties":{
"expirationYear":{
"type":"string"
},
"tokenExpiryDate":{
"type":"string"
},
"gatewayConfigId":{
"type":"string"
},
"expirationMonth":{
"type":"string"
},
"source":{
"type":"string"
},
"creditCardType":{
"type":"string"
},
"token":{
"type":"string"
},
"iin":{
"type":"string"
},
"cardProps":{
"type":"object",
"properties":{
}
},
"nameOnCard":{
"type":"string"
},
"creditCardNumber":{
"type":"string"
},
"tokenCreatedDate":{
"type":"string"
},
"cardSavedDate":{
"type":"string"
},
"id":{
"type":"string"
},
"billingAddress":{
"description":"Default billing address of the profile",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the billing address",
"type":"string"
},
"firstName":{
"description":"the first name of the billing address",
"type":"string"
},
"externalAddressId":{
"description":"External ID of the address",
"type":"string"
},
"country":{
"description":"the country of the billing address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the billing address",
"type":"string"
},
"address2":{
"description":"the address2 of the billing address",
"type":"string"
},
"city":{
"description":"the city of the billing address",
"type":"string"
},
"address1":{
"description":"the address1 of the billing address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the billing address",
"type":"string"
},
"county":{
"description":"the county of the billing address",
"type":"string"
},
"repositoryId":{
"description":"the id of the billing address",
"type":"string"
},
"state":{
"description":"the state of the billing address",
"type":"string"
}
}
},
"expirationDayOfMonth":{
"type":"string"
}
}
}
}
},
"loyaltyPrograms":{
"description":"Loyalty Programs Information",
"type":"array",
"items":{
"type":"object",
"properties":{
"programName":{
"description":"programName of Loyalty Program",
"type":"string"
},
"repositoryId":{
"description":"repository Id",
"type":"string"
},
"membershipId":{
"description":"membershipId of the profile.",
"type":"string"
},
"programId":{
"description":"programId of Loyalty Program",
"type":"string"
},
"status":{
"description":"status of Enrollment",
"type":"string"
}
}
}
},
"receiveEmail":{
"description":"If User wants email notification?",
"type":"string"
},
"id":{
"description":"The profile-id of the order",
"type":"string"
},
"locale":{
"description":"Locale",
"type":"string"
},
"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"
}
}
},
"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"
},
"GDPRProfileP13nConsentGranted":{
"description":"If user has given consent for his/her profile information to be used for personalization purposes.",
"type":"boolean"
},
"receiveEmail":{
"description":"Indicates whether the user should receive marketing emails on the current site. Can be yes or no.",
"type":"string"
},
"receiveEmailDate":{
"description":"The date on which email marketing consent was granted by the user.",
"type":"string"
}
}
}
}
}
},
"email":{
"description":"email of the user.",
"type":"string"
},
"daytimeTelephoneNumber":{
"description":"The telephone number",
"type":"string"
}
}
}
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"
},
"total":{
"description":"The total price of the recurring charge.",
"type":"number"
},
"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"
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string"
}
}
}
},
"shipping":{
"description":"Cost of shipping the product.",
"type":"number"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"subTotal":{
"description":"The sub-total price of the recurring charge.",
"type":"number"
},
"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"
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string"
}
}
}
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"totalWithoutTax":{
"description":"Total of recurring amount without tax included.",
"type":"number"
}
}
}
Nested Schema : shippingAddress
Type: object
The shipping address details.
Show Source
{
"description":"The shipping address details.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name.",
"type":"string"
},
"country":{
"description":"Country.",
"type":"string"
},
"address3":{
"description":"Address snippet.",
"type":"string"
},
"address2":{
"description":"Address snippet.",
"type":"string"
},
"city":{
"description":"City.",
"type":"string"
},
"address1":{
"description":"Address snippet.",
"type":"string"
},
"prefix":{
"description":"Name prefix.",
"type":"string"
},
"companyName":{
"description":"Company name.",
"type":"string"
},
"postalCode":{
"description":"Postal code.",
"type":"string"
},
"jobTitle":{
"description":"Job title.",
"type":"string"
},
"county":{
"description":"County.",
"type":"string"
},
"suffix":{
"description":"Name suffix.",
"type":"string"
},
"firstName":{
"description":"First name",
"type":"string"
},
"phoneNumber":{
"description":"Phone number.",
"type":"string"
},
"faxNumber":{
"description":"Fax number.",
"type":"string"
},
"middleName":{
"description":"Middle name.",
"type":"string"
},
"state":{
"description":"State.",
"type":"string"
},
"email":{
"description":"Email address.",
"type":"string"
}
}
}
Nested Schema : shippingGroups
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"taxPriceInfo":{
"description":"The shipping address details.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"taxAmount in secondaryCurrency",
"type":"number",
"example":0
},
"cityTax":{
"description":"City Tax",
"type":"number",
"example":3.9
},
"amount":{
"description":"The total order amount.",
"type":"number",
"example":5.99
},
"valueAddedTax":{
"description":"Value Added Tax.",
"type":"number",
"example":0
},
"countyTax":{
"description":"County Tax.",
"type":"number",
"example":0
},
"isTaxIncluded":{
"description":"If Tax is included?",
"type":"boolean",
"example":false
},
"miscTax":{
"description":"Misc Tax.",
"type":"number",
"example":1.87
},
"districtTax":{
"description":"District Tax.",
"type":"number",
"example":0
},
"stateTax":{
"description":"State Tax.",
"type":"number",
"example":3.9
},
"countryTax":{
"description":"Country Tax.",
"type":"number",
"example":0
}
}
},
"lastName":{
"description":"The second name of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"Muir"
},
"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"
},
"shippingMethod":{
"description":"The shipping method details for the order.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"shippingTax":{
"type":"number"
},
"cost":{
"description":"The total cost of shipping.",
"type":"number"
},
"taxCode":{
"type":"string"
},
"value":{
"description":"The shipping method applied to the order.",
"type":"string"
},
"shippingMethodDescription":{
"type":"string"
}
}
},
"shippingGroupId":{
"description":"The shipping Group id",
"type":"string",
"example":"sg1234"
},
"store":{
"description":"The store is present in the request if the type is inStorePickupShippingGroup.",
"type":"object",
"properties":{
"country":{
"description":"The country of the store",
"type":"string",
"example":"USA"
},
"hours":{
"description":"The store's opening hours.",
"type":"string",
"example":"Mon - Sat 10AM - 7PM Sun 11AM - 6 PM"
},
"address3":{
"description":"Address line 3 of store.",
"type":"string",
"example":"Main Street"
},
"address2":{
"description":"Address line 2 of store.",
"type":"string",
"example":"4th Floor"
},
"city":{
"description":"The store's city.",
"type":"string",
"example":"Boston"
},
"address1":{
"description":"Address line 1 of store.",
"type":"string",
"example":"One Beacon Street"
},
"stateAddress":{
"description":"The store's state address.",
"type":"string",
"example":"MA"
},
"county":{
"description":"The store's county",
"type":"string",
"example":"MA"
},
"phoneNumber":{
"description":"The store's phone number.",
"type":"string",
"example":"(617) 386-1201"
},
"locationId":{
"description":"The store's location Id.",
"type":"string",
"example":"Boston138"
},
"name":{
"description":"The store's name.",
"type":"string",
"example":"Boston Store #138"
},
"faxNumber":{
"description":"Fax number.",
"type":"string",
"example":"(617) 386-1200"
},
"postCode":{
"description":"The store's post code.",
"type":"string",
"example":"2108"
},
"email":{
"description":"The store's email address.",
"type":"string",
"example":"store138@example.com"
}
}
},
"type":{
"description":"the shippingGroup type",
"type":"string",
"example":"inStorePickupShippingGroup"
},
"firstName":{
"description":"The first name of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"John"
},
"priceInfo":{
"description":"The price information.",
"type":"object",
"properties":{
"amount":{
"description":"The total order amount.",
"type":"number",
"example":24.99
},
"total":{
"description":"The order total.",
"type":"number",
"example":47.93
},
"lkpValExcludingFreeShip":{
"description":"The total shipping cost excluding items with free shipping.",
"type":"number",
"example":0
},
"shipping":{
"description":"The total shipping cost.",
"type":"number",
"example":14.95
},
"shippingSurchargeValue":{
"description":"Extra handling costs for shipping the products",
"type":"number",
"example":0
},
"tax":{
"description":"The total tax amount.",
"type":"number",
"example":7.99
},
"subTotal":{
"description":"Sub-total.",
"type":"number",
"example":24.99
},
"currencyCode":{
"description":"The currency code.",
"type":"string",
"example":"USD"
},
"totalWithoutTax":{
"description":"The total amount without tax.",
"type":"number",
"example":39.49
}
}
},
"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"
},
"total":{
"description":"The total price of the recurring charge.",
"type":"number"
},
"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"
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string"
}
}
}
},
"shipping":{
"description":"Cost of shipping the product.",
"type":"number"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"subTotal":{
"description":"The sub-total price of the recurring charge.",
"type":"number"
},
"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"
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string"
}
}
}
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"totalWithoutTax":{
"description":"Total of recurring amount without tax included.",
"type":"number"
}
}
},
"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":"integer",
"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":"integer",
"example":0
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"integer",
"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":"integer",
"example":0
},
"secondaryCurrencyTotalAdjustment":{
"type":"integer",
"example":0
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
}
}
},
"shippingAddress":{
"description":"The shipping address details.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name.",
"type":"string",
"example":"Muir"
},
"country":{
"description":"Country.",
"type":"string"
},
"address3":{
"description":"Address snippet.",
"type":"string"
},
"address2":{
"description":"Address snippet.",
"type":"string"
},
"city":{
"description":"City.",
"type":"string",
"example":"Cambridge"
},
"address1":{
"description":"Address snippet.",
"type":"string",
"example":"1 main st"
},
"prefix":{
"description":"Name prefix.",
"type":"string"
},
"companyName":{
"description":"Company name.",
"type":"string",
"example":"oracle"
},
"postalCode":{
"description":"Postal code.",
"type":"string",
"example":1122
},
"jobTitle":{
"description":"Job title.",
"type":"string",
"example":"manager"
},
"county":{
"description":"County.",
"type":"string"
},
"suffix":{
"description":"Name suffix.",
"type":"string"
},
"firstName":{
"description":"First name",
"type":"string",
"example":"John"
},
"phoneNumber":{
"description":"Phone number.",
"type":"string",
"example":1111111111
},
"faxNumber":{
"description":"Fax number.",
"type":"string"
},
"middleName":{
"description":"Middle name.",
"type":"string",
"example":"Morgan"
},
"state":{
"description":"State.",
"type":"string",
"example":"MA"
},
"email":{
"description":"Email address.",
"type":"string",
"example":"john.muir@oracle.com"
}
}
},
"items":{
"type":"array",
"items":{
"properties":{
"availablePickupDate":{
"format":"date-time",
"description":"The items available store pickup date.",
"type":"string",
"example":"2018-05-19T13:00:00.000Z"
},
"inventoryLocationId":{
"description":"Defines the inventory location that services the referenced commerce item.",
"type":"string"
},
"rawTotalPrice":{
"description":"The raw total price.",
"type":"number",
"example":24.99
},
"returnedQuantity":{
"type":"integer",
"example":0
},
"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":"Extra handling cost for shipping the product.",
"type":"number",
"example":0
},
"availabilityDate":{
"format":"date-time",
"description":"The availability date for preOrdered/backOrdered quantity.",
"type":"string",
"example":"2018-06-13T18:09:53.493Z"
},
"discountAmount":{
"description":"The monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal. (read-only)",
"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"
},
"key":{
"description":"Map key defined by external system.",
"type":"string"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the third party system.",
"type":"string"
}
}
}
},
"preOrderQuantity":{
"description":"The pre ordered quantity included.",
"type":"integer",
"example":0
},
"childItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
}
}
},
"configuratorId":{
"type":"string"
},
"commerceItemId":{
"description":"Commerce Item ID for this commerce item.",
"type":"string",
"example":"ci123545"
},
"price":{
"type":"number",
"example":24.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":"Whether is on sale.",
"type":"boolean",
"example":false
},
"actionCode":{
"description":"The action code that has been set on the item by the third party system.",
"type":"string"
},
"commerceId":{
"description":"Commerce ID for this commerce item.",
"type":"string",
"example":"ci12343"
},
"stateDetailsAsUser":{
"type":"string",
"example":"details of shippingItem"
},
"unitPrice":{
"type":"number",
"example":24.99
},
"amount":{
"description":"The monetary amount.",
"type":"number",
"example":24.99
},
"quantity":{
"description":"The number of items covered by this price info",
"type":"integer",
"example":1
},
"productId":{
"description":"The ID of the product.",
"type":"string",
"example":"product_9e"
},
"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":"integer",
"example":1
},
"tax":{
"type":"number",
"example":0
},
"orderDiscountShare":{
"type":"integer",
"example":0
},
"detailedUnitPrice":{
"type":"number",
"example":24.99
},
"currencyCode":{
"type":"string",
"example":"USD"
}
}
}
},
"preferredPickupDate":{
"format":"date-time",
"description":"The items preferred store pickup date.",
"type":"string",
"example":"2018-05-19T13:00:00.000Z"
},
"catRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string",
"example":"Sku_9F"
},
"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":"integer",
"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"
}
}
}
}
}
}
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"backOrderQuantity":{
"description":"The back ordered quantity included.",
"type":"integer",
"example":0
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number",
"example":24.99
},
"status":{
"type":"string",
"example":"INITIAL"
}
}
}
},
"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 : shippingMethod
Type: object
The shipping method details for the order.
Show Source
{
"description":"The shipping method details for the order.",
"type":"object",
"properties":{
"cost":{
"description":"The total cost of shipping.",
"type":"number"
},
"value":{
"description":"The shipping method applied to the order.",
"type":"string"
}
}
}
Nested Schema : shoppingCart
Type: object
The shopping-cart or order contents of the current order.
Show Source
{
"description":"The shopping-cart or order contents of the current order.",
"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":{
"description":"Total no of items.",
"type":"integer"
},
"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":{
"unitPrice":{
"description":"The unit price of the product.",
"type":"number"
},
"primaryThumbImageURL":{
"description":"Image url of the product",
"type":"string"
},
"quantity":{
"description":"The quantity of the product.",
"type":"integer"
},
"productId":{
"description":"ID of the product in the cart.",
"type":"string"
},
"rawTotalPrice":{
"description":"The raw price of the product.",
"type":"number"
},
"dynamicProperties":{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string"
},
"label":{
"description":"The dynamic property label.",
"type":"string"
},
"value":{
"description":"The dynamic property value.",
"type":"string"
}
}
}
},
"detailedItemPriceInfo":{
"description":"The unit price of the product.",
"type":"array",
"items":{
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"taxAmount in secondaryCurrency",
"type":"number"
},
"discounted":{
"description":"If discounted?",
"type":"boolean"
},
"amount":{
"description":"The total order amount.",
"type":"number"
},
"quantity":{
"description":"Quantity.",
"type":"integer"
},
"tax":{
"description":"The total tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order discount share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price.",
"type":"number"
},
"currencyCode":{
"description":"The currency code.",
"type":"string"
}
}
}
},
"displayName":{
"description":"The name of the product.",
"type":"string"
},
"shippingSurchargeValue":{
"description":"tax applied on shipping",
"type":"number"
},
"isItemValid":{
"description":"if item is valid",
"type":"boolean"
},
"description":{
"description":"Description about the product.",
"type":"string"
},
"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":{
"properties":{
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"addOnItem":{
"description":"Whether this child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"quantity":{
"description":"The quantity of this child item included.",
"type":"integer"
},
"productId":{
"description":"The product ID of the child item.",
"type":"string"
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this child commerce item references. Typically the SKU id.",
"type":"string"
}
}
}
},
"catRefId":{
"description":"The category to which the product belongs.",
"type":"string"
},
"configuratorId":{
"description":"Configuration ID for this commerce item.",
"type":"string"
},
"discountInfo":{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
}
}
},
"price":{
"description":"The actual price of the product.",
"type":"number"
},
"variant":{
"description":"List of variants for the product.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value.",
"type":"string"
},
"optionName":{
"description":"The variant option name.",
"type":"string"
}
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"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":"if item is on sale",
"type":"boolean"
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
}
}
}
}
}
}
Nested Schema : site
Type: object
Show Source
{
"type":"object",
"properties":{
"siteURL":{
"description":"The production URL of the site where the order is placed",
"type":"string"
},
"siteName":{
"description":"The name of the site where order is placed",
"type":"string"
}
}
}
Nested Schema : taxPriceInfo
Type: object
The shipping address details.
Show Source
{
"description":"The shipping address details.",
"type":"object",
"properties":{
"cityTax":{
"description":"City Tax",
"type":"number"
},
"secondaryCurrencyTaxAmount":{
"description":"taxAmount in secondaryCurrency",
"type":"number"
},
"amount":{
"description":"The total order amount.",
"type":"number"
},
"valueAddedTax":{
"description":"Value Added Tax.",
"type":"number"
},
"countyTax":{
"description":"County Tax.",
"type":"number"
},
"isTaxIncluded":{
"description":"If Tax is included?",
"type":"boolean"
},
"miscTax":{
"description":"Misc Tax.",
"type":"number"
},
"districtTax":{
"description":"District Tax.",
"type":"number"
},
"stateTax":{
"description":"State Tax.",
"type":"number"
},
"countryTax":{
"description":"Country Tax.",
"type":"number"
}
}
}
Nested Schema : orderCouponsMap
Type: object
The list of all the coupons with the order.
Nested Schema : orderImplicitDiscountList
Type: array
Order Implicit Discount List.
Show Source
{
"description":"Order Implicit Discount List.",
"type":"array",
"items":{
"type":"object",
"properties":{
}
}
}
Nested Schema : unclaimedCouponsMap
Type: object
The unclaimed coupons with the order.
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
}
}
Nested Schema : creditCards
Type: object
Show Source
{
"type":"object",
"properties":{
"cardType":{
"type":"object",
"properties":{
"expirationYear":{
"type":"string"
},
"tokenExpiryDate":{
"type":"string"
},
"gatewayConfigId":{
"type":"string"
},
"expirationMonth":{
"type":"string"
},
"source":{
"type":"string"
},
"creditCardType":{
"type":"string"
},
"token":{
"type":"string"
},
"iin":{
"type":"string"
},
"cardProps":{
"type":"object",
"properties":{
}
},
"nameOnCard":{
"type":"string"
},
"creditCardNumber":{
"type":"string"
},
"tokenCreatedDate":{
"type":"string"
},
"cardSavedDate":{
"type":"string"
},
"id":{
"type":"string"
},
"billingAddress":{
"description":"Default billing address of the profile",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the billing address",
"type":"string"
},
"firstName":{
"description":"the first name of the billing address",
"type":"string"
},
"externalAddressId":{
"description":"External ID of the address",
"type":"string"
},
"country":{
"description":"the country of the billing address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the billing address",
"type":"string"
},
"address2":{
"description":"the address2 of the billing address",
"type":"string"
},
"city":{
"description":"the city of the billing address",
"type":"string"
},
"address1":{
"description":"the address1 of the billing address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the billing address",
"type":"string"
},
"county":{
"description":"the county of the billing address",
"type":"string"
},
"repositoryId":{
"description":"the id of the billing address",
"type":"string"
},
"state":{
"description":"the state of the billing address",
"type":"string"
}
}
},
"expirationDayOfMonth":{
"type":"string"
}
}
}
}
}
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"
},
"repositoryId":{
"description":"repository Id",
"type":"string"
},
"membershipId":{
"description":"membershipId of the profile.",
"type":"string"
},
"programId":{
"description":"programId of Loyalty Program",
"type":"string"
},
"status":{
"description":"status of Enrollment",
"type":"string"
}
}
}
}
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"
}
}
},
"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"
},
"GDPRProfileP13nConsentGranted":{
"description":"If user has given consent for his/her profile information to be used for personalization purposes.",
"type":"boolean"
},
"receiveEmail":{
"description":"Indicates whether the user should receive marketing emails on the current site. Can be yes or no.",
"type":"string"
},
"receiveEmailDate":{
"description":"The date on which email marketing consent was granted by the user.",
"type":"string"
}
}
}
}
}
}
Nested Schema : cardType
Type: object
Show Source
{
"type":"object",
"properties":{
"expirationYear":{
"type":"string"
},
"tokenExpiryDate":{
"type":"string"
},
"gatewayConfigId":{
"type":"string"
},
"expirationMonth":{
"type":"string"
},
"source":{
"type":"string"
},
"creditCardType":{
"type":"string"
},
"token":{
"type":"string"
},
"iin":{
"type":"string"
},
"cardProps":{
"type":"object",
"properties":{
}
},
"nameOnCard":{
"type":"string"
},
"creditCardNumber":{
"type":"string"
},
"tokenCreatedDate":{
"type":"string"
},
"cardSavedDate":{
"type":"string"
},
"id":{
"type":"string"
},
"billingAddress":{
"description":"Default billing address of the profile",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the billing address",
"type":"string"
},
"firstName":{
"description":"the first name of the billing address",
"type":"string"
},
"externalAddressId":{
"description":"External ID of the address",
"type":"string"
},
"country":{
"description":"the country of the billing address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the billing address",
"type":"string"
},
"address2":{
"description":"the address2 of the billing address",
"type":"string"
},
"city":{
"description":"the city of the billing address",
"type":"string"
},
"address1":{
"description":"the address1 of the billing address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the billing address",
"type":"string"
},
"county":{
"description":"the county of the billing address",
"type":"string"
},
"repositoryId":{
"description":"the id of the billing address",
"type":"string"
},
"state":{
"description":"the state of the billing address",
"type":"string"
}
}
},
"expirationDayOfMonth":{
"type":"string"
}
}
}
Nested Schema : billingAddress
Type: object
Default billing address of the profile
Show Source
{
"description":"Default billing address of the profile",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the billing address",
"type":"string"
},
"firstName":{
"description":"the first name of the billing address",
"type":"string"
},
"externalAddressId":{
"description":"External ID of the address",
"type":"string"
},
"country":{
"description":"the country of the billing address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the billing address",
"type":"string"
},
"address2":{
"description":"the address2 of the billing address",
"type":"string"
},
"city":{
"description":"the city of the billing address",
"type":"string"
},
"address1":{
"description":"the address1 of the billing address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the billing address",
"type":"string"
},
"county":{
"description":"the county of the billing address",
"type":"string"
},
"repositoryId":{
"description":"the id of the billing address",
"type":"string"
},
"state":{
"description":"the state of the billing address",
"type":"string"
}
}
}
Nested Schema : cardProps
Type: object
Show Source
{
"type":"object",
"properties":{
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"programName":{
"description":"programName of Loyalty Program",
"type":"string"
},
"repositoryId":{
"description":"repository Id",
"type":"string"
},
"membershipId":{
"description":"membershipId of the profile.",
"type":"string"
},
"programId":{
"description":"programId of Loyalty Program",
"type":"string"
},
"status":{
"description":"status of Enrollment",
"type":"string"
}
}
}
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"
}
}
},
"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"
},
"GDPRProfileP13nConsentGranted":{
"description":"If user has given consent for his/her profile information to be used for personalization purposes.",
"type":"boolean"
},
"receiveEmail":{
"description":"Indicates whether the user should receive marketing emails on the current site. Can be yes or no.",
"type":"string"
},
"receiveEmailDate":{
"description":"The date on which email marketing consent was granted by the user.",
"type":"string"
}
}
}
}
}
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"
},
"GDPRProfileP13nConsentGranted":{
"description":"If user has given consent for his/her profile information to be used for personalization purposes.",
"type":"boolean"
},
"receiveEmail":{
"description":"Indicates whether the user should receive marketing emails on the current site. Can be yes or no.",
"type":"string"
},
"receiveEmailDate":{
"description":"The date on which email marketing consent was granted by the user.",
"type":"string"
}
}
}
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"
}
}
}
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"
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string"
}
}
}
}
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"
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"taxPriceInfo":{
"description":"The shipping address details.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"taxAmount in secondaryCurrency",
"type":"number",
"example":0
},
"cityTax":{
"description":"City Tax",
"type":"number",
"example":3.9
},
"amount":{
"description":"The total order amount.",
"type":"number",
"example":5.99
},
"valueAddedTax":{
"description":"Value Added Tax.",
"type":"number",
"example":0
},
"countyTax":{
"description":"County Tax.",
"type":"number",
"example":0
},
"isTaxIncluded":{
"description":"If Tax is included?",
"type":"boolean",
"example":false
},
"miscTax":{
"description":"Misc Tax.",
"type":"number",
"example":1.87
},
"districtTax":{
"description":"District Tax.",
"type":"number",
"example":0
},
"stateTax":{
"description":"State Tax.",
"type":"number",
"example":3.9
},
"countryTax":{
"description":"Country Tax.",
"type":"number",
"example":0
}
}
},
"lastName":{
"description":"The second name of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"Muir"
},
"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"
},
"shippingMethod":{
"description":"The shipping method details for the order.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"shippingTax":{
"type":"number"
},
"cost":{
"description":"The total cost of shipping.",
"type":"number"
},
"taxCode":{
"type":"string"
},
"value":{
"description":"The shipping method applied to the order.",
"type":"string"
},
"shippingMethodDescription":{
"type":"string"
}
}
},
"shippingGroupId":{
"description":"The shipping Group id",
"type":"string",
"example":"sg1234"
},
"store":{
"description":"The store is present in the request if the type is inStorePickupShippingGroup.",
"type":"object",
"properties":{
"country":{
"description":"The country of the store",
"type":"string",
"example":"USA"
},
"hours":{
"description":"The store's opening hours.",
"type":"string",
"example":"Mon - Sat 10AM - 7PM Sun 11AM - 6 PM"
},
"address3":{
"description":"Address line 3 of store.",
"type":"string",
"example":"Main Street"
},
"address2":{
"description":"Address line 2 of store.",
"type":"string",
"example":"4th Floor"
},
"city":{
"description":"The store's city.",
"type":"string",
"example":"Boston"
},
"address1":{
"description":"Address line 1 of store.",
"type":"string",
"example":"One Beacon Street"
},
"stateAddress":{
"description":"The store's state address.",
"type":"string",
"example":"MA"
},
"county":{
"description":"The store's county",
"type":"string",
"example":"MA"
},
"phoneNumber":{
"description":"The store's phone number.",
"type":"string",
"example":"(617) 386-1201"
},
"locationId":{
"description":"The store's location Id.",
"type":"string",
"example":"Boston138"
},
"name":{
"description":"The store's name.",
"type":"string",
"example":"Boston Store #138"
},
"faxNumber":{
"description":"Fax number.",
"type":"string",
"example":"(617) 386-1200"
},
"postCode":{
"description":"The store's post code.",
"type":"string",
"example":"2108"
},
"email":{
"description":"The store's email address.",
"type":"string",
"example":"store138@example.com"
}
}
},
"type":{
"description":"the shippingGroup type",
"type":"string",
"example":"inStorePickupShippingGroup"
},
"firstName":{
"description":"The first name of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"John"
},
"priceInfo":{
"description":"The price information.",
"type":"object",
"properties":{
"amount":{
"description":"The total order amount.",
"type":"number",
"example":24.99
},
"total":{
"description":"The order total.",
"type":"number",
"example":47.93
},
"lkpValExcludingFreeShip":{
"description":"The total shipping cost excluding items with free shipping.",
"type":"number",
"example":0
},
"shipping":{
"description":"The total shipping cost.",
"type":"number",
"example":14.95
},
"shippingSurchargeValue":{
"description":"Extra handling costs for shipping the products",
"type":"number",
"example":0
},
"tax":{
"description":"The total tax amount.",
"type":"number",
"example":7.99
},
"subTotal":{
"description":"Sub-total.",
"type":"number",
"example":24.99
},
"currencyCode":{
"description":"The currency code.",
"type":"string",
"example":"USD"
},
"totalWithoutTax":{
"description":"The total amount without tax.",
"type":"number",
"example":39.49
}
}
},
"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"
},
"total":{
"description":"The total price of the recurring charge.",
"type":"number"
},
"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"
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string"
}
}
}
},
"shipping":{
"description":"Cost of shipping the product.",
"type":"number"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"subTotal":{
"description":"The sub-total price of the recurring charge.",
"type":"number"
},
"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"
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string"
}
}
}
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"totalWithoutTax":{
"description":"Total of recurring amount without tax included.",
"type":"number"
}
}
},
"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":"integer",
"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":"integer",
"example":0
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"integer",
"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":"integer",
"example":0
},
"secondaryCurrencyTotalAdjustment":{
"type":"integer",
"example":0
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
}
}
},
"shippingAddress":{
"description":"The shipping address details.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name.",
"type":"string",
"example":"Muir"
},
"country":{
"description":"Country.",
"type":"string"
},
"address3":{
"description":"Address snippet.",
"type":"string"
},
"address2":{
"description":"Address snippet.",
"type":"string"
},
"city":{
"description":"City.",
"type":"string",
"example":"Cambridge"
},
"address1":{
"description":"Address snippet.",
"type":"string",
"example":"1 main st"
},
"prefix":{
"description":"Name prefix.",
"type":"string"
},
"companyName":{
"description":"Company name.",
"type":"string",
"example":"oracle"
},
"postalCode":{
"description":"Postal code.",
"type":"string",
"example":1122
},
"jobTitle":{
"description":"Job title.",
"type":"string",
"example":"manager"
},
"county":{
"description":"County.",
"type":"string"
},
"suffix":{
"description":"Name suffix.",
"type":"string"
},
"firstName":{
"description":"First name",
"type":"string",
"example":"John"
},
"phoneNumber":{
"description":"Phone number.",
"type":"string",
"example":1111111111
},
"faxNumber":{
"description":"Fax number.",
"type":"string"
},
"middleName":{
"description":"Middle name.",
"type":"string",
"example":"Morgan"
},
"state":{
"description":"State.",
"type":"string",
"example":"MA"
},
"email":{
"description":"Email address.",
"type":"string",
"example":"john.muir@oracle.com"
}
}
},
"items":{
"type":"array",
"items":{
"properties":{
"availablePickupDate":{
"format":"date-time",
"description":"The items available store pickup date.",
"type":"string",
"example":"2018-05-19T13:00:00.000Z"
},
"inventoryLocationId":{
"description":"Defines the inventory location that services the referenced commerce item.",
"type":"string"
},
"rawTotalPrice":{
"description":"The raw total price.",
"type":"number",
"example":24.99
},
"returnedQuantity":{
"type":"integer",
"example":0
},
"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":"Extra handling cost for shipping the product.",
"type":"number",
"example":0
},
"availabilityDate":{
"format":"date-time",
"description":"The availability date for preOrdered/backOrdered quantity.",
"type":"string",
"example":"2018-06-13T18:09:53.493Z"
},
"discountAmount":{
"description":"The monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal. (read-only)",
"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"
},
"key":{
"description":"Map key defined by external system.",
"type":"string"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the third party system.",
"type":"string"
}
}
}
},
"preOrderQuantity":{
"description":"The pre ordered quantity included.",
"type":"integer",
"example":0
},
"childItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
}
}
},
"configuratorId":{
"type":"string"
},
"commerceItemId":{
"description":"Commerce Item ID for this commerce item.",
"type":"string",
"example":"ci123545"
},
"price":{
"type":"number",
"example":24.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":"Whether is on sale.",
"type":"boolean",
"example":false
},
"actionCode":{
"description":"The action code that has been set on the item by the third party system.",
"type":"string"
},
"commerceId":{
"description":"Commerce ID for this commerce item.",
"type":"string",
"example":"ci12343"
},
"stateDetailsAsUser":{
"type":"string",
"example":"details of shippingItem"
},
"unitPrice":{
"type":"number",
"example":24.99
},
"amount":{
"description":"The monetary amount.",
"type":"number",
"example":24.99
},
"quantity":{
"description":"The number of items covered by this price info",
"type":"integer",
"example":1
},
"productId":{
"description":"The ID of the product.",
"type":"string",
"example":"product_9e"
},
"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":"integer",
"example":1
},
"tax":{
"type":"number",
"example":0
},
"orderDiscountShare":{
"type":"integer",
"example":0
},
"detailedUnitPrice":{
"type":"number",
"example":24.99
},
"currencyCode":{
"type":"string",
"example":"USD"
}
}
}
},
"preferredPickupDate":{
"format":"date-time",
"description":"The items preferred store pickup date.",
"type":"string",
"example":"2018-05-19T13:00:00.000Z"
},
"catRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string",
"example":"Sku_9F"
},
"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":"integer",
"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"
}
}
}
}
}
}
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"backOrderQuantity":{
"description":"The back ordered quantity included.",
"type":"integer",
"example":0
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number",
"example":24.99
},
"status":{
"type":"string",
"example":"INITIAL"
}
}
}
},
"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":"integer",
"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":"integer",
"example":0
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"integer",
"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":"integer",
"example":0
},
"secondaryCurrencyTotalAdjustment":{
"type":"integer",
"example":0
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
}
}
}
Nested Schema : items
Type: array
Show Source
{
"type":"array",
"items":{
"properties":{
"availablePickupDate":{
"format":"date-time",
"description":"The items available store pickup date.",
"type":"string",
"example":"2018-05-19T13:00:00.000Z"
},
"inventoryLocationId":{
"description":"Defines the inventory location that services the referenced commerce item.",
"type":"string"
},
"rawTotalPrice":{
"description":"The raw total price.",
"type":"number",
"example":24.99
},
"returnedQuantity":{
"type":"integer",
"example":0
},
"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":"Extra handling cost for shipping the product.",
"type":"number",
"example":0
},
"availabilityDate":{
"format":"date-time",
"description":"The availability date for preOrdered/backOrdered quantity.",
"type":"string",
"example":"2018-06-13T18:09:53.493Z"
},
"discountAmount":{
"description":"The monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal. (read-only)",
"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"
},
"key":{
"description":"Map key defined by external system.",
"type":"string"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the third party system.",
"type":"string"
}
}
}
},
"preOrderQuantity":{
"description":"The pre ordered quantity included.",
"type":"integer",
"example":0
},
"childItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
}
}
},
"configuratorId":{
"type":"string"
},
"commerceItemId":{
"description":"Commerce Item ID for this commerce item.",
"type":"string",
"example":"ci123545"
},
"price":{
"type":"number",
"example":24.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":"Whether is on sale.",
"type":"boolean",
"example":false
},
"actionCode":{
"description":"The action code that has been set on the item by the third party system.",
"type":"string"
},
"commerceId":{
"description":"Commerce ID for this commerce item.",
"type":"string",
"example":"ci12343"
},
"stateDetailsAsUser":{
"type":"string",
"example":"details of shippingItem"
},
"unitPrice":{
"type":"number",
"example":24.99
},
"amount":{
"description":"The monetary amount.",
"type":"number",
"example":24.99
},
"quantity":{
"description":"The number of items covered by this price info",
"type":"integer",
"example":1
},
"productId":{
"description":"The ID of the product.",
"type":"string",
"example":"product_9e"
},
"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":"integer",
"example":1
},
"tax":{
"type":"number",
"example":0
},
"orderDiscountShare":{
"type":"integer",
"example":0
},
"detailedUnitPrice":{
"type":"number",
"example":24.99
},
"currencyCode":{
"type":"string",
"example":"USD"
}
}
}
},
"preferredPickupDate":{
"format":"date-time",
"description":"The items preferred store pickup date.",
"type":"string",
"example":"2018-05-19T13:00:00.000Z"
},
"catRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string",
"example":"Sku_9F"
},
"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":"integer",
"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"
}
}
}
}
}
}
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"backOrderQuantity":{
"description":"The back ordered quantity included.",
"type":"integer",
"example":0
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number",
"example":24.99
},
"status":{
"type":"string",
"example":"INITIAL"
}
}
}
}
Nested Schema : priceInfo
Type: object
The price information.
Show Source
{
"description":"The price information.",
"type":"object",
"properties":{
"amount":{
"description":"The total order amount.",
"type":"number",
"example":24.99
},
"total":{
"description":"The order total.",
"type":"number",
"example":47.93
},
"lkpValExcludingFreeShip":{
"description":"The total shipping cost excluding items with free shipping.",
"type":"number",
"example":0
},
"shipping":{
"description":"The total shipping cost.",
"type":"number",
"example":14.95
},
"shippingSurchargeValue":{
"description":"Extra handling costs for shipping the products",
"type":"number",
"example":0
},
"tax":{
"description":"The total tax amount.",
"type":"number",
"example":7.99
},
"subTotal":{
"description":"Sub-total.",
"type":"number",
"example":24.99
},
"currencyCode":{
"description":"The currency code.",
"type":"string",
"example":"USD"
},
"totalWithoutTax":{
"description":"The total amount without tax.",
"type":"number",
"example":39.49
}
}
}
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"
},
"total":{
"description":"The total price of the recurring charge.",
"type":"number"
},
"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"
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string"
}
}
}
},
"shipping":{
"description":"Cost of shipping the product.",
"type":"number"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"subTotal":{
"description":"The sub-total price of the recurring charge.",
"type":"number"
},
"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"
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string"
}
}
}
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"totalWithoutTax":{
"description":"Total of recurring amount without tax included.",
"type":"number"
}
}
}
Nested Schema : shippingAddress
Type: object
The shipping address details.
Show Source
{
"description":"The shipping address details.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name.",
"type":"string",
"example":"Muir"
},
"country":{
"description":"Country.",
"type":"string"
},
"address3":{
"description":"Address snippet.",
"type":"string"
},
"address2":{
"description":"Address snippet.",
"type":"string"
},
"city":{
"description":"City.",
"type":"string",
"example":"Cambridge"
},
"address1":{
"description":"Address snippet.",
"type":"string",
"example":"1 main st"
},
"prefix":{
"description":"Name prefix.",
"type":"string"
},
"companyName":{
"description":"Company name.",
"type":"string",
"example":"oracle"
},
"postalCode":{
"description":"Postal code.",
"type":"string",
"example":1122
},
"jobTitle":{
"description":"Job title.",
"type":"string",
"example":"manager"
},
"county":{
"description":"County.",
"type":"string"
},
"suffix":{
"description":"Name suffix.",
"type":"string"
},
"firstName":{
"description":"First name",
"type":"string",
"example":"John"
},
"phoneNumber":{
"description":"Phone number.",
"type":"string",
"example":1111111111
},
"faxNumber":{
"description":"Fax number.",
"type":"string"
},
"middleName":{
"description":"Middle name.",
"type":"string",
"example":"Morgan"
},
"state":{
"description":"State.",
"type":"string",
"example":"MA"
},
"email":{
"description":"Email address.",
"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":{
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"shippingTax":{
"type":"number"
},
"cost":{
"description":"The total cost of shipping.",
"type":"number"
},
"taxCode":{
"type":"string"
},
"value":{
"description":"The shipping method applied to the order.",
"type":"string"
},
"shippingMethodDescription":{
"type":"string"
}
}
}
Nested Schema : store
Type: object
The store is present in the request if the type is inStorePickupShippingGroup.
Show Source
{
"description":"The store is present in the request if the type is inStorePickupShippingGroup.",
"type":"object",
"properties":{
"country":{
"description":"The country of the store",
"type":"string",
"example":"USA"
},
"hours":{
"description":"The store's opening hours.",
"type":"string",
"example":"Mon - Sat 10AM - 7PM Sun 11AM - 6 PM"
},
"address3":{
"description":"Address line 3 of store.",
"type":"string",
"example":"Main Street"
},
"address2":{
"description":"Address line 2 of store.",
"type":"string",
"example":"4th Floor"
},
"city":{
"description":"The store's city.",
"type":"string",
"example":"Boston"
},
"address1":{
"description":"Address line 1 of store.",
"type":"string",
"example":"One Beacon Street"
},
"stateAddress":{
"description":"The store's state address.",
"type":"string",
"example":"MA"
},
"county":{
"description":"The store's county",
"type":"string",
"example":"MA"
},
"phoneNumber":{
"description":"The store's phone number.",
"type":"string",
"example":"(617) 386-1201"
},
"locationId":{
"description":"The store's location Id.",
"type":"string",
"example":"Boston138"
},
"name":{
"description":"The store's name.",
"type":"string",
"example":"Boston Store #138"
},
"faxNumber":{
"description":"Fax number.",
"type":"string",
"example":"(617) 386-1200"
},
"postCode":{
"description":"The store's post code.",
"type":"string",
"example":"2108"
},
"email":{
"description":"The store's email address.",
"type":"string",
"example":"store138@example.com"
}
}
}
Nested Schema : taxPriceInfo
Type: object
The shipping address details.
Show Source
{
"description":"The shipping address details.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"taxAmount in secondaryCurrency",
"type":"number",
"example":0
},
"cityTax":{
"description":"City Tax",
"type":"number",
"example":3.9
},
"amount":{
"description":"The total order amount.",
"type":"number",
"example":5.99
},
"valueAddedTax":{
"description":"Value Added Tax.",
"type":"number",
"example":0
},
"countyTax":{
"description":"County Tax.",
"type":"number",
"example":0
},
"isTaxIncluded":{
"description":"If Tax is included?",
"type":"boolean",
"example":false
},
"miscTax":{
"description":"Misc Tax.",
"type":"number",
"example":1.87
},
"districtTax":{
"description":"District Tax.",
"type":"number",
"example":0
},
"stateTax":{
"description":"State Tax.",
"type":"number",
"example":3.9
},
"countryTax":{
"description":"Country Tax.",
"type":"number",
"example":0
}
}
}
Nested Schema : claimedCouponMultiPromotions
Type: object
Show Source
{
"type":"object",
"properties":{
"promotions":{
"type":"array",
"items":{
"type":"object",
"properties":{
"totalAdjustment":{
"type":"integer",
"example":0
},
"secondaryCurrencyTotalAdjustment":{
"type":"integer",
"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":"integer",
"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":"integer",
"example":0
},
"secondaryCurrencyTotalAdjustment":{
"type":"integer",
"example":0
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"totalAdjustment":{
"type":"integer",
"example":0
},
"secondaryCurrencyTotalAdjustment":{
"type":"integer",
"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":"integer",
"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":"integer",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"description of the promotion"
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"properties":{
"availablePickupDate":{
"format":"date-time",
"description":"The items available store pickup date.",
"type":"string",
"example":"2018-05-19T13:00:00.000Z"
},
"inventoryLocationId":{
"description":"Defines the inventory location that services the referenced commerce item.",
"type":"string"
},
"rawTotalPrice":{
"description":"The raw total price.",
"type":"number",
"example":24.99
},
"returnedQuantity":{
"type":"integer",
"example":0
},
"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":"Extra handling cost for shipping the product.",
"type":"number",
"example":0
},
"availabilityDate":{
"format":"date-time",
"description":"The availability date for preOrdered/backOrdered quantity.",
"type":"string",
"example":"2018-06-13T18:09:53.493Z"
},
"discountAmount":{
"description":"The monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal. (read-only)",
"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"
},
"key":{
"description":"Map key defined by external system.",
"type":"string"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the third party system.",
"type":"string"
}
}
}
},
"preOrderQuantity":{
"description":"The pre ordered quantity included.",
"type":"integer",
"example":0
},
"childItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
}
}
},
"configuratorId":{
"type":"string"
},
"commerceItemId":{
"description":"Commerce Item ID for this commerce item.",
"type":"string",
"example":"ci123545"
},
"price":{
"type":"number",
"example":24.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":"Whether is on sale.",
"type":"boolean",
"example":false
},
"actionCode":{
"description":"The action code that has been set on the item by the third party system.",
"type":"string"
},
"commerceId":{
"description":"Commerce ID for this commerce item.",
"type":"string",
"example":"ci12343"
},
"stateDetailsAsUser":{
"type":"string",
"example":"details of shippingItem"
},
"unitPrice":{
"type":"number",
"example":24.99
},
"amount":{
"description":"The monetary amount.",
"type":"number",
"example":24.99
},
"quantity":{
"description":"The number of items covered by this price info",
"type":"integer",
"example":1
},
"productId":{
"description":"The ID of the product.",
"type":"string",
"example":"product_9e"
},
"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":"integer",
"example":1
},
"tax":{
"type":"number",
"example":0
},
"orderDiscountShare":{
"type":"integer",
"example":0
},
"detailedUnitPrice":{
"type":"number",
"example":24.99
},
"currencyCode":{
"type":"string",
"example":"USD"
}
}
}
},
"preferredPickupDate":{
"format":"date-time",
"description":"The items preferred store pickup date.",
"type":"string",
"example":"2018-05-19T13:00:00.000Z"
},
"catRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string",
"example":"Sku_9F"
},
"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":"integer",
"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"
}
}
}
}
}
}
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"backOrderQuantity":{
"description":"The back ordered quantity included.",
"type":"integer",
"example":0
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number",
"example":24.99
},
"status":{
"type":"string",
"example":"INITIAL"
}
}
}
Nested Schema : childItems
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
}
}
}
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":"integer",
"example":1
},
"tax":{
"type":"number",
"example":0
},
"orderDiscountShare":{
"type":"integer",
"example":0
},
"detailedUnitPrice":{
"type":"number",
"example":24.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"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
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":"integer",
"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"
},
"key":{
"description":"Map key defined by external system.",
"type":"string"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the third party system.",
"type":"string"
}
}
}
}
Nested Schema : shopperInput
Type: object
Additional Properties Allowed
Show Source
{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
}
Map of shopper input keys to values
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
}
}
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":"integer",
"example":1
},
"tax":{
"type":"number",
"example":0
},
"orderDiscountShare":{
"type":"integer",
"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":"integer",
"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":"integer",
"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":"integer",
"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"
},
"key":{
"description":"Map key defined by external system.",
"type":"string"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the third party system.",
"type":"string"
}
}
}
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"
},
"key":{
"description":"Map key defined by external system.",
"type":"string"
}
}
}
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"
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string"
}
}
}
}
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"
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string"
}
}
}
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":{
"unitPrice":{
"description":"The unit price of the product.",
"type":"number"
},
"primaryThumbImageURL":{
"description":"Image url of the product",
"type":"string"
},
"quantity":{
"description":"The quantity of the product.",
"type":"integer"
},
"productId":{
"description":"ID of the product in the cart.",
"type":"string"
},
"rawTotalPrice":{
"description":"The raw price of the product.",
"type":"number"
},
"dynamicProperties":{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string"
},
"label":{
"description":"The dynamic property label.",
"type":"string"
},
"value":{
"description":"The dynamic property value.",
"type":"string"
}
}
}
},
"detailedItemPriceInfo":{
"description":"The unit price of the product.",
"type":"array",
"items":{
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"taxAmount in secondaryCurrency",
"type":"number"
},
"discounted":{
"description":"If discounted?",
"type":"boolean"
},
"amount":{
"description":"The total order amount.",
"type":"number"
},
"quantity":{
"description":"Quantity.",
"type":"integer"
},
"tax":{
"description":"The total tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order discount share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price.",
"type":"number"
},
"currencyCode":{
"description":"The currency code.",
"type":"string"
}
}
}
},
"displayName":{
"description":"The name of the product.",
"type":"string"
},
"shippingSurchargeValue":{
"description":"tax applied on shipping",
"type":"number"
},
"isItemValid":{
"description":"if item is valid",
"type":"boolean"
},
"description":{
"description":"Description about the product.",
"type":"string"
},
"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":{
"properties":{
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"addOnItem":{
"description":"Whether this child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"quantity":{
"description":"The quantity of this child item included.",
"type":"integer"
},
"productId":{
"description":"The product ID of the child item.",
"type":"string"
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this child commerce item references. Typically the SKU id.",
"type":"string"
}
}
}
},
"catRefId":{
"description":"The category to which the product belongs.",
"type":"string"
},
"configuratorId":{
"description":"Configuration ID for this commerce item.",
"type":"string"
},
"discountInfo":{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
}
}
},
"price":{
"description":"The actual price of the product.",
"type":"number"
},
"variant":{
"description":"List of variants for the product.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value.",
"type":"string"
},
"optionName":{
"description":"The variant option name.",
"type":"string"
}
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"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":"if item is on sale",
"type":"boolean"
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"unitPrice":{
"description":"The unit price of the product.",
"type":"number"
},
"primaryThumbImageURL":{
"description":"Image url of the product",
"type":"string"
},
"quantity":{
"description":"The quantity of the product.",
"type":"integer"
},
"productId":{
"description":"ID of the product in the cart.",
"type":"string"
},
"rawTotalPrice":{
"description":"The raw price of the product.",
"type":"number"
},
"dynamicProperties":{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string"
},
"label":{
"description":"The dynamic property label.",
"type":"string"
},
"value":{
"description":"The dynamic property value.",
"type":"string"
}
}
}
},
"detailedItemPriceInfo":{
"description":"The unit price of the product.",
"type":"array",
"items":{
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"taxAmount in secondaryCurrency",
"type":"number"
},
"discounted":{
"description":"If discounted?",
"type":"boolean"
},
"amount":{
"description":"The total order amount.",
"type":"number"
},
"quantity":{
"description":"Quantity.",
"type":"integer"
},
"tax":{
"description":"The total tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order discount share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price.",
"type":"number"
},
"currencyCode":{
"description":"The currency code.",
"type":"string"
}
}
}
},
"displayName":{
"description":"The name of the product.",
"type":"string"
},
"shippingSurchargeValue":{
"description":"tax applied on shipping",
"type":"number"
},
"isItemValid":{
"description":"if item is valid",
"type":"boolean"
},
"description":{
"description":"Description about the product.",
"type":"string"
},
"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":{
"properties":{
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"addOnItem":{
"description":"Whether this child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"quantity":{
"description":"The quantity of this child item included.",
"type":"integer"
},
"productId":{
"description":"The product ID of the child item.",
"type":"string"
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this child commerce item references. Typically the SKU id.",
"type":"string"
}
}
}
},
"catRefId":{
"description":"The category to which the product belongs.",
"type":"string"
},
"configuratorId":{
"description":"Configuration ID for this commerce item.",
"type":"string"
},
"discountInfo":{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
}
}
},
"price":{
"description":"The actual price of the product.",
"type":"number"
},
"variant":{
"description":"List of variants for the product.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value.",
"type":"string"
},
"optionName":{
"description":"The variant option name.",
"type":"string"
}
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"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":"if item is on sale",
"type":"boolean"
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
}
}
}
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":{
"properties":{
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"addOnItem":{
"description":"Whether this child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"quantity":{
"description":"The quantity of this child item included.",
"type":"integer"
},
"productId":{
"description":"The product ID of the child item.",
"type":"string"
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this child commerce item references. Typically the SKU id.",
"type":"string"
}
}
}
}
Nested Schema : detailedItemPriceInfo
Type: array
The unit price of the product.
Show Source
{
"description":"The unit price of the product.",
"type":"array",
"items":{
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"taxAmount in secondaryCurrency",
"type":"number"
},
"discounted":{
"description":"If discounted?",
"type":"boolean"
},
"amount":{
"description":"The total order amount.",
"type":"number"
},
"quantity":{
"description":"Quantity.",
"type":"integer"
},
"tax":{
"description":"The total tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order discount share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price.",
"type":"number"
},
"currencyCode":{
"description":"The currency code.",
"type":"string"
}
}
}
}
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"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
Nested Schema : discountInfo
Type: array
The discount information.
Show Source
{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
}
}
}
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"
},
"label":{
"description":"The dynamic property label.",
"type":"string"
},
"value":{
"description":"The dynamic property value.",
"type":"string"
}
}
}
}
Nested Schema : externalPriceDetails
Type: object
Details about external pricing
Show Source
{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
}
Nested Schema : shopperInput
Type: object
Additional Properties Allowed
Show Source
{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
}
Map of shopper input keys to values
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"
},
"optionName":{
"description":"The variant option name.",
"type":"string"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"properties":{
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"addOnItem":{
"description":"Whether this child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"quantity":{
"description":"The quantity of this child item included.",
"type":"integer"
},
"productId":{
"description":"The product ID of the child item.",
"type":"string"
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this child commerce item references. Typically the SKU id.",
"type":"string"
}
}
}
Nested Schema : shopperInput
Type: object
Additional Properties Allowed
Show Source
{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
}
Map of shopper input keys to values
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"taxAmount in secondaryCurrency",
"type":"number"
},
"discounted":{
"description":"If discounted?",
"type":"boolean"
},
"amount":{
"description":"The total order amount.",
"type":"number"
},
"quantity":{
"description":"Quantity.",
"type":"integer"
},
"tax":{
"description":"The total tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order discount share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price.",
"type":"number"
},
"currencyCode":{
"description":"The currency code.",
"type":"string"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string"
},
"label":{
"description":"The dynamic property label.",
"type":"string"
},
"value":{
"description":"The dynamic property value.",
"type":"string"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value.",
"type":"string"
},
"optionName":{
"description":"The variant option name.",
"type":"string"
}
}
}