A webhook for validating the contents of an order. This webhook is fired at order submit time and will be executed after final order pricing has been performed.
Root Schema : orderValidation_request
Type: object
A webhook for validating the contents of an order. This webhook is fired at order submit time and will be executed after final order pricing has been performed.
Show Source
{
"description":"A webhook for validating the contents of an order. This webhook is fired at order submit time and will be executed after final order pricing has been performed.",
"properties":{
"profile":{
"type":"object",
"properties":{
"firstName":{
"type":"string"
},
"lastName":{
"type":"string"
},
"customerContactId":{
"description":"The external customer contact id.",
"type":"string"
},
"loyaltyPrograms":{
"type":"array",
"items":{
"type":"object",
"properties":{
"programName":{
"description":"Loyalty program name",
"type":"string"
},
"profileId":{
"description":"User profile id",
"type":"string"
},
"membershipId":{
"description":"Membership id of user.",
"type":"string"
},
"programId":{
"description":"Program id of loyalty program ",
"type":"string"
},
"status":{
"description":"status of Enrollment. It must be in any of 'RequestForEnrollment', 'Enrolled', 'RequestForUnenrollment', 'Unenrolled', 'Failed' states.",
"type":"string"
}
}
}
},
"receiveEmail":{
"description":"The string representation of whether the user wants to recieve email or not",
"type":"string"
},
"middleName":{
"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":{
"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"
}
}
}
}
}
},
"daytimeTelephoneNumber":{
"description":"The day time phone number of the profile",
"type":"string"
}
}
},
"organization":{
"$ref":"#/definitions/orderValidationOrganization"
},
"operation":{
"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"
}
}
},
"assetable":{
"description":"A flag that denotes if the order contains one or more items that are assetable.",
"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"
},
"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"
},
"lkpValExcludingFreeShip":{
"description":"The total shipping cost excluding items with free shipping.",
"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"
},
"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":"array",
"items":{
"type":"object",
"properties":{
}
}
},
"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":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"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"
}
}
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"preOrderQuantity":{
"description":"The pre ordered quantity included.",
"type":"integer"
},
"childItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
}
}
},
"configuratorId":{
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"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"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"stateDetailsAsUser":{
"type":"string"
},
"unitPrice":{
"type":"number"
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"assetable":{
"description":"Flag to denote that the item is a potential service.",
"type":"string"
},
"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"
}
}
}
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"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":{
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"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"
},
"asset":{
"description":"The flag that defines it the item is an asset or not.",
"type":"boolean"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"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"
},
"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"
}
}
},
"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"
}
}
},
"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"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"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"
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"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":{
"type":"object",
"properties":{
}
}
},
"configuratorId":{
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"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"
},
"actionCode":{
"description":"The action code that has been set on the item by the third party system.",
"type":"string"
},
"id":{
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"unitPrice":{
"type":"number"
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"assetable":{
"type":"string"
},
"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"
}
}
}
},
"orderDiscountInfos":{
"description":"Array of order promotions affecting this item.",
"type":"array",
"items":{
"type":"object",
"properties":{
"couponCodes":{
"description":"One or more coupon codes used to grant the order promotion providing the discount.",
"type":"array",
"items":{
"type":"string"
}
},
"amount":{
"description":"The amount of discount this item received from the promotion.",
"type":"number"
},
"promotionId":{
"description":"The promotion id that resulted in the discount.",
"type":"string"
}
}
}
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeFrequency":{
"type":"string"
},
"externalPriceQuantity":{
"type":"integer"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"catRefId":{
"type":"string"
},
"externalRecurringChargeDuration":{
"type":"string"
},
"discountInfo":{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"coupon":{
"description":"The coupon ID.",
"type":"string"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string"
}
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"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"
},
"asset":{
"description":"The flag that defines it the item is an asset or not.",
"type":"boolean"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"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":{
"description":"The ID of the site on which the order was placed.",
"type":"string"
}
}
}
},
"example":{
"profile":{
"lastName":"Anderson",
"firstName":"Kim",
"customerContactId":"se-570031",
"receiveEmail":"no",
"currentOrganization":null,
"parentOrganization":null,
"locale":"en",
"email":"kim@example.com",
"sitePropertiesList":[
{
"site":{
"id":"siteUS"
},
"properties":{
"numberOfVisits":29,
"GDPRProfileP13nConsentDate":null,
"GDPRProfileP13nConsentGranted":false,
"receiveEmail":"no",
"receiveEmailDate":null
}
}
],
"daytimeTelephoneNumber":null
},
"order":{
"taxPriceInfo":{
"cityTax":0,
"secondaryCurrencyTaxAmount":0,
"amount":0,
"valueAddedTax":0,
"countyTax":0,
"isTaxIncluded":false,
"miscTax":0,
"districtTax":0,
"stateTax":0,
"countryTax":0
},
"shippingGroups":[
{
"shippingMethod":{
"secondaryCurrencyTaxAmount":0,
"shippingTax":0,
"cost":0,
"taxIncluded":true,
"taxCode":"",
"value":"groundShippingMethod",
"shippingMethodDescription":"Ground"
},
"shippingGroupId":"sg220413",
"shippingAddress":{
"lastName":"test",
"country":"US",
"address3":"",
"address2":"",
"city":"Syracuse",
"prefix":"",
"address1":"21 Cedar Ave",
"postalCode":"13202",
"companyName":"",
"jobTitle":"",
"county":"",
"suffix":"",
"firstName":"test",
"phoneNumber":"212-555-1977",
"faxNumber":"",
"alias":null,
"middleName":"",
"state":"NY",
"email":"test@example.com"
},
"type":"hardgoodShippingGroup",
"items":[
{
"rawTotalPrice":0,
"returnedQuantity":0,
"shippingSurchargeValue":0,
"externalData":[
],
"discountAmount":0,
"preOrderQuantity":0,
"childItems":[
],
"configuratorId":"18225093",
"externalPrice":0,
"commerceItemId":"ci1493723487427",
"price":0,
"onSale":false,
"stateDetailsAsUser":"The item has been initialized within the shipping group",
"commerceId":"ci21000413",
"unitPrice":0,
"assetable":false,
"amount":0,
"quantity":2,
"pointOfNoRevision":false,
"productId":"laptop",
"salePrice":0,
"externalRecurringCharge":50,
"externalPriceQuantity":-1,
"externalRecurringChargeFrequency":"Monthly",
"catRefId":"sku50001",
"externalRecurringChargeDuration":"12",
"discountInfo":[
],
"siteId":"siteUS",
"shopperInput":{
},
"asset":false,
"backOrderQuantity":0,
"listPrice":0,
"status":"INITIAL"
}
]
}
],
"creationTime":1.554728617709E12,
"orderId":"o210413",
"lastModifiedDate":"2019-04-08T13:03:37.709Z",
"shippingMethod":{
"shippingTax":0,
"cost":0,
"value":"groundShippingMethod"
},
"orderStatus":"Incomplete",
"cartName":"o210413",
"creationDate":"2019-04-08T13:03:37.709Z",
"orderProfileId":"se-570031",
"orderAction":"order",
"priceInfo":{
"amount":0,
"total":0,
"shipping":0,
"shippingSurchargeValue":0,
"tax":0,
"subTotal":0,
"currencyCode":null,
"totalWithoutTax":0
},
"shoppingCart":{
"numberOfItems":2,
"items":[
{
"primaryThumbImageURL":"/img/no-image.jpg",
"rawTotalPrice":0,
"displayName":"Laptop",
"shippingSurchargeValue":0,
"discountAmount":0,
"externalData":[
],
"description":"laptop",
"isItemValid":true,
"childItems":[
],
"configuratorId":"18225093",
"externalPrice":0,
"commerceItemId":"ci1493723487427",
"price":0,
"variant":[
],
"onSale":false,
"id":"ci21000413",
"state":"Added to order",
"stateKey":"INITIAL",
"unitPrice":0,
"assetable":false,
"amount":0,
"quantity":2,
"productId":"laptop",
"salePrice":0,
"detailedItemPriceInfo":[
],
"externalRecurringCharge":50,
"orderDiscountInfos":[
],
"giftWithPurchaseCommerceItemMarkers":[
],
"externalPriceQuantity":-1,
"externalRecurringChargeFrequency":"Monthly",
"catRefId":"sku50001",
"externalRecurringChargeDuration":"12",
"discountInfo":[
],
"siteId":"siteUS",
"shopperInput":{
},
"asset":false,
"listPrice":0
}
]
},
"siteId":"siteUS",
"shippingAddress":{
"lastName":"test",
"country":"US",
"address3":"",
"address2":"",
"city":"Syracuse",
"prefix":"",
"address1":"21 Cedar Ave",
"postalCode":"13202",
"companyName":"",
"jobTitle":"",
"county":"",
"suffix":"",
"firstName":"test",
"phoneNumber":"212-555-1977",
"faxNumber":"",
"alias":null,
"middleName":"",
"state":"NY",
"email":"test@example.com"
}
}
}
}
Example:
{
"profile":{
"lastName":"Anderson",
"firstName":"Kim",
"customerContactId":"se-570031",
"receiveEmail":"no",
"currentOrganization":null,
"parentOrganization":null,
"locale":"en",
"email":"kim@example.com",
"sitePropertiesList":[
{
"site":{
"id":"siteUS"
},
"properties":{
"numberOfVisits":29,
"GDPRProfileP13nConsentDate":null,
"GDPRProfileP13nConsentGranted":false,
"receiveEmail":"no",
"receiveEmailDate":null
}
}
],
"daytimeTelephoneNumber":null
},
"order":{
"taxPriceInfo":{
"cityTax":0,
"secondaryCurrencyTaxAmount":0,
"amount":0,
"valueAddedTax":0,
"countyTax":0,
"isTaxIncluded":false,
"miscTax":0,
"districtTax":0,
"stateTax":0,
"countryTax":0
},
"shippingGroups":[
{
"shippingMethod":{
"secondaryCurrencyTaxAmount":0,
"shippingTax":0,
"cost":0,
"taxIncluded":true,
"taxCode":"",
"value":"groundShippingMethod",
"shippingMethodDescription":"Ground"
},
"shippingGroupId":"sg220413",
"shippingAddress":{
"lastName":"test",
"country":"US",
"address3":"",
"address2":"",
"city":"Syracuse",
"prefix":"",
"address1":"21 Cedar Ave",
"postalCode":"13202",
"companyName":"",
"jobTitle":"",
"county":"",
"suffix":"",
"firstName":"test",
"phoneNumber":"212-555-1977",
"faxNumber":"",
"alias":null,
"middleName":"",
"state":"NY",
"email":"test@example.com"
},
"type":"hardgoodShippingGroup",
"items":[
{
"rawTotalPrice":0,
"returnedQuantity":0,
"shippingSurchargeValue":0,
"externalData":[
],
"discountAmount":0,
"preOrderQuantity":0,
"childItems":[
],
"configuratorId":"18225093",
"externalPrice":0,
"commerceItemId":"ci1493723487427",
"price":0,
"onSale":false,
"stateDetailsAsUser":"The item has been initialized within the shipping group",
"commerceId":"ci21000413",
"unitPrice":0,
"assetable":false,
"amount":0,
"quantity":2,
"pointOfNoRevision":false,
"productId":"laptop",
"salePrice":0,
"externalRecurringCharge":50,
"externalPriceQuantity":-1,
"externalRecurringChargeFrequency":"Monthly",
"catRefId":"sku50001",
"externalRecurringChargeDuration":"12",
"discountInfo":[
],
"siteId":"siteUS",
"shopperInput":{
},
"asset":false,
"backOrderQuantity":0,
"listPrice":0,
"status":"INITIAL"
}
]
}
],
"creationTime":1.554728617709E12,
"orderId":"o210413",
"lastModifiedDate":"2019-04-08T13:03:37.709Z",
"shippingMethod":{
"shippingTax":0,
"cost":0,
"value":"groundShippingMethod"
},
"orderStatus":"Incomplete",
"cartName":"o210413",
"creationDate":"2019-04-08T13:03:37.709Z",
"orderProfileId":"se-570031",
"orderAction":"order",
"priceInfo":{
"amount":0,
"total":0,
"shipping":0,
"shippingSurchargeValue":0,
"tax":0,
"subTotal":0,
"currencyCode":null,
"totalWithoutTax":0
},
"shoppingCart":{
"numberOfItems":2,
"items":[
{
"primaryThumbImageURL":"/img/no-image.jpg",
"rawTotalPrice":0,
"displayName":"Laptop",
"shippingSurchargeValue":0,
"discountAmount":0,
"externalData":[
],
"description":"laptop",
"isItemValid":true,
"childItems":[
],
"configuratorId":"18225093",
"externalPrice":0,
"commerceItemId":"ci1493723487427",
"price":0,
"variant":[
],
"onSale":false,
"id":"ci21000413",
"state":"Added to order",
"stateKey":"INITIAL",
"unitPrice":0,
"assetable":false,
"amount":0,
"quantity":2,
"productId":"laptop",
"salePrice":0,
"detailedItemPriceInfo":[
],
"externalRecurringCharge":50,
"orderDiscountInfos":[
],
"giftWithPurchaseCommerceItemMarkers":[
],
"externalPriceQuantity":-1,
"externalRecurringChargeFrequency":"Monthly",
"catRefId":"sku50001",
"externalRecurringChargeDuration":"12",
"discountInfo":[
],
"siteId":"siteUS",
"shopperInput":{
},
"asset":false,
"listPrice":0
}
]
},
"siteId":"siteUS",
"shippingAddress":{
"lastName":"test",
"country":"US",
"address3":"",
"address2":"",
"city":"Syracuse",
"prefix":"",
"address1":"21 Cedar Ave",
"postalCode":"13202",
"companyName":"",
"jobTitle":"",
"county":"",
"suffix":"",
"firstName":"test",
"phoneNumber":"212-555-1977",
"faxNumber":"",
"alias":null,
"middleName":"",
"state":"NY",
"email":"test@example.com"
}
}
}
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"
}
}
},
"assetable":{
"description":"A flag that denotes if the order contains one or more items that are assetable.",
"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"
},
"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"
},
"lkpValExcludingFreeShip":{
"description":"The total shipping cost excluding items with free shipping.",
"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"
},
"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":"array",
"items":{
"type":"object",
"properties":{
}
}
},
"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":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"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"
}
}
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"preOrderQuantity":{
"description":"The pre ordered quantity included.",
"type":"integer"
},
"childItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
}
}
},
"configuratorId":{
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"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"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"stateDetailsAsUser":{
"type":"string"
},
"unitPrice":{
"type":"number"
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"assetable":{
"description":"Flag to denote that the item is a potential service.",
"type":"string"
},
"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"
}
}
}
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"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":{
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"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"
},
"asset":{
"description":"The flag that defines it the item is an asset or not.",
"type":"boolean"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"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"
},
"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"
}
}
},
"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"
}
}
},
"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"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"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"
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"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":{
"type":"object",
"properties":{
}
}
},
"configuratorId":{
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"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"
},
"actionCode":{
"description":"The action code that has been set on the item by the third party system.",
"type":"string"
},
"id":{
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"unitPrice":{
"type":"number"
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"assetable":{
"type":"string"
},
"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"
}
}
}
},
"orderDiscountInfos":{
"description":"Array of order promotions affecting this item.",
"type":"array",
"items":{
"type":"object",
"properties":{
"couponCodes":{
"description":"One or more coupon codes used to grant the order promotion providing the discount.",
"type":"array",
"items":{
"type":"string"
}
},
"amount":{
"description":"The amount of discount this item received from the promotion.",
"type":"number"
},
"promotionId":{
"description":"The promotion id that resulted in the discount.",
"type":"string"
}
}
}
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeFrequency":{
"type":"string"
},
"externalPriceQuantity":{
"type":"integer"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"catRefId":{
"type":"string"
},
"externalRecurringChargeDuration":{
"type":"string"
},
"discountInfo":{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"coupon":{
"description":"The coupon ID.",
"type":"string"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string"
}
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"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"
},
"asset":{
"description":"The flag that defines it the item is an asset or not.",
"type":"boolean"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"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":{
"description":"The ID of the site on which the order was placed.",
"type":"string"
}
}
}
Nested Schema : orderValidationOrganization
Type: object
Show Source
{
"type":"object",
"properties":{
"taxReferenceNumber":{
"description":"Tax Reference Number of the Organization",
"type":"string"
},
"siteOrganizationProperties":{
"description":"Site Organization Properties",
"type":"object",
"properties":{
"site":{
"description":"Site information",
"type":"object",
"properties":{
"approvalRequired":{
"description":"Approval flag is required for the organization, by default it is set to false",
"type":"boolean"
},
"contract":{
"description":"Contract",
"type":"object",
"properties":{
"endDate":{
"description":"Contract end date time stamp",
"type":"string"
},
"terms":{
"description":"Terms and Conditions",
"type":"object",
"properties":{
"terms":{
"description":"Terms and Conditions",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of terms and conditions",
"type":"string"
}
}
},
"catalog":{
"description":"Catalog associated with contract",
"type":"object",
"properties":{
"displayName":{
"description":"Name of the catalog",
"type":"string"
},
"id":{
"description":"id of the catalog",
"type":"string"
},
"status":{
"type":"string"
}
}
},
"displayName":{
"description":"Name of the contract",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of the contract",
"type":"string"
},
"description":{
"description":"Description for contract",
"type":"string"
},
"priceListGroup":{
"description":"Price ListGroup associated with contract",
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository Id of the price list group",
"type":"string"
}
}
},
"creationDate":{
"description":"Contract creation date time stamp",
"type":"string"
},
"startDate":{
"description":"Contract start date time stamp",
"type":"string"
},
"externalContractReference":{
"description":"External contract reference",
"type":"string"
}
}
},
"delegateApprovalManagement":{
"description":"This flag indicates if the delegated admin has the provision of approval management, if set merchant admin cannot do any approval management.",
"type":"boolean"
},
"useExternalApprovalWebhook":{
"description":"Flag to enable/disable Order Approval check from External Webhook",
"type":"boolean"
},
"orderPriceLimit":{
"description":"Its order limit value for the organization, if order limit is more than this value then approval is needed for the order",
"type":"number"
}
}
}
}
},
"childOrganizations":{
"type":"array",
"items":{
"type":"object"
}
},
"delegateApprovalManagement":{
"description":"This flag indicates if the delegated admin has the provision of approval management, if set merchant admin cannot do any approval management.",
"type":"boolean"
},
"approvers":{
"type":"array",
"items":{
"type":"object"
}
},
"type":{
"description":"Type for Organization",
"type":"string"
},
"derivedBillingAddress":{
"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"
},
"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"
},
"repositoryId":{
"description":"the id of the billing address",
"type":"string"
},
"county":{
"description":"the county of the billing address",
"type":"string"
},
"state":{
"description":"the state of the billing address",
"type":"string"
}
}
},
"customerType":{
"description":"Customer Type for Organization",
"type":"string"
},
"derivedContract":{
"description":"Contract",
"type":"object",
"properties":{
"endDate":{
"description":"Contract end date time stamp",
"type":"string"
},
"terms":{
"description":"Terms and Conditions",
"type":"object",
"properties":{
"terms":{
"description":"Terms and Conditions",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of terms and conditions",
"type":"string"
}
}
},
"catalog":{
"description":"Catalog associated with contract",
"type":"object",
"properties":{
"displayName":{
"description":"Name of the catalog",
"type":"string"
},
"id":{
"description":"id of the catalog",
"type":"string"
},
"status":{
"type":"string"
}
}
},
"displayName":{
"description":"Name of the contract",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of the contract",
"type":"string"
},
"description":{
"description":"Description for contract",
"type":"string"
},
"priceListGroup":{
"description":"Price ListGroup associated with contract",
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository Id of the price list group",
"type":"string"
}
}
},
"creationDate":{
"description":"Contract creation date time stamp",
"type":"string"
},
"startDate":{
"description":"Contract start date time stamp",
"type":"string"
},
"externalContractReference":{
"description":"External contract reference",
"type":"string"
}
}
},
"id":{
"description":"Id of the Organization",
"type":"string"
},
"dunsNumber":{
"description":"DUNS Number for Organization. Should be 9 digit number",
"type":"string"
},
"derivedTaxReferenceNumber":{
"description":"Derived taxReferenceNumber of the Organization",
"type":"string"
},
"derivedDunsNumber":{
"description":"Derived dunsNumber of the Organization",
"type":"string"
},
"contract":{
"description":"Contract",
"type":"object",
"properties":{
"endDate":{
"description":"Contract end date time stamp",
"type":"string"
},
"terms":{
"description":"Terms and Conditions",
"type":"object",
"properties":{
"terms":{
"description":"Terms and Conditions",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of terms and conditions",
"type":"string"
}
}
},
"catalog":{
"description":"Catalog associated with contract",
"type":"object",
"properties":{
"displayName":{
"description":"Name of the catalog",
"type":"string"
},
"id":{
"description":"id of the catalog",
"type":"string"
},
"status":{
"type":"string"
}
}
},
"displayName":{
"description":"Name of the contract",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of the contract",
"type":"string"
},
"description":{
"description":"Description for contract",
"type":"string"
},
"priceListGroup":{
"description":"Price ListGroup associated with contract",
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository Id of the price list group",
"type":"string"
}
}
},
"creationDate":{
"description":"Contract creation date time stamp",
"type":"string"
},
"startDate":{
"description":"Contract start date time stamp",
"type":"string"
},
"externalContractReference":{
"description":"External contract reference",
"type":"string"
}
}
},
"derivedCustomerType":{
"description":"Derived customer type of the Organization",
"type":"string"
},
"active":{
"description":"Active status of an Organization. Should be true or false. By default the value is set to true",
"type":"boolean"
},
"allApprovers":{
"description":"list of all the approvers",
"type":"array",
"items":{
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the apporver",
"type":"string"
},
"firstName":{
"description":"the first name of the approver",
"type":"string"
},
"middleName":{
"description":"the middle name of the approver",
"type":"string"
}
}
}
},
"derivedType":{
"description":"Derived type of the Organization",
"type":"string"
},
"derivedShippingAddress":{
"description":"The derived default shipping address for the Organization. This a read only attribute. This will come if property 'isDefaultShippingAddress' is set to 'true' in secondaryAddresses attribute or if parent has default shipping address.",
"type":"object",
"properties":{
"country":{
"description":"the country of the address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the company address",
"type":"string"
},
"address2":{
"description":"the address2 of the address",
"type":"string"
},
"city":{
"description":"the city of the address",
"type":"string"
},
"address1":{
"description":"the address1 of the address",
"type":"string"
},
"companyName":{
"description":"the company name shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the address",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of the address",
"type":"string"
},
"state":{
"description":"the state of the address",
"type":"string"
}
}
},
"derivedApprovalRequired":{
"description":"Approval flag is required for the organization, by default it is set to false",
"type":"boolean"
},
"approvalRequired":{
"description":"Approval flag is required for the organization, by default it is set to false",
"type":"boolean"
},
"name":{
"description":"The name for Organization",
"type":"string"
},
"ancestorOrganizations":{
"description":"List of ancestors for the Organization",
"type":"array",
"items":{
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository Id of the organization.",
"type":"string"
},
"name":{
"description":"Name of the organization.",
"type":"string"
},
"active":{
"description":"Active flag of the organization.",
"type":"boolean"
},
"id":{
"description":"Id of the organization.",
"type":"string"
}
}
}
},
"useExternalApprovalWebhook":{
"description":"Flag to enable/disable Order Approval check from External Webhook",
"type":"boolean"
},
"billingAddress":{
"description":"The default billing address for the Organization. This a read only attribute. This will come if property 'isDefaultBillingAddress' is set to 'true' in secondaryAddresses attribute.",
"type":"object",
"properties":{
"country":{
"description":"the country of the address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the address",
"type":"string"
},
"address2":{
"description":"the address2 of the address",
"type":"string"
},
"city":{
"description":"the city of the address",
"type":"string"
},
"address1":{
"description":"the address1 of the address",
"type":"string"
},
"companyName":{
"description":"the company name of the address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the address",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of the address",
"type":"string"
},
"state":{
"description":"the state of the address",
"type":"string"
}
}
},
"contacts":{
"type":"array",
"items":{
"type":"object"
}
}
}
}
Nested Schema : profile
Type: object
Show Source
{
"type":"object",
"properties":{
"firstName":{
"type":"string"
},
"lastName":{
"type":"string"
},
"customerContactId":{
"description":"The external customer contact id.",
"type":"string"
},
"loyaltyPrograms":{
"type":"array",
"items":{
"type":"object",
"properties":{
"programName":{
"description":"Loyalty program name",
"type":"string"
},
"profileId":{
"description":"User profile id",
"type":"string"
},
"membershipId":{
"description":"Membership id of user.",
"type":"string"
},
"programId":{
"description":"Program id of loyalty program ",
"type":"string"
},
"status":{
"description":"status of Enrollment. It must be in any of 'RequestForEnrollment', 'Enrolled', 'RequestForUnenrollment', 'Unenrolled', 'Failed' states.",
"type":"string"
}
}
}
},
"receiveEmail":{
"description":"The string representation of whether the user wants to recieve email or not",
"type":"string"
},
"middleName":{
"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":{
"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"
}
}
}
}
}
},
"daytimeTelephoneNumber":{
"description":"The day time phone number of the profile",
"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 : 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 : 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
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"
},
"lkpValExcludingFreeShip":{
"description":"The total shipping cost excluding items with free shipping.",
"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"
},
"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":"array",
"items":{
"type":"object",
"properties":{
}
}
},
"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":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"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"
}
}
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"preOrderQuantity":{
"description":"The pre ordered quantity included.",
"type":"integer"
},
"childItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
}
}
},
"configuratorId":{
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"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"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"stateDetailsAsUser":{
"type":"string"
},
"unitPrice":{
"type":"number"
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"assetable":{
"description":"Flag to denote that the item is a potential service.",
"type":"string"
},
"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"
}
}
}
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"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":{
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"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"
},
"asset":{
"description":"The flag that defines it the item is an asset or not.",
"type":"boolean"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"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
{
"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"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"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"
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"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":{
"type":"object",
"properties":{
}
}
},
"configuratorId":{
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"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"
},
"actionCode":{
"description":"The action code that has been set on the item by the third party system.",
"type":"string"
},
"id":{
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"unitPrice":{
"type":"number"
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"assetable":{
"type":"string"
},
"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"
}
}
}
},
"orderDiscountInfos":{
"description":"Array of order promotions affecting this item.",
"type":"array",
"items":{
"type":"object",
"properties":{
"couponCodes":{
"description":"One or more coupon codes used to grant the order promotion providing the discount.",
"type":"array",
"items":{
"type":"string"
}
},
"amount":{
"description":"The amount of discount this item received from the promotion.",
"type":"number"
},
"promotionId":{
"description":"The promotion id that resulted in the discount.",
"type":"string"
}
}
}
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeFrequency":{
"type":"string"
},
"externalPriceQuantity":{
"type":"integer"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"catRefId":{
"type":"string"
},
"externalRecurringChargeDuration":{
"type":"string"
},
"discountInfo":{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"coupon":{
"description":"The coupon ID.",
"type":"string"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string"
}
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"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"
},
"asset":{
"description":"The flag that defines it the item is an asset or not.",
"type":"boolean"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"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
{
"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 : 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"
},
"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"
},
"lkpValExcludingFreeShip":{
"description":"The total shipping cost excluding items with free shipping.",
"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"
},
"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":"array",
"items":{
"type":"object",
"properties":{
}
}
},
"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":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"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"
}
}
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"preOrderQuantity":{
"description":"The pre ordered quantity included.",
"type":"integer"
},
"childItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
}
}
},
"configuratorId":{
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"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"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"stateDetailsAsUser":{
"type":"string"
},
"unitPrice":{
"type":"number"
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"assetable":{
"description":"Flag to denote that the item is a potential service.",
"type":"string"
},
"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"
}
}
}
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"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":{
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"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"
},
"asset":{
"description":"The flag that defines it the item is an asset or not.",
"type":"boolean"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"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":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"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"
}
}
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"preOrderQuantity":{
"description":"The pre ordered quantity included.",
"type":"integer"
},
"childItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
}
}
},
"configuratorId":{
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"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"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"stateDetailsAsUser":{
"type":"string"
},
"unitPrice":{
"type":"number"
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"assetable":{
"description":"Flag to denote that the item is a potential service.",
"type":"string"
},
"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"
}
}
}
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"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":{
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"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"
},
"asset":{
"description":"The flag that defines it the item is an asset or not.",
"type":"boolean"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"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"
},
"lkpValExcludingFreeShip":{
"description":"The total shipping cost excluding items with free shipping.",
"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 : 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 : 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":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"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"
}
}
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"preOrderQuantity":{
"description":"The pre ordered quantity included.",
"type":"integer"
},
"childItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
}
}
},
"configuratorId":{
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"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"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"stateDetailsAsUser":{
"type":"string"
},
"unitPrice":{
"type":"number"
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"assetable":{
"description":"Flag to denote that the item is a potential service.",
"type":"string"
},
"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"
}
}
}
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"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":{
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"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"
},
"asset":{
"description":"The flag that defines it the item is an asset or not.",
"type":"boolean"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"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 : 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":{
}
}
}
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 : 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":{
"primaryThumbImageURL":{
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"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"
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"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":{
"type":"object",
"properties":{
}
}
},
"configuratorId":{
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"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"
},
"actionCode":{
"description":"The action code that has been set on the item by the third party system.",
"type":"string"
},
"id":{
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"unitPrice":{
"type":"number"
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"assetable":{
"type":"string"
},
"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"
}
}
}
},
"orderDiscountInfos":{
"description":"Array of order promotions affecting this item.",
"type":"array",
"items":{
"type":"object",
"properties":{
"couponCodes":{
"description":"One or more coupon codes used to grant the order promotion providing the discount.",
"type":"array",
"items":{
"type":"string"
}
},
"amount":{
"description":"The amount of discount this item received from the promotion.",
"type":"number"
},
"promotionId":{
"description":"The promotion id that resulted in the discount.",
"type":"string"
}
}
}
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeFrequency":{
"type":"string"
},
"externalPriceQuantity":{
"type":"integer"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"catRefId":{
"type":"string"
},
"externalRecurringChargeDuration":{
"type":"string"
},
"discountInfo":{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"coupon":{
"description":"The coupon ID.",
"type":"string"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string"
}
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"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"
},
"asset":{
"description":"The flag that defines it the item is an asset or not.",
"type":"boolean"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"listPrice":{
"type":"number"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"primaryThumbImageURL":{
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"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"
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"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":{
"type":"object",
"properties":{
}
}
},
"configuratorId":{
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"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"
},
"actionCode":{
"description":"The action code that has been set on the item by the third party system.",
"type":"string"
},
"id":{
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"unitPrice":{
"type":"number"
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"assetable":{
"type":"string"
},
"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"
}
}
}
},
"orderDiscountInfos":{
"description":"Array of order promotions affecting this item.",
"type":"array",
"items":{
"type":"object",
"properties":{
"couponCodes":{
"description":"One or more coupon codes used to grant the order promotion providing the discount.",
"type":"array",
"items":{
"type":"string"
}
},
"amount":{
"description":"The amount of discount this item received from the promotion.",
"type":"number"
},
"promotionId":{
"description":"The promotion id that resulted in the discount.",
"type":"string"
}
}
}
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeFrequency":{
"type":"string"
},
"externalPriceQuantity":{
"type":"integer"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"catRefId":{
"type":"string"
},
"externalRecurringChargeDuration":{
"type":"string"
},
"discountInfo":{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"coupon":{
"description":"The coupon ID.",
"type":"string"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string"
}
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"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"
},
"asset":{
"description":"The flag that defines it the item is an asset or not.",
"type":"boolean"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"listPrice":{
"type":"number"
}
}
}
Nested Schema : childItems
Type: array
Represents the child commerce items. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook
Show Source
{
"description":"Represents the child commerce items. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook",
"type":"array",
"items":{
"type":"object",
"properties":{
}
}
}
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 : 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":{
"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 : orderDiscountInfos
Type: array
Array of order promotions affecting this item.
Show Source
{
"description":"Array of order promotions affecting this item.",
"type":"array",
"items":{
"type":"object",
"properties":{
"couponCodes":{
"description":"One or more coupon codes used to grant the order promotion providing the discount.",
"type":"array",
"items":{
"type":"string"
}
},
"amount":{
"description":"The amount of discount this item received from the promotion.",
"type":"number"
},
"promotionId":{
"description":"The promotion id that resulted in the discount.",
"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":{
}
}
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":{
"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":{
"couponCodes":{
"description":"One or more coupon codes used to grant the order promotion providing the discount.",
"type":"array",
"items":{
"type":"string"
}
},
"amount":{
"description":"The amount of discount this item received from the promotion.",
"type":"number"
},
"promotionId":{
"description":"The promotion id that resulted in the discount.",
"type":"string"
}
}
}
Nested Schema : couponCodes
Type: array
One or more coupon codes used to grant the order promotion providing the discount.
Show Source
{
"description":"One or more coupon codes used to grant the order promotion providing the discount.",
"type":"array",
"items":{
"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 : allApprovers
Type: array
list of all the approvers
Show Source
{
"description":"list of all the approvers",
"type":"array",
"items":{
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the apporver",
"type":"string"
},
"firstName":{
"description":"the first name of the approver",
"type":"string"
},
"middleName":{
"description":"the middle name of the approver",
"type":"string"
}
}
}
}
Nested Schema : ancestorOrganizations
Type: array
List of ancestors for the Organization
Show Source
{
"description":"List of ancestors for the Organization",
"type":"array",
"items":{
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository Id of the organization.",
"type":"string"
},
"name":{
"description":"Name of the organization.",
"type":"string"
},
"active":{
"description":"Active flag of the organization.",
"type":"boolean"
},
"id":{
"description":"Id of the organization.",
"type":"string"
}
}
}
}
Nested Schema : approvers
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object"
}
}
Nested Schema : billingAddress
Type: object
The default billing address for the Organization. This a read only attribute. This will come if property 'isDefaultBillingAddress' is set to 'true' in secondaryAddresses attribute.
Show Source
{
"description":"The default billing address for the Organization. This a read only attribute. This will come if property 'isDefaultBillingAddress' is set to 'true' in secondaryAddresses attribute.",
"type":"object",
"properties":{
"country":{
"description":"the country of the address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the address",
"type":"string"
},
"address2":{
"description":"the address2 of the address",
"type":"string"
},
"city":{
"description":"the city of the address",
"type":"string"
},
"address1":{
"description":"the address1 of the address",
"type":"string"
},
"companyName":{
"description":"the company name of the address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the address",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of the address",
"type":"string"
},
"state":{
"description":"the state of the address",
"type":"string"
}
}
}
Nested Schema : childOrganizations
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object"
}
}
Nested Schema : contacts
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object"
}
}
Nested Schema : contract
Type: object
Contract
Show Source
{
"description":"Contract",
"type":"object",
"properties":{
"endDate":{
"description":"Contract end date time stamp",
"type":"string"
},
"terms":{
"description":"Terms and Conditions",
"type":"object",
"properties":{
"terms":{
"description":"Terms and Conditions",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of terms and conditions",
"type":"string"
}
}
},
"catalog":{
"description":"Catalog associated with contract",
"type":"object",
"properties":{
"displayName":{
"description":"Name of the catalog",
"type":"string"
},
"id":{
"description":"id of the catalog",
"type":"string"
},
"status":{
"type":"string"
}
}
},
"displayName":{
"description":"Name of the contract",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of the contract",
"type":"string"
},
"description":{
"description":"Description for contract",
"type":"string"
},
"priceListGroup":{
"description":"Price ListGroup associated with contract",
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository Id of the price list group",
"type":"string"
}
}
},
"creationDate":{
"description":"Contract creation date time stamp",
"type":"string"
},
"startDate":{
"description":"Contract start date time stamp",
"type":"string"
},
"externalContractReference":{
"description":"External contract reference",
"type":"string"
}
}
}
Nested Schema : derivedBillingAddress
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"
},
"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"
},
"repositoryId":{
"description":"the id of the billing address",
"type":"string"
},
"county":{
"description":"the county of the billing address",
"type":"string"
},
"state":{
"description":"the state of the billing address",
"type":"string"
}
}
}
Nested Schema : derivedContract
Type: object
Contract
Show Source
{
"description":"Contract",
"type":"object",
"properties":{
"endDate":{
"description":"Contract end date time stamp",
"type":"string"
},
"terms":{
"description":"Terms and Conditions",
"type":"object",
"properties":{
"terms":{
"description":"Terms and Conditions",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of terms and conditions",
"type":"string"
}
}
},
"catalog":{
"description":"Catalog associated with contract",
"type":"object",
"properties":{
"displayName":{
"description":"Name of the catalog",
"type":"string"
},
"id":{
"description":"id of the catalog",
"type":"string"
},
"status":{
"type":"string"
}
}
},
"displayName":{
"description":"Name of the contract",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of the contract",
"type":"string"
},
"description":{
"description":"Description for contract",
"type":"string"
},
"priceListGroup":{
"description":"Price ListGroup associated with contract",
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository Id of the price list group",
"type":"string"
}
}
},
"creationDate":{
"description":"Contract creation date time stamp",
"type":"string"
},
"startDate":{
"description":"Contract start date time stamp",
"type":"string"
},
"externalContractReference":{
"description":"External contract reference",
"type":"string"
}
}
}
Nested Schema : derivedShippingAddress
Type: object
The derived default shipping address for the Organization. This a read only attribute. This will come if property 'isDefaultShippingAddress' is set to 'true' in secondaryAddresses attribute or if parent has default shipping address.
Show Source
{
"description":"The derived default shipping address for the Organization. This a read only attribute. This will come if property 'isDefaultShippingAddress' is set to 'true' in secondaryAddresses attribute or if parent has default shipping address.",
"type":"object",
"properties":{
"country":{
"description":"the country of the address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the company address",
"type":"string"
},
"address2":{
"description":"the address2 of the address",
"type":"string"
},
"city":{
"description":"the city of the address",
"type":"string"
},
"address1":{
"description":"the address1 of the address",
"type":"string"
},
"companyName":{
"description":"the company name shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the address",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of the address",
"type":"string"
},
"state":{
"description":"the state of the address",
"type":"string"
}
}
}
Nested Schema : siteOrganizationProperties
Type: object
Site Organization Properties
Show Source
{
"description":"Site Organization Properties",
"type":"object",
"properties":{
"site":{
"description":"Site information",
"type":"object",
"properties":{
"approvalRequired":{
"description":"Approval flag is required for the organization, by default it is set to false",
"type":"boolean"
},
"contract":{
"description":"Contract",
"type":"object",
"properties":{
"endDate":{
"description":"Contract end date time stamp",
"type":"string"
},
"terms":{
"description":"Terms and Conditions",
"type":"object",
"properties":{
"terms":{
"description":"Terms and Conditions",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of terms and conditions",
"type":"string"
}
}
},
"catalog":{
"description":"Catalog associated with contract",
"type":"object",
"properties":{
"displayName":{
"description":"Name of the catalog",
"type":"string"
},
"id":{
"description":"id of the catalog",
"type":"string"
},
"status":{
"type":"string"
}
}
},
"displayName":{
"description":"Name of the contract",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of the contract",
"type":"string"
},
"description":{
"description":"Description for contract",
"type":"string"
},
"priceListGroup":{
"description":"Price ListGroup associated with contract",
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository Id of the price list group",
"type":"string"
}
}
},
"creationDate":{
"description":"Contract creation date time stamp",
"type":"string"
},
"startDate":{
"description":"Contract start date time stamp",
"type":"string"
},
"externalContractReference":{
"description":"External contract reference",
"type":"string"
}
}
},
"delegateApprovalManagement":{
"description":"This flag indicates if the delegated admin has the provision of approval management, if set merchant admin cannot do any approval management.",
"type":"boolean"
},
"useExternalApprovalWebhook":{
"description":"Flag to enable/disable Order Approval check from External Webhook",
"type":"boolean"
},
"orderPriceLimit":{
"description":"Its order limit value for the organization, if order limit is more than this value then approval is needed for the order",
"type":"number"
}
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the apporver",
"type":"string"
},
"firstName":{
"description":"the first name of the approver",
"type":"string"
},
"middleName":{
"description":"the middle name of the approver",
"type":"string"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository Id of the organization.",
"type":"string"
},
"name":{
"description":"Name of the organization.",
"type":"string"
},
"active":{
"description":"Active flag of the organization.",
"type":"boolean"
},
"id":{
"description":"Id of the organization.",
"type":"string"
}
}
}
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : catalog
Type: object
Catalog associated with contract
Show Source
{
"description":"Catalog associated with contract",
"type":"object",
"properties":{
"displayName":{
"description":"Name of the catalog",
"type":"string"
},
"id":{
"description":"id of the catalog",
"type":"string"
},
"status":{
"type":"string"
}
}
}
Nested Schema : priceListGroup
Type: object
Price ListGroup associated with contract
Show Source
{
"description":"Price ListGroup associated with contract",
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository Id of the price list group",
"type":"string"
}
}
}
Nested Schema : terms
Type: object
Terms and Conditions
Show Source
{
"description":"Terms and Conditions",
"type":"object",
"properties":{
"terms":{
"description":"Terms and Conditions",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of terms and conditions",
"type":"string"
}
}
}
Nested Schema : catalog
Type: object
Catalog associated with contract
Show Source
{
"description":"Catalog associated with contract",
"type":"object",
"properties":{
"displayName":{
"description":"Name of the catalog",
"type":"string"
},
"id":{
"description":"id of the catalog",
"type":"string"
},
"status":{
"type":"string"
}
}
}
Nested Schema : priceListGroup
Type: object
Price ListGroup associated with contract
Show Source
{
"description":"Price ListGroup associated with contract",
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository Id of the price list group",
"type":"string"
}
}
}
Nested Schema : terms
Type: object
Terms and Conditions
Show Source
{
"description":"Terms and Conditions",
"type":"object",
"properties":{
"terms":{
"description":"Terms and Conditions",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of terms and conditions",
"type":"string"
}
}
}
Nested Schema : site
Type: object
Site information
Show Source
{
"description":"Site information",
"type":"object",
"properties":{
"approvalRequired":{
"description":"Approval flag is required for the organization, by default it is set to false",
"type":"boolean"
},
"contract":{
"description":"Contract",
"type":"object",
"properties":{
"endDate":{
"description":"Contract end date time stamp",
"type":"string"
},
"terms":{
"description":"Terms and Conditions",
"type":"object",
"properties":{
"terms":{
"description":"Terms and Conditions",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of terms and conditions",
"type":"string"
}
}
},
"catalog":{
"description":"Catalog associated with contract",
"type":"object",
"properties":{
"displayName":{
"description":"Name of the catalog",
"type":"string"
},
"id":{
"description":"id of the catalog",
"type":"string"
},
"status":{
"type":"string"
}
}
},
"displayName":{
"description":"Name of the contract",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of the contract",
"type":"string"
},
"description":{
"description":"Description for contract",
"type":"string"
},
"priceListGroup":{
"description":"Price ListGroup associated with contract",
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository Id of the price list group",
"type":"string"
}
}
},
"creationDate":{
"description":"Contract creation date time stamp",
"type":"string"
},
"startDate":{
"description":"Contract start date time stamp",
"type":"string"
},
"externalContractReference":{
"description":"External contract reference",
"type":"string"
}
}
},
"delegateApprovalManagement":{
"description":"This flag indicates if the delegated admin has the provision of approval management, if set merchant admin cannot do any approval management.",
"type":"boolean"
},
"useExternalApprovalWebhook":{
"description":"Flag to enable/disable Order Approval check from External Webhook",
"type":"boolean"
},
"orderPriceLimit":{
"description":"Its order limit value for the organization, if order limit is more than this value then approval is needed for the order",
"type":"number"
}
}
}
Nested Schema : contract
Type: object
Contract
Show Source
{
"description":"Contract",
"type":"object",
"properties":{
"endDate":{
"description":"Contract end date time stamp",
"type":"string"
},
"terms":{
"description":"Terms and Conditions",
"type":"object",
"properties":{
"terms":{
"description":"Terms and Conditions",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of terms and conditions",
"type":"string"
}
}
},
"catalog":{
"description":"Catalog associated with contract",
"type":"object",
"properties":{
"displayName":{
"description":"Name of the catalog",
"type":"string"
},
"id":{
"description":"id of the catalog",
"type":"string"
},
"status":{
"type":"string"
}
}
},
"displayName":{
"description":"Name of the contract",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of the contract",
"type":"string"
},
"description":{
"description":"Description for contract",
"type":"string"
},
"priceListGroup":{
"description":"Price ListGroup associated with contract",
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository Id of the price list group",
"type":"string"
}
}
},
"creationDate":{
"description":"Contract creation date time stamp",
"type":"string"
},
"startDate":{
"description":"Contract start date time stamp",
"type":"string"
},
"externalContractReference":{
"description":"External contract reference",
"type":"string"
}
}
}
Nested Schema : catalog
Type: object
Catalog associated with contract
Show Source
{
"description":"Catalog associated with contract",
"type":"object",
"properties":{
"displayName":{
"description":"Name of the catalog",
"type":"string"
},
"id":{
"description":"id of the catalog",
"type":"string"
},
"status":{
"type":"string"
}
}
}
Nested Schema : priceListGroup
Type: object
Price ListGroup associated with contract
Show Source
{
"description":"Price ListGroup associated with contract",
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository Id of the price list group",
"type":"string"
}
}
}
Nested Schema : terms
Type: object
Terms and Conditions
Show Source
{
"description":"Terms and Conditions",
"type":"object",
"properties":{
"terms":{
"description":"Terms and Conditions",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of terms and conditions",
"type":"string"
}
}
}
Nested Schema : loyaltyPrograms
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"programName":{
"description":"Loyalty program name",
"type":"string"
},
"profileId":{
"description":"User profile id",
"type":"string"
},
"membershipId":{
"description":"Membership id of user.",
"type":"string"
},
"programId":{
"description":"Program id of loyalty program ",
"type":"string"
},
"status":{
"description":"status of Enrollment. It must be in any of 'RequestForEnrollment', 'Enrolled', 'RequestForUnenrollment', 'Unenrolled', 'Failed' states.",
"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 : items
Type: object
Show Source
{
"type":"object",
"properties":{
"programName":{
"description":"Loyalty program name",
"type":"string"
},
"profileId":{
"description":"User profile id",
"type":"string"
},
"membershipId":{
"description":"Membership id of user.",
"type":"string"
},
"programId":{
"description":"Program id of loyalty program ",
"type":"string"
},
"status":{
"description":"status of Enrollment. It must be in any of 'RequestForEnrollment', 'Enrolled', 'RequestForUnenrollment', 'Unenrolled', 'Failed' states.",
"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"
}
}
}