This functional webhook is triggered during pricing operations and allows external system to filter the best promotion for item and order
Root Schema : promotionSelections_request
Type: object
This functional webhook is triggered during pricing operations and allows external system to filter the best promotion for item and order
Show Source
{
"description":"This functional webhook is triggered during pricing operations and allows external system to filter the best promotion for item and order",
"properties":{
"profile":{
"type":"object",
"properties":{
"firstName":{
"type":"string"
},
"lastName":{
"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":"The string representation of whether the user wants to recieve email or not",
"type":"string"
},
"id":{
"description":"Id",
"type":"string"
},
"locale":{
"type":"string"
},
"email":{
"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":{
"receiveEmail":{
"description":"Indicates whether the user should receive marketing emails on the current site. Can be yes or no.",
"type":"string"
}
}
}
}
}
},
"daytimeTelephoneNumber":{
"description":"The day time phone number of the profile",
"type":"string"
}
}
},
"promotionIds":{
"description":"Existing promotions applied to order.",
"type":"array",
"items":{
"type":"string"
}
},
"order":{
"type":"object",
"properties":{
"taxPriceInfo":{
"type":"object",
"properties":{
"cityTax":{
"type":"number"
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"amount":{
"type":"number"
},
"valueAddedTax":{
"type":"number"
},
"countyTax":{
"type":"number"
},
"isTaxIncluded":{
"type":"boolean"
},
"miscTax":{
"type":"number"
},
"districtTax":{
"type":"number"
},
"stateTax":{
"type":"number"
},
"countryTax":{
"type":"number"
}
}
},
"shippingGroups":{
"type":"array",
"items":{
"type":"object",
"properties":{
"taxPriceInfo":{
"description":"The shipping address details.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"taxAmount in secondaryCurrency",
"type":"number"
},
"cityTax":{
"description":"City Tax",
"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"
}
}
},
"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"
},
"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"
}
}
},
"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"
},
"discountInfo":{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
}
}
},
"recurringChargePriceInfo":{
"type":"string"
},
"shippingMethod":{
"description":"The shipping method details for the order.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":" The secondary currency tax amount.",
"type":"number"
},
"shippingTax":{
"type":"number"
},
"secondaryCurrencyShippingAmount":{
"description":" The secondary currency shipping amount.",
"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"
}
}
},
"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"
}
}
},
"items":{
"type":"array",
"items":{
"type":"object",
"properties":{
"rawTotalPrice":{
"description":"The raw total price.",
"type":"number"
},
"shippingSurchargeValue":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"availabilityDate":{
"format":"date-time",
"description":"The availability date for preOrdered/backOrdered quantity.",
"type":"string"
},
"discountAmount":{
"description":"The monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal. (read-only)",
"type":"number"
},
"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"
},
"childItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
}
}
},
"configuratorId":{
"type":"string"
},
"price":{
"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":"Whether is on sale.",
"type":"boolean"
},
"actionCode":{
"description":"The action code that has been set on the item by the third party system.",
"type":"string"
},
"stateDetailsAsUser":{
"type":"string"
},
"unitPrice":{
"type":"number"
},
"amount":{
"description":"The monetary amount.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this price info",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"detailedItemPriceInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean"
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"amount":{
"type":"number"
},
"quantity":{
"type":"integer"
},
"tax":{
"type":"number"
},
"orderDiscountShare":{
"type":"integer"
},
"detailedUnitPrice":{
"type":"number"
},
"currencyCode":{
"type":"string"
}
}
}
},
"catRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"discountInfo":{
"description":"Whether this item is discounted.",
"type":"array",
"items":{
"type":"object",
"properties":{
}
}
},
"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"
},
"backOrderQuantity":{
"description":"The back ordered quantity included.",
"type":"integer"
},
"commercerItemId":{
"description":"Commerce Item ID for this commerce item.",
"type":"string"
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
},
"commercerId":{
"description":"Commerce ID for this commerce item.",
"type":"string"
},
"status":{
"type":"string"
}
}
}
}
}
}
},
"creationTime":{
"type":"integer"
},
"lastModifiedDate":{
"type":"integer"
},
"orderId":{
"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"
},
"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"
}
}
}
},
"payments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"paymentGroupId":{
"type":"string"
},
"amount":{
"type":"integer"
},
"balance":{
"type":"number"
},
"gatewayName":{
"type":"string"
},
"giftCardNumber":{
"type":"integer"
},
"uiIntervention":{
"type":"string"
},
"paymentMethod":{
"type":"string"
},
"isAmountRemaining":{
"type":"boolean"
},
"paymentState":{
"type":"string"
},
"maskedCardNumber":{
"type":"string"
}
}
}
},
"shippingMethod":{
"type":"object",
"properties":{
"shippingTax":{
"type":"number"
},
"cost":{
"type":"number"
},
"value":{
"type":"string"
}
}
},
"orderStatus":{
"type":"string"
},
"cartName":{
"description":"Cart name for this order.",
"type":"string"
},
"creationDate":{
"type":"string"
},
"orderProfileId":{
"type":"string"
},
"priceInfo":{
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"The secondary currency tax amount.",
"type":"number"
},
"amount":{
"type":"number"
},
"total":{
"type":"number"
},
"secondaryCurrencyShippingAmount":{
"description":"The secondary currency shipping amount.",
"type":"number"
},
"shipping":{
"type":"number"
},
"secondaryCurrencyTotal":{
"description":"The secondary currency total amount.",
"type":"number"
},
"primaryCurrencyTotal":{
"description":"The primary currency total amount.",
"type":"number"
},
"shippingSurchargeValue":{
"type":"number"
},
"tax":{
"type":"number"
},
"subTotal":{
"type":"number"
},
"currencyCode":{
"type":"string"
},
"totalWithoutTax":{
"type":"number"
}
}
},
"discountInfo":{
"description":"The discount information.",
"type":"object",
"properties":{
"orderCouponsMap":{
"description":"The coupons that were claimed.",
"type":"object",
"properties":{
"couponCode":{
"description":"Coupon Code.",
"type":"object",
"properties":{
"promotionLongDesc":{
"description":"The description of the promotion.",
"type":"string"
},
"promotionName":{
"description":"The display name of the promotion.",
"type":"string"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean"
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"number"
},
"promotionDesc":{
"description":"Description of the promotion. Retained for backward compatibility.",
"type":"string"
},
"promotionId":{
"description":"The Id of the promotion.",
"type":"string"
}
}
}
}
},
"orderDiscount":{
"description":"The order discount.",
"type":"number"
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"number"
}
}
},
"shoppingCart":{
"type":"object",
"properties":{
"itemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding items property is truncated. The value for this field will always be true if present",
"type":"boolean"
},
"numberOfItems":{
"type":"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":{
"primaryThumbImageURL":{
"type":"string"
},
"rawTotalPrice":{
"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"
}
}
}
},
"displayName":{
"type":"string"
},
"shippingSurchargeValue":{
"type":"integer"
},
"description":{
"type":"string"
},
"discountAmount":{
"type":"number"
},
"isItemValid":{
"type":"boolean"
},
"configuratorId":{
"type":"string"
},
"externalPrice":{
"type":"number"
},
"price":{
"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"
}
}
}
},
"childItemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding childItems property is truncated. The value for this field will be true always if present",
"type":"boolean"
},
"onSale":{
"type":"boolean"
},
"id":{
"type":"string"
},
"unitPrice":{
"type":"number"
},
"secondaryCurrencyShippingSurcharge":{
"type":"integer"
},
"quantity":{
"type":"integer"
},
"productId":{
"type":"string"
},
"salePrice":{
"type":"number"
},
"externalRecurringCharge":{
"type":"number"
},
"detailedItemPriceInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean"
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"amount":{
"type":"number"
},
"quantity":{
"type":"integer"
},
"tax":{
"type":"number"
},
"orderDiscountShare":{
"type":"integer"
},
"detailedUnitPrice":{
"type":"number"
},
"currencyCode":{
"type":"string"
}
}
}
},
"externalRecurringChargeFrequency":{
"type":"string"
},
"externalPriceQuantity":{
"type":"integer"
},
"catRefId":{
"type":"string"
},
"externalRecurringChargeDuration":{
"type":"string"
},
"discountInfo":{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean"
},
"coupon":{
"description":"The coupon ID.",
"type":"string"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"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"
},
"listPrice":{
"type":"number"
}
}
}
}
}
},
"shippingAddress":{
"type":"object",
"properties":{
"lastName":{
"type":"string"
},
"country":{
"type":"string"
},
"address3":{
"type":"string"
},
"address2":{
"type":"string"
},
"city":{
"type":"string"
},
"address1":{
"type":"string"
},
"prefix":{
"type":"string"
},
"companyName":{
"type":"string"
},
"postalCode":{
"type":"string"
},
"jobTitle":{
"type":"string"
},
"county":{
"type":"string"
},
"suffix":{
"type":"string"
},
"firstName":{
"type":"string"
},
"phoneNumber":{
"type":"integer"
},
"faxNumber":{
"type":"integer"
},
"middleName":{
"type":"string"
},
"state":{
"type":"string"
},
"email":{
"type":"string"
}
}
},
"siteId":{
"type":"string"
},
"markers":{
"description":"Order marker information",
"type":"array",
"items":{
"type":"object",
"properties":{
"value":{
"description":"Order marker value. e.g. In case of marketing campaign, value represents actual unique campaign Id",
"type":"string",
"example":"78900"
},
"key":{
"description":"Order marker key. In a marketing campaign marker, a key signifies that it is a campaign marker. Also, it identifies the external marketing system that is the source of the campaign, e.g., campaign_eloqua",
"type":"string",
"example":"campaign_eloqua"
}
}
}
}
}
}
}
}
Nested Schema : order
Type: object
Show Source
{
"type":"object",
"properties":{
"taxPriceInfo":{
"type":"object",
"properties":{
"cityTax":{
"type":"number"
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"amount":{
"type":"number"
},
"valueAddedTax":{
"type":"number"
},
"countyTax":{
"type":"number"
},
"isTaxIncluded":{
"type":"boolean"
},
"miscTax":{
"type":"number"
},
"districtTax":{
"type":"number"
},
"stateTax":{
"type":"number"
},
"countryTax":{
"type":"number"
}
}
},
"shippingGroups":{
"type":"array",
"items":{
"type":"object",
"properties":{
"taxPriceInfo":{
"description":"The shipping address details.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"taxAmount in secondaryCurrency",
"type":"number"
},
"cityTax":{
"description":"City Tax",
"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"
}
}
},
"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"
},
"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"
}
}
},
"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"
},
"discountInfo":{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
}
}
},
"recurringChargePriceInfo":{
"type":"string"
},
"shippingMethod":{
"description":"The shipping method details for the order.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":" The secondary currency tax amount.",
"type":"number"
},
"shippingTax":{
"type":"number"
},
"secondaryCurrencyShippingAmount":{
"description":" The secondary currency shipping amount.",
"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"
}
}
},
"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"
}
}
},
"items":{
"type":"array",
"items":{
"type":"object",
"properties":{
"rawTotalPrice":{
"description":"The raw total price.",
"type":"number"
},
"shippingSurchargeValue":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"availabilityDate":{
"format":"date-time",
"description":"The availability date for preOrdered/backOrdered quantity.",
"type":"string"
},
"discountAmount":{
"description":"The monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal. (read-only)",
"type":"number"
},
"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"
},
"childItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
}
}
},
"configuratorId":{
"type":"string"
},
"price":{
"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":"Whether is on sale.",
"type":"boolean"
},
"actionCode":{
"description":"The action code that has been set on the item by the third party system.",
"type":"string"
},
"stateDetailsAsUser":{
"type":"string"
},
"unitPrice":{
"type":"number"
},
"amount":{
"description":"The monetary amount.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this price info",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"detailedItemPriceInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean"
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"amount":{
"type":"number"
},
"quantity":{
"type":"integer"
},
"tax":{
"type":"number"
},
"orderDiscountShare":{
"type":"integer"
},
"detailedUnitPrice":{
"type":"number"
},
"currencyCode":{
"type":"string"
}
}
}
},
"catRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"discountInfo":{
"description":"Whether this item is discounted.",
"type":"array",
"items":{
"type":"object",
"properties":{
}
}
},
"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"
},
"backOrderQuantity":{
"description":"The back ordered quantity included.",
"type":"integer"
},
"commercerItemId":{
"description":"Commerce Item ID for this commerce item.",
"type":"string"
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
},
"commercerId":{
"description":"Commerce ID for this commerce item.",
"type":"string"
},
"status":{
"type":"string"
}
}
}
}
}
}
},
"creationTime":{
"type":"integer"
},
"lastModifiedDate":{
"type":"integer"
},
"orderId":{
"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"
},
"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"
}
}
}
},
"payments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"paymentGroupId":{
"type":"string"
},
"amount":{
"type":"integer"
},
"balance":{
"type":"number"
},
"gatewayName":{
"type":"string"
},
"giftCardNumber":{
"type":"integer"
},
"uiIntervention":{
"type":"string"
},
"paymentMethod":{
"type":"string"
},
"isAmountRemaining":{
"type":"boolean"
},
"paymentState":{
"type":"string"
},
"maskedCardNumber":{
"type":"string"
}
}
}
},
"shippingMethod":{
"type":"object",
"properties":{
"shippingTax":{
"type":"number"
},
"cost":{
"type":"number"
},
"value":{
"type":"string"
}
}
},
"orderStatus":{
"type":"string"
},
"cartName":{
"description":"Cart name for this order.",
"type":"string"
},
"creationDate":{
"type":"string"
},
"orderProfileId":{
"type":"string"
},
"priceInfo":{
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"The secondary currency tax amount.",
"type":"number"
},
"amount":{
"type":"number"
},
"total":{
"type":"number"
},
"secondaryCurrencyShippingAmount":{
"description":"The secondary currency shipping amount.",
"type":"number"
},
"shipping":{
"type":"number"
},
"secondaryCurrencyTotal":{
"description":"The secondary currency total amount.",
"type":"number"
},
"primaryCurrencyTotal":{
"description":"The primary currency total amount.",
"type":"number"
},
"shippingSurchargeValue":{
"type":"number"
},
"tax":{
"type":"number"
},
"subTotal":{
"type":"number"
},
"currencyCode":{
"type":"string"
},
"totalWithoutTax":{
"type":"number"
}
}
},
"discountInfo":{
"description":"The discount information.",
"type":"object",
"properties":{
"orderCouponsMap":{
"description":"The coupons that were claimed.",
"type":"object",
"properties":{
"couponCode":{
"description":"Coupon Code.",
"type":"object",
"properties":{
"promotionLongDesc":{
"description":"The description of the promotion.",
"type":"string"
},
"promotionName":{
"description":"The display name of the promotion.",
"type":"string"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean"
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"number"
},
"promotionDesc":{
"description":"Description of the promotion. Retained for backward compatibility.",
"type":"string"
},
"promotionId":{
"description":"The Id of the promotion.",
"type":"string"
}
}
}
}
},
"orderDiscount":{
"description":"The order discount.",
"type":"number"
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"number"
}
}
},
"shoppingCart":{
"type":"object",
"properties":{
"itemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding items property is truncated. The value for this field will always be true if present",
"type":"boolean"
},
"numberOfItems":{
"type":"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":{
"primaryThumbImageURL":{
"type":"string"
},
"rawTotalPrice":{
"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"
}
}
}
},
"displayName":{
"type":"string"
},
"shippingSurchargeValue":{
"type":"integer"
},
"description":{
"type":"string"
},
"discountAmount":{
"type":"number"
},
"isItemValid":{
"type":"boolean"
},
"configuratorId":{
"type":"string"
},
"externalPrice":{
"type":"number"
},
"price":{
"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"
}
}
}
},
"childItemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding childItems property is truncated. The value for this field will be true always if present",
"type":"boolean"
},
"onSale":{
"type":"boolean"
},
"id":{
"type":"string"
},
"unitPrice":{
"type":"number"
},
"secondaryCurrencyShippingSurcharge":{
"type":"integer"
},
"quantity":{
"type":"integer"
},
"productId":{
"type":"string"
},
"salePrice":{
"type":"number"
},
"externalRecurringCharge":{
"type":"number"
},
"detailedItemPriceInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean"
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"amount":{
"type":"number"
},
"quantity":{
"type":"integer"
},
"tax":{
"type":"number"
},
"orderDiscountShare":{
"type":"integer"
},
"detailedUnitPrice":{
"type":"number"
},
"currencyCode":{
"type":"string"
}
}
}
},
"externalRecurringChargeFrequency":{
"type":"string"
},
"externalPriceQuantity":{
"type":"integer"
},
"catRefId":{
"type":"string"
},
"externalRecurringChargeDuration":{
"type":"string"
},
"discountInfo":{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean"
},
"coupon":{
"description":"The coupon ID.",
"type":"string"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"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"
},
"listPrice":{
"type":"number"
}
}
}
}
}
},
"shippingAddress":{
"type":"object",
"properties":{
"lastName":{
"type":"string"
},
"country":{
"type":"string"
},
"address3":{
"type":"string"
},
"address2":{
"type":"string"
},
"city":{
"type":"string"
},
"address1":{
"type":"string"
},
"prefix":{
"type":"string"
},
"companyName":{
"type":"string"
},
"postalCode":{
"type":"string"
},
"jobTitle":{
"type":"string"
},
"county":{
"type":"string"
},
"suffix":{
"type":"string"
},
"firstName":{
"type":"string"
},
"phoneNumber":{
"type":"integer"
},
"faxNumber":{
"type":"integer"
},
"middleName":{
"type":"string"
},
"state":{
"type":"string"
},
"email":{
"type":"string"
}
}
},
"siteId":{
"type":"string"
},
"markers":{
"description":"Order marker information",
"type":"array",
"items":{
"type":"object",
"properties":{
"value":{
"description":"Order marker value. e.g. In case of marketing campaign, value represents actual unique campaign Id",
"type":"string",
"example":"78900"
},
"key":{
"description":"Order marker key. In a marketing campaign marker, a key signifies that it is a campaign marker. Also, it identifies the external marketing system that is the source of the campaign, e.g., campaign_eloqua",
"type":"string",
"example":"campaign_eloqua"
}
}
}
}
}
}
Nested Schema : profile
Type: object
Show Source
{
"type":"object",
"properties":{
"firstName":{
"type":"string"
},
"lastName":{
"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":"The string representation of whether the user wants to recieve email or not",
"type":"string"
},
"id":{
"description":"Id",
"type":"string"
},
"locale":{
"type":"string"
},
"email":{
"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":{
"receiveEmail":{
"description":"Indicates whether the user should receive marketing emails on the current site. Can be yes or no.",
"type":"string"
}
}
}
}
}
},
"daytimeTelephoneNumber":{
"description":"The day time phone number of the profile",
"type":"string"
}
}
}
Nested Schema : promotionIds
Type: array
Existing promotions applied to order.
Show Source
{
"description":"Existing promotions applied to order.",
"type":"array",
"items":{
"type":"string"
}
}
Nested Schema : discountInfo
Type: object
The discount information.
Show Source
{
"description":"The discount information.",
"type":"object",
"properties":{
"orderCouponsMap":{
"description":"The coupons that were claimed.",
"type":"object",
"properties":{
"couponCode":{
"description":"Coupon Code.",
"type":"object",
"properties":{
"promotionLongDesc":{
"description":"The description of the promotion.",
"type":"string"
},
"promotionName":{
"description":"The display name of the promotion.",
"type":"string"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean"
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"number"
},
"promotionDesc":{
"description":"Description of the promotion. Retained for backward compatibility.",
"type":"string"
},
"promotionId":{
"description":"The Id of the promotion.",
"type":"string"
}
}
}
}
},
"orderDiscount":{
"description":"The order discount.",
"type":"number"
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"number"
}
}
}
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 : markers
Type: array
Order marker information
Show Source
{
"description":"Order marker information",
"type":"array",
"items":{
"type":"object",
"properties":{
"value":{
"description":"Order marker value. e.g. In case of marketing campaign, value represents actual unique campaign Id",
"type":"string",
"example":"78900"
},
"key":{
"description":"Order marker key. In a marketing campaign marker, a key signifies that it is a campaign marker. Also, it identifies the external marketing system that is the source of the campaign, e.g., campaign_eloqua",
"type":"string",
"example":"campaign_eloqua"
}
}
}
}
Nested Schema : payments
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"paymentGroupId":{
"type":"string"
},
"amount":{
"type":"integer"
},
"balance":{
"type":"number"
},
"gatewayName":{
"type":"string"
},
"giftCardNumber":{
"type":"integer"
},
"uiIntervention":{
"type":"string"
},
"paymentMethod":{
"type":"string"
},
"isAmountRemaining":{
"type":"boolean"
},
"paymentState":{
"type":"string"
},
"maskedCardNumber":{
"type":"string"
}
}
}
}
Nested Schema : priceInfo
Type: object
Show Source
{
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"The secondary currency tax amount.",
"type":"number"
},
"amount":{
"type":"number"
},
"total":{
"type":"number"
},
"secondaryCurrencyShippingAmount":{
"description":"The secondary currency shipping amount.",
"type":"number"
},
"shipping":{
"type":"number"
},
"secondaryCurrencyTotal":{
"description":"The secondary currency total amount.",
"type":"number"
},
"primaryCurrencyTotal":{
"description":"The primary currency total amount.",
"type":"number"
},
"shippingSurchargeValue":{
"type":"number"
},
"tax":{
"type":"number"
},
"subTotal":{
"type":"number"
},
"currencyCode":{
"type":"string"
},
"totalWithoutTax":{
"type":"number"
}
}
}
Nested Schema : shippingAddress
Type: object
Show Source
{
"type":"object",
"properties":{
"lastName":{
"type":"string"
},
"country":{
"type":"string"
},
"address3":{
"type":"string"
},
"address2":{
"type":"string"
},
"city":{
"type":"string"
},
"address1":{
"type":"string"
},
"prefix":{
"type":"string"
},
"companyName":{
"type":"string"
},
"postalCode":{
"type":"string"
},
"jobTitle":{
"type":"string"
},
"county":{
"type":"string"
},
"suffix":{
"type":"string"
},
"firstName":{
"type":"string"
},
"phoneNumber":{
"type":"integer"
},
"faxNumber":{
"type":"integer"
},
"middleName":{
"type":"string"
},
"state":{
"type":"string"
},
"email":{
"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"
},
"cityTax":{
"description":"City Tax",
"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"
}
}
},
"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"
},
"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"
}
}
},
"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"
},
"discountInfo":{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
}
}
},
"recurringChargePriceInfo":{
"type":"string"
},
"shippingMethod":{
"description":"The shipping method details for the order.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":" The secondary currency tax amount.",
"type":"number"
},
"shippingTax":{
"type":"number"
},
"secondaryCurrencyShippingAmount":{
"description":" The secondary currency shipping amount.",
"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"
}
}
},
"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"
}
}
},
"items":{
"type":"array",
"items":{
"type":"object",
"properties":{
"rawTotalPrice":{
"description":"The raw total price.",
"type":"number"
},
"shippingSurchargeValue":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"availabilityDate":{
"format":"date-time",
"description":"The availability date for preOrdered/backOrdered quantity.",
"type":"string"
},
"discountAmount":{
"description":"The monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal. (read-only)",
"type":"number"
},
"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"
},
"childItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
}
}
},
"configuratorId":{
"type":"string"
},
"price":{
"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":"Whether is on sale.",
"type":"boolean"
},
"actionCode":{
"description":"The action code that has been set on the item by the third party system.",
"type":"string"
},
"stateDetailsAsUser":{
"type":"string"
},
"unitPrice":{
"type":"number"
},
"amount":{
"description":"The monetary amount.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this price info",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"detailedItemPriceInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean"
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"amount":{
"type":"number"
},
"quantity":{
"type":"integer"
},
"tax":{
"type":"number"
},
"orderDiscountShare":{
"type":"integer"
},
"detailedUnitPrice":{
"type":"number"
},
"currencyCode":{
"type":"string"
}
}
}
},
"catRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"discountInfo":{
"description":"Whether this item is discounted.",
"type":"array",
"items":{
"type":"object",
"properties":{
}
}
},
"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"
},
"backOrderQuantity":{
"description":"The back ordered quantity included.",
"type":"integer"
},
"commercerItemId":{
"description":"Commerce Item ID for this commerce item.",
"type":"string"
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
},
"commercerId":{
"description":"Commerce ID for this commerce item.",
"type":"string"
},
"status":{
"type":"string"
}
}
}
}
}
}
}
Nested Schema : shippingMethod
Type: object
Show Source
{
"type":"object",
"properties":{
"shippingTax":{
"type":"number"
},
"cost":{
"type":"number"
},
"value":{
"type":"string"
}
}
}
Nested Schema : shoppingCart
Type: object
Show Source
-
items:
array items
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
-
itemsIsTruncated:
boolean
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
-
numberOfItems:
integer
{
"type":"object",
"properties":{
"itemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding items property is truncated. The value for this field will always be true if present",
"type":"boolean"
},
"numberOfItems":{
"type":"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":{
"primaryThumbImageURL":{
"type":"string"
},
"rawTotalPrice":{
"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"
}
}
}
},
"displayName":{
"type":"string"
},
"shippingSurchargeValue":{
"type":"integer"
},
"description":{
"type":"string"
},
"discountAmount":{
"type":"number"
},
"isItemValid":{
"type":"boolean"
},
"configuratorId":{
"type":"string"
},
"externalPrice":{
"type":"number"
},
"price":{
"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"
}
}
}
},
"childItemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding childItems property is truncated. The value for this field will be true always if present",
"type":"boolean"
},
"onSale":{
"type":"boolean"
},
"id":{
"type":"string"
},
"unitPrice":{
"type":"number"
},
"secondaryCurrencyShippingSurcharge":{
"type":"integer"
},
"quantity":{
"type":"integer"
},
"productId":{
"type":"string"
},
"salePrice":{
"type":"number"
},
"externalRecurringCharge":{
"type":"number"
},
"detailedItemPriceInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean"
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"amount":{
"type":"number"
},
"quantity":{
"type":"integer"
},
"tax":{
"type":"number"
},
"orderDiscountShare":{
"type":"integer"
},
"detailedUnitPrice":{
"type":"number"
},
"currencyCode":{
"type":"string"
}
}
}
},
"externalRecurringChargeFrequency":{
"type":"string"
},
"externalPriceQuantity":{
"type":"integer"
},
"catRefId":{
"type":"string"
},
"externalRecurringChargeDuration":{
"type":"string"
},
"discountInfo":{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean"
},
"coupon":{
"description":"The coupon ID.",
"type":"string"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"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"
},
"listPrice":{
"type":"number"
}
}
}
}
}
}
Nested Schema : taxPriceInfo
Type: object
Show Source
{
"type":"object",
"properties":{
"cityTax":{
"type":"number"
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"amount":{
"type":"number"
},
"valueAddedTax":{
"type":"number"
},
"countyTax":{
"type":"number"
},
"isTaxIncluded":{
"type":"boolean"
},
"miscTax":{
"type":"number"
},
"districtTax":{
"type":"number"
},
"stateTax":{
"type":"number"
},
"countryTax":{
"type":"number"
}
}
}
Nested Schema : orderCouponsMap
Type: object
The coupons that were claimed.
Show Source
{
"description":"The coupons that were claimed.",
"type":"object",
"properties":{
"couponCode":{
"description":"Coupon Code.",
"type":"object",
"properties":{
"promotionLongDesc":{
"description":"The description of the promotion.",
"type":"string"
},
"promotionName":{
"description":"The display name of the promotion.",
"type":"string"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean"
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"number"
},
"promotionDesc":{
"description":"Description of the promotion. Retained for backward compatibility.",
"type":"string"
},
"promotionId":{
"description":"The Id of the promotion.",
"type":"string"
}
}
}
}
}
Nested Schema : couponCode
Type: object
Coupon Code.
Show Source
{
"description":"Coupon Code.",
"type":"object",
"properties":{
"promotionLongDesc":{
"description":"The description of the promotion.",
"type":"string"
},
"promotionName":{
"description":"The display name of the promotion.",
"type":"string"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean"
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"number"
},
"promotionDesc":{
"description":"Description of the promotion. Retained for backward compatibility.",
"type":"string"
},
"promotionId":{
"description":"The Id of the promotion.",
"type":"string"
}
}
}
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
-
key:
string
Order marker key. In a marketing campaign marker, a key signifies that it is a campaign marker. Also, it identifies the external marketing system that is the source of the campaign, e.g., campaign_eloqua
Example: campaign_eloqua
-
value:
string
Order marker value. e.g. In case of marketing campaign, value represents actual unique campaign Id
Example: 78900
{
"type":"object",
"properties":{
"value":{
"description":"Order marker value. e.g. In case of marketing campaign, value represents actual unique campaign Id",
"type":"string",
"example":"78900"
},
"key":{
"description":"Order marker key. In a marketing campaign marker, a key signifies that it is a campaign marker. Also, it identifies the external marketing system that is the source of the campaign, e.g., campaign_eloqua",
"type":"string",
"example":"campaign_eloqua"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"paymentGroupId":{
"type":"string"
},
"amount":{
"type":"integer"
},
"balance":{
"type":"number"
},
"gatewayName":{
"type":"string"
},
"giftCardNumber":{
"type":"integer"
},
"uiIntervention":{
"type":"string"
},
"paymentMethod":{
"type":"string"
},
"isAmountRemaining":{
"type":"boolean"
},
"paymentState":{
"type":"string"
},
"maskedCardNumber":{
"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"
},
"cityTax":{
"description":"City Tax",
"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"
}
}
},
"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"
},
"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"
}
}
},
"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"
},
"discountInfo":{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
}
}
},
"recurringChargePriceInfo":{
"type":"string"
},
"shippingMethod":{
"description":"The shipping method details for the order.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":" The secondary currency tax amount.",
"type":"number"
},
"shippingTax":{
"type":"number"
},
"secondaryCurrencyShippingAmount":{
"description":" The secondary currency shipping amount.",
"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"
}
}
},
"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"
}
}
},
"items":{
"type":"array",
"items":{
"type":"object",
"properties":{
"rawTotalPrice":{
"description":"The raw total price.",
"type":"number"
},
"shippingSurchargeValue":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"availabilityDate":{
"format":"date-time",
"description":"The availability date for preOrdered/backOrdered quantity.",
"type":"string"
},
"discountAmount":{
"description":"The monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal. (read-only)",
"type":"number"
},
"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"
},
"childItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
}
}
},
"configuratorId":{
"type":"string"
},
"price":{
"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":"Whether is on sale.",
"type":"boolean"
},
"actionCode":{
"description":"The action code that has been set on the item by the third party system.",
"type":"string"
},
"stateDetailsAsUser":{
"type":"string"
},
"unitPrice":{
"type":"number"
},
"amount":{
"description":"The monetary amount.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this price info",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"detailedItemPriceInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean"
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"amount":{
"type":"number"
},
"quantity":{
"type":"integer"
},
"tax":{
"type":"number"
},
"orderDiscountShare":{
"type":"integer"
},
"detailedUnitPrice":{
"type":"number"
},
"currencyCode":{
"type":"string"
}
}
}
},
"catRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"discountInfo":{
"description":"Whether this item is discounted.",
"type":"array",
"items":{
"type":"object",
"properties":{
}
}
},
"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"
},
"backOrderQuantity":{
"description":"The back ordered quantity included.",
"type":"integer"
},
"commercerItemId":{
"description":"Commerce Item ID for this commerce item.",
"type":"string"
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
},
"commercerId":{
"description":"Commerce ID for this commerce item.",
"type":"string"
},
"status":{
"type":"string"
}
}
}
}
}
}
Nested Schema : discountInfo
Type: array
The discount information.
Show Source
{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
}
}
}
Nested Schema : items
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"rawTotalPrice":{
"description":"The raw total price.",
"type":"number"
},
"shippingSurchargeValue":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"availabilityDate":{
"format":"date-time",
"description":"The availability date for preOrdered/backOrdered quantity.",
"type":"string"
},
"discountAmount":{
"description":"The monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal. (read-only)",
"type":"number"
},
"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"
},
"childItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
}
}
},
"configuratorId":{
"type":"string"
},
"price":{
"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":"Whether is on sale.",
"type":"boolean"
},
"actionCode":{
"description":"The action code that has been set on the item by the third party system.",
"type":"string"
},
"stateDetailsAsUser":{
"type":"string"
},
"unitPrice":{
"type":"number"
},
"amount":{
"description":"The monetary amount.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this price info",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"detailedItemPriceInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean"
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"amount":{
"type":"number"
},
"quantity":{
"type":"integer"
},
"tax":{
"type":"number"
},
"orderDiscountShare":{
"type":"integer"
},
"detailedUnitPrice":{
"type":"number"
},
"currencyCode":{
"type":"string"
}
}
}
},
"catRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"discountInfo":{
"description":"Whether this item is discounted.",
"type":"array",
"items":{
"type":"object",
"properties":{
}
}
},
"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"
},
"backOrderQuantity":{
"description":"The back ordered quantity included.",
"type":"integer"
},
"commercerItemId":{
"description":"Commerce Item ID for this commerce item.",
"type":"string"
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
},
"commercerId":{
"description":"Commerce ID for this commerce item.",
"type":"string"
},
"status":{
"type":"string"
}
}
}
}
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"
},
"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 : 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 : 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":" The secondary currency tax amount.",
"type":"number"
},
"shippingTax":{
"type":"number"
},
"secondaryCurrencyShippingAmount":{
"description":" The secondary currency shipping amount.",
"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 : taxPriceInfo
Type: object
The shipping address details.
Show Source
{
"description":"The shipping address details.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"taxAmount in secondaryCurrency",
"type":"number"
},
"cityTax":{
"description":"City Tax",
"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 : items
Type: object
Show Source
{
"type":"object",
"properties":{
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"rawTotalPrice":{
"description":"The raw total price.",
"type":"number"
},
"shippingSurchargeValue":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"availabilityDate":{
"format":"date-time",
"description":"The availability date for preOrdered/backOrdered quantity.",
"type":"string"
},
"discountAmount":{
"description":"The monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal. (read-only)",
"type":"number"
},
"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"
},
"childItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
}
}
},
"configuratorId":{
"type":"string"
},
"price":{
"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":"Whether is on sale.",
"type":"boolean"
},
"actionCode":{
"description":"The action code that has been set on the item by the third party system.",
"type":"string"
},
"stateDetailsAsUser":{
"type":"string"
},
"unitPrice":{
"type":"number"
},
"amount":{
"description":"The monetary amount.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this price info",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"detailedItemPriceInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean"
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"amount":{
"type":"number"
},
"quantity":{
"type":"integer"
},
"tax":{
"type":"number"
},
"orderDiscountShare":{
"type":"integer"
},
"detailedUnitPrice":{
"type":"number"
},
"currencyCode":{
"type":"string"
}
}
}
},
"catRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"discountInfo":{
"description":"Whether this item is discounted.",
"type":"array",
"items":{
"type":"object",
"properties":{
}
}
},
"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"
},
"backOrderQuantity":{
"description":"The back ordered quantity included.",
"type":"integer"
},
"commercerItemId":{
"description":"Commerce Item ID for this commerce item.",
"type":"string"
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
},
"commercerId":{
"description":"Commerce ID for this commerce item.",
"type":"string"
},
"status":{
"type":"string"
}
}
}
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"
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"amount":{
"type":"number"
},
"quantity":{
"type":"integer"
},
"tax":{
"type":"number"
},
"orderDiscountShare":{
"type":"integer"
},
"detailedUnitPrice":{
"type":"number"
},
"currencyCode":{
"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":{
}
}
}
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"
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"amount":{
"type":"number"
},
"quantity":{
"type":"integer"
},
"tax":{
"type":"number"
},
"orderDiscountShare":{
"type":"integer"
},
"detailedUnitPrice":{
"type":"number"
},
"currencyCode":{
"type":"string"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
}
}
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 : items
Type: array
The array of products in the shopping cart. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook
Show Source
{
"description":"The array of products in the shopping cart. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook",
"type":"array",
"items":{
"type":"object",
"properties":{
"primaryThumbImageURL":{
"type":"string"
},
"rawTotalPrice":{
"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"
}
}
}
},
"displayName":{
"type":"string"
},
"shippingSurchargeValue":{
"type":"integer"
},
"description":{
"type":"string"
},
"discountAmount":{
"type":"number"
},
"isItemValid":{
"type":"boolean"
},
"configuratorId":{
"type":"string"
},
"externalPrice":{
"type":"number"
},
"price":{
"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"
}
}
}
},
"childItemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding childItems property is truncated. The value for this field will be true always if present",
"type":"boolean"
},
"onSale":{
"type":"boolean"
},
"id":{
"type":"string"
},
"unitPrice":{
"type":"number"
},
"secondaryCurrencyShippingSurcharge":{
"type":"integer"
},
"quantity":{
"type":"integer"
},
"productId":{
"type":"string"
},
"salePrice":{
"type":"number"
},
"externalRecurringCharge":{
"type":"number"
},
"detailedItemPriceInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean"
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"amount":{
"type":"number"
},
"quantity":{
"type":"integer"
},
"tax":{
"type":"number"
},
"orderDiscountShare":{
"type":"integer"
},
"detailedUnitPrice":{
"type":"number"
},
"currencyCode":{
"type":"string"
}
}
}
},
"externalRecurringChargeFrequency":{
"type":"string"
},
"externalPriceQuantity":{
"type":"integer"
},
"catRefId":{
"type":"string"
},
"externalRecurringChargeDuration":{
"type":"string"
},
"discountInfo":{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean"
},
"coupon":{
"description":"The coupon ID.",
"type":"string"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"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"
},
"listPrice":{
"type":"number"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"primaryThumbImageURL":{
"type":"string"
},
"rawTotalPrice":{
"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"
}
}
}
},
"displayName":{
"type":"string"
},
"shippingSurchargeValue":{
"type":"integer"
},
"description":{
"type":"string"
},
"discountAmount":{
"type":"number"
},
"isItemValid":{
"type":"boolean"
},
"configuratorId":{
"type":"string"
},
"externalPrice":{
"type":"number"
},
"price":{
"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"
}
}
}
},
"childItemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding childItems property is truncated. The value for this field will be true always if present",
"type":"boolean"
},
"onSale":{
"type":"boolean"
},
"id":{
"type":"string"
},
"unitPrice":{
"type":"number"
},
"secondaryCurrencyShippingSurcharge":{
"type":"integer"
},
"quantity":{
"type":"integer"
},
"productId":{
"type":"string"
},
"salePrice":{
"type":"number"
},
"externalRecurringCharge":{
"type":"number"
},
"detailedItemPriceInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean"
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"amount":{
"type":"number"
},
"quantity":{
"type":"integer"
},
"tax":{
"type":"number"
},
"orderDiscountShare":{
"type":"integer"
},
"detailedUnitPrice":{
"type":"number"
},
"currencyCode":{
"type":"string"
}
}
}
},
"externalRecurringChargeFrequency":{
"type":"string"
},
"externalPriceQuantity":{
"type":"integer"
},
"catRefId":{
"type":"string"
},
"externalRecurringChargeDuration":{
"type":"string"
},
"discountInfo":{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean"
},
"coupon":{
"description":"The coupon ID.",
"type":"string"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"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"
},
"listPrice":{
"type":"number"
}
}
}
Nested Schema : detailedItemPriceInfo
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean"
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"amount":{
"type":"number"
},
"quantity":{
"type":"integer"
},
"tax":{
"type":"number"
},
"orderDiscountShare":{
"type":"integer"
},
"detailedUnitPrice":{
"type":"number"
},
"currencyCode":{
"type":"string"
}
}
}
}
Nested Schema : discountInfo
Type: array
The discount information.
Show Source
{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean"
},
"coupon":{
"description":"The coupon ID.",
"type":"string"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string"
}
}
}
}
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 : 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
{
"type":"object",
"properties":{
"discounted":{
"type":"boolean"
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"amount":{
"type":"number"
},
"quantity":{
"type":"integer"
},
"tax":{
"type":"number"
},
"orderDiscountShare":{
"type":"integer"
},
"detailedUnitPrice":{
"type":"number"
},
"currencyCode":{
"type":"string"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean"
},
"coupon":{
"description":"The coupon ID.",
"type":"string"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string"
}
}
}
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"
}
}
}
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":{
"receiveEmail":{
"description":"Indicates whether the user should receive marketing emails on the current site. Can be yes or no.",
"type":"string"
}
}
}
}
}
}
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":{
"receiveEmail":{
"description":"Indicates whether the user should receive marketing emails on the current site. Can be yes or no.",
"type":"string"
}
}
}
}
}
Nested Schema : properties
Type: object
The site related properties for the profile
Show Source
-
receiveEmail:
string
Indicates whether the user should receive marketing emails on the current site. Can be yes or no.
{
"description":"The site related properties for the profile",
"type":"object",
"properties":{
"receiveEmail":{
"description":"Indicates whether the user should receive marketing emails on the current site. Can be yes or no.",
"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"
}
}
}