The external service is called whenever CC needs to determine available shipping methods and costs, such as during pricing operations or calls to the listShippingMethods endpoint. The request contains information about the shopper, items to be shipped, and shipping address. The response includes the available shipping methods and their costs.
Root Schema : calculateShipping_request
Type: object
The external service is called whenever CC needs to determine available shipping methods and costs, such as during pricing operations or calls to the listShippingMethods endpoint. The request contains information about the shopper, items to be shipped, and shipping address. The response includes the available shipping methods and their costs.
Show Source
{
"description":"The external service is called whenever CC needs to determine available shipping methods and costs, such as during pricing operations or calls to the listShippingMethods endpoint. The request contains information about the shopper, items to be shipped, and shipping address. The response includes the available shipping methods and their costs.",
"properties":{
"shippingGroupIdsToPrice":{
"description":"List of shipping group ids provided by the client for retrieval of shipping methods.",
"type":"array",
"items":{
"type":"string"
}
},
"request":{
"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"
},
"secondaryCurrencyCode":{
"description":"Secondary currencyCode",
"type":"string",
"example":"USD"
},
"address":{
"description":"Address",
"type":"object",
"properties":{
"lastName":{
"description":"lastName of person",
"type":"string",
"example":"Muir"
},
"firstName":{
"description":"firstName of person",
"type":"string",
"example":"John"
},
"country":{
"description":"the country of the Address",
"type":"string",
"example":"US"
},
"address2":{
"description":"address2 of the person",
"type":"string",
"example":"Apt 123"
},
"address1":{
"description":"address1 of the person",
"type":"string",
"example":"1 main st"
},
"postalCode":{
"description":"postalCode of the person",
"type":"string",
"example":1122
},
"state":{
"description":"state of the person",
"type":"string",
"example":"New York"
}
}
},
"appliedCoupons":{
"description":"Coupons applied to order.",
"type":"array",
"items":{
"type":"string",
"example":"CPN123"
}
},
"locale":{
"description":"locale",
"type":"object",
"properties":{
"country":{
"description":"country",
"type":"string",
"example":"US"
},
"displayName":{
"description":"the display name",
"type":"string",
"example":"English"
},
"language":{
"description":"language",
"type":"string",
"example":"en"
}
}
},
"orderTotal":{
"description":"The total price of the order.",
"type":"number",
"example":24.99
},
"exchangeRate":{
"description":"exchangeRate",
"type":"number",
"example":0
},
"profileId":{
"description":"Id of the profile",
"type":"string",
"example":117012
},
"orderDiscount":{
"description":"Discount given on an order.",
"type":"number",
"example":0
},
"siteId":{
"description":"site associated with this request",
"type":"string",
"example":"siteUS"
},
"rawOrderTotal":{
"description":"the raw order total",
"type":"number",
"example":24.99
},
"currencyCode":{
"description":"Indicates the currency of the price. For example, USD indicates that the price is in US dollars.",
"type":"string",
"example":"USD"
},
"items":{
"description":"items",
"type":"array",
"items":{
"type":"object",
"properties":{
"product":{
"description":"product",
"type":"object",
"properties":{
"width":{
"description":"width of the product",
"type":"number",
"example":1
},
"length":{
"description":"length of the product",
"type":"number",
"example":1
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number",
"example":0
},
"weight":{
"description":"weight of the product",
"type":"number",
"example":1
},
"id":{
"description":"id of the product",
"type":"string",
"example":"Product_XYZ"
},
"taxCode":{
"description":"Tax Code of the product.",
"type":"string",
"example":"DV10010"
},
"height":{
"description":"height of the product",
"type":"number",
"example":1
}
}
},
"amount":{
"description":"amount",
"type":"number",
"example":24.99
},
"quantity":{
"description":"quantity",
"type":"integer",
"example":1
},
"rawTotalPrice":{
"description":"The raw total price.",
"type":"number",
"example":24.99
},
"discount":{
"description":"discount of the order",
"type":"number",
"example":0
},
"catalogRefId":{
"description":"The catalog ref id",
"type":"string",
"example":"SKU_Ref"
}
}
}
}
}
},
"profile":{
"type":"object",
"properties":{
"lastName":{
"type":"string",
"example":"Muir"
},
"taxExempt":{
"default":false,
"description":"Indicates if the user profile is taxExempt",
"type":"boolean",
"example":false
},
"taxExemptionCode":{
"description":"Describes the tax exemption code",
"type":"string",
"example":"TX123"
},
"locale":{
"description":"Locale of the storefront",
"type":"string",
"example":"en"
},
"parentOrganization":{
"type":"object",
"properties":{
"contract":{
"description":"Describes the contract details of the organization and user",
"type":"object",
"properties":{
"displayName":{
"type":"string",
"example":"Contract_ABC"
},
"description":{
"type":"string",
"example":"Contract with companyA"
},
"id":{
"type":"string",
"example":"ct-1001"
}
}
},
"name":{
"description":"name of the parent organization user belongs to",
"type":"string",
"example":"CompanyA"
},
"description":{
"type":"string",
"example":"CompanyA description"
},
"id":{
"description":"String representation of the parent organization id",
"type":"string",
"example":"or-1001"
}
}
},
"sitePropertiesList":{
"description":"The list of site related properties for the profile",
"type":"array",
"items":{
"type":"object",
"properties":{
"site":{
"description":"The site data",
"type":"object",
"properties":{
"id":{
"description":"The id of the site",
"type":"string",
"example":"siteUS"
}
}
},
"properties":{
"description":"The site related properties for the profile",
"type":"object",
"properties":{
"GDPRProfileP13nConsentDate":{
"description":"The date on which GDPR personalization consent was granted by the user.",
"type":"string",
"example":"2013-04-12 14:48:45 -0400"
},
"GDPRProfileP13nConsentGranted":{
"description":"If user has given consent for his/her profile information to be used for personalization purposes.",
"type":"boolean",
"example":false
},
"receiveEmail":{
"description":"Indicates whether the user should receive marketing emails on the current site. Can be yes or no.",
"type":"string",
"example":"no"
},
"receiveEmailDate":{
"description":"The date on which email marketing consent was granted by the user.",
"type":"string",
"example":"2013-04-12 14:48:45 -0400"
}
}
}
}
}
},
"firstName":{
"type":"string",
"example":"John"
},
"profileType":{
"description":"Indicates if the user is B2B user. For a b2b user, this is b2b_user",
"type":"string",
"example":"b2b_user"
},
"loyaltyPrograms":{
"type":"array",
"items":{
"type":"object",
"properties":{
"profileId":{
"description":"User profile id on storefront",
"type":"string",
"example":117012
},
"programName":{
"type":"string",
"example":"Loyalty Program1"
},
"membershipId":{
"description":"MembershipId of the user enrolled in the program",
"type":"string",
"example":"LPM1234"
},
"programId":{
"description":"Id of the loyaltyProgram",
"type":"string",
"example":"LP1234"
},
"status":{
"description":"Provides the current status of user in loyaltyProgram",
"enum":[
"RequestForEnrollment",
"Enrolled",
"RequestForUnenrollment",
"Unenrolled",
"Failed"
],
"example":"Enrolled"
}
}
}
},
"middleName":{
"type":"string",
"example":"Muir"
},
"currentOrganization":{
"type":"object",
"properties":{
"contract":{
"description":"Describes the contract details of the organization and user",
"type":"object",
"properties":{
"displayName":{
"type":"string",
"example":"Contract_ABC"
},
"description":{
"type":"string",
"example":"Contract with companyA"
},
"id":{
"type":"string",
"example":"ct-1001"
}
}
},
"name":{
"description":"name of the current organization user belongs to",
"type":"string",
"example":"CompanyA"
},
"description":{
"type":"string",
"example":"CompanyA description"
},
"id":{
"description":"String representation of the current organization id",
"type":"string",
"example":"or-1001"
}
}
},
"id":{
"description":"profileId of the user",
"type":"string",
"example":117012
},
"email":{
"description":"Email address of the user",
"type":"string",
"example":"john.muir@oracle.com"
},
"secondaryOrganizations":{
"type":"array",
"items":{
"type":"object",
"properties":{
"contract":{
"description":"Describes the contract details of the organization and user",
"type":"object",
"properties":{
"displayName":{
"type":"string",
"example":"Contract_ABC"
},
"description":{
"type":"string",
"example":"Contract with companyA"
},
"id":{
"type":"string",
"example":"ct-1001"
}
}
},
"name":{
"description":"name of the secondary organization user belongs to",
"type":"string",
"example":"CompanyA"
},
"description":{
"type":"string",
"example":"CompanyA description"
},
"id":{
"description":"String representation of the secondary organization id",
"type":"string",
"example":"or-1001"
}
}
}
},
"daytimeTelephoneNumber":{
"description":"user contact phone number",
"type":"number",
"example":"123-123-1234"
}
}
},
"productInformation":{
"type":"object",
"properties":{
"length":{
"description":"length of the product",
"type":"number",
"example":1
},
"width":{
"description":"width of the product",
"type":"number",
"example":1
},
"weight":{
"description":"weight of the product",
"type":"number",
"example":1
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number",
"example":0
},
"id":{
"description":"id of the product",
"type":"string",
"example":"Product_xyz"
},
"taxCode":{
"description":"Tax Code of the product.",
"type":"string",
"example":"DV10010"
},
"height":{
"description":"height of the product",
"type":"number",
"example":1
}
}
},
"availableExternallyPricedShippingMethods":{
"description":"Available externally priced shipping methods.",
"type":"array",
"items":{
"type":"object",
"properties":{
"eligibleForProductWithSurcharges":{
"description":"Whether this shipping method is enabled for products with surcharges or not.",
"type":"boolean",
"example":false
},
"ranges":{
"description":"The price ranges for this shipping method.",
"type":"array",
"items":{
"type":"object",
"properties":{
"amount":{
"description":"The monetary value for the range.",
"type":"number",
"example":12
},
"high":{
"description":"The upper boundary of the range",
"type":"number",
"example":15
},
"low":{
"description":"The lower boundary of the range.",
"type":"number",
"example":10
}
}
}
},
"associatedPriceListGroups":{
"description":"The associated Price list groups for this Shipping Method.",
"type":"object",
"properties":{
"displayName":{
"description":"The display name of the price list group.",
"type":"string",
"example":"USD"
},
"id":{
"description":"The id of the price list group.",
"type":"string",
"example":"PLG-ID"
}
}
},
"displayName":{
"description":"The display name of the shipping method.",
"type":"string"
},
"description":{
"description":"The description of the shipping method.",
"type":"string"
},
"allSites":{
"description":"Indicates that the shipping method is available to all sites.",
"type":"boolean"
},
"sites":{
"description":"Sites that the shipping method is available to.",
"type":"array",
"items":{
"type":"object",
"properties":{
"name":{
"description":"The name of the site.",
"type":"string"
},
"id":{
"description":"The site id.",
"type":"string"
}
}
}
},
"excludedCategoriesShippingCharge":{
"description":"Excluded categories for shipping charges.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The category id excluded from shipping charge.",
"type":"string"
}
}
}
},
"isFallback":{
"description":"Indicates if the shipping method is a fallback shipping method in case of an external shipping method failure.",
"type":"boolean"
},
"taxCode":{
"description":"A valid tax code for calculating tax on shipping.",
"type":"string"
},
"shippingGroupType":{
"description":"The shipping group type of the shipping method.",
"type":"string"
}
}
}
},
"order":{
"type":"object",
"properties":{
"taxPriceInfo":{
"type":"object",
"properties":{
"cityTax":{
"type":"number",
"example":1.99
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number",
"example":0
},
"amount":{
"type":"number",
"example":7.99
},
"valueAddedTax":{
"type":"number",
"example":0
},
"countyTax":{
"type":"number",
"example":0
},
"isTaxIncluded":{
"type":"boolean",
"example":false
},
"miscTax":{
"type":"number",
"example":1.79
},
"districtTax":{
"type":"number",
"example":0
},
"stateTax":{
"type":"number",
"example":3.99
},
"countryTax":{
"type":"number",
"example":0
}
}
},
"shippingGroups":{
"type":"array",
"items":{
"type":"object",
"properties":{
"taxPriceInfo":{
"description":"The shipping address details.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"taxAmount in secondaryCurrency",
"type":"number",
"example":0
},
"cityTax":{
"description":"City Tax",
"type":"number",
"example":3.9
},
"amount":{
"description":"The total order amount.",
"type":"number",
"example":5.99
},
"valueAddedTax":{
"description":"Value Added Tax.",
"type":"number",
"example":0
},
"countyTax":{
"description":"County Tax.",
"type":"number",
"example":0
},
"isTaxIncluded":{
"description":"If Tax is included?",
"type":"boolean",
"example":false
},
"miscTax":{
"description":"Misc Tax.",
"type":"number",
"example":1.87
},
"districtTax":{
"description":"District Tax.",
"type":"number",
"example":0
},
"stateTax":{
"description":"State Tax.",
"type":"number",
"example":3.9
},
"countryTax":{
"description":"Country Tax.",
"type":"number",
"example":0
}
}
},
"lastName":{
"description":"The second name of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"Muir"
},
"itemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding items property is truncated. The value for this field will always be true if present",
"type":"boolean"
},
"shippingMethod":{
"description":"The shipping method details for the order.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"shippingTax":{
"type":"number"
},
"cost":{
"description":"The total cost of shipping.",
"type":"number"
},
"taxCode":{
"type":"string"
},
"value":{
"description":"The shipping method applied to the order.",
"type":"string"
},
"shippingMethodDescription":{
"type":"string"
}
}
},
"shippingGroupId":{
"description":"The shipping Group id",
"type":"string",
"example":"sg1234"
},
"store":{
"description":"The store is present in the request if the type is inStorePickupShippingGroup.",
"type":"object",
"properties":{
"country":{
"description":"The country of the store",
"type":"string",
"example":"USA"
},
"hours":{
"description":"The store's opening hours.",
"type":"string",
"example":"Mon - Sat 10AM - 7PM Sun 11AM - 6 PM"
},
"address3":{
"description":"Address line 3 of store.",
"type":"string",
"example":"Main Street"
},
"address2":{
"description":"Address line 2 of store.",
"type":"string",
"example":"4th Floor"
},
"city":{
"description":"The store's city.",
"type":"string",
"example":"Boston"
},
"address1":{
"description":"Address line 1 of store.",
"type":"string",
"example":"One Beacon Street"
},
"stateAddress":{
"description":"The store's state address.",
"type":"string",
"example":"MA"
},
"county":{
"description":"The store's county",
"type":"string",
"example":"MA"
},
"phoneNumber":{
"description":"The store's phone number.",
"type":"string",
"example":"(617) 386-1201"
},
"locationId":{
"description":"The store's location Id.",
"type":"string",
"example":"Boston138"
},
"name":{
"description":"The store's name.",
"type":"string",
"example":"Boston Store #138"
},
"faxNumber":{
"description":"Fax number.",
"type":"string",
"example":"(617) 386-1200"
},
"postCode":{
"description":"The store's post code.",
"type":"string",
"example":"2108"
},
"email":{
"description":"The store's email address.",
"type":"string",
"example":"store138@example.com"
}
}
},
"type":{
"description":"the shippingGroup type",
"type":"string",
"example":"inStorePickupShippingGroup"
},
"firstName":{
"description":"The first name of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"John"
},
"priceInfo":{
"description":"The price information.",
"type":"object",
"properties":{
"amount":{
"description":"The total order amount.",
"type":"number",
"example":24.99
},
"total":{
"description":"The order total.",
"type":"number",
"example":47.93
},
"lkpValExcludingFreeShip":{
"description":"The total shipping cost excluding items with free shipping.",
"type":"number",
"example":0
},
"shipping":{
"description":"The total shipping cost.",
"type":"number",
"example":14.95
},
"shippingSurchargeValue":{
"description":"Extra handling costs for shipping the products",
"type":"number",
"example":0
},
"tax":{
"description":"The total tax amount.",
"type":"number",
"example":7.99
},
"subTotal":{
"description":"Sub-total.",
"type":"number",
"example":24.99
},
"currencyCode":{
"description":"The currency code.",
"type":"string",
"example":"USD"
},
"totalWithoutTax":{
"description":"The total amount without tax.",
"type":"number",
"example":39.49
}
}
},
"phoneNumber":{
"description":"The phone number of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"1231231234"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"total":{
"description":"The total price of the recurring charge.",
"type":"number"
},
"frequencyAmountTotals":{
"description":"The total for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string"
}
}
}
},
"shipping":{
"description":"Cost of shipping the product.",
"type":"number"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"subTotal":{
"description":"The sub-total price of the recurring charge.",
"type":"number"
},
"frequencyTaxTotals":{
"description":"The tax for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string"
}
}
}
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"totalWithoutTax":{
"description":"Total of recurring amount without tax included.",
"type":"number"
}
}
},
"discountInfo":{
"description":"The discount information.",
"type":"object",
"properties":{
"unclaimedCouponMultiPromotions":{
"type":"object",
"properties":{
"promotionInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"long desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PRMName"
},
"promotionLevel":{
"type":"string",
"example":"order"
},
"totalAdjustment":{
"type":"integer",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"description of the promotion"
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
},
"orderCouponsMap":{
"description":"The coupons that were claimed.",
"type":"object",
"properties":{
"couponCode":{
"description":"Coupon Code.",
"type":"object",
"properties":{
"promotionLongDesc":{
"description":"The description of the promotion.",
"type":"string",
"example":"<p>desc Spend 10 Get 10% Off</p>"
},
"promotionName":{
"description":"The display name of the promotion.",
"type":"string",
"example":"10% Off"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean",
"example":false
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"number",
"example":-11.1
},
"promotionDesc":{
"description":"Description of the promotion. Retained for backward compatibility.",
"type":"string",
"example":"Spend 10 Get 10% Off"
},
"promotionId":{
"description":"The Id of the promotion.",
"type":"string",
"example":"promo123"
}
}
}
}
},
"orderDiscount":{
"description":"The order discount.",
"type":"number",
"example":0
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"number",
"example":5.6
},
"orderImplicitDiscountList":{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"Detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PROMO1"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean",
"example":true
},
"promotionLevel":{
"description":"promotion level - order or item",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string",
"example":5.6
},
"promotionDesc":{
"type":"string",
"example":"the order related promotion"
},
"secondaryCurrencyTotalAdjustment":{
"description":"The total adjustment for secondary currency",
"type":"string",
"example":0
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
},
"unclaimedCouponsMap":{
"type":"object",
"properties":{
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
},
"claimedCouponMultiPromotions":{
"type":"object",
"properties":{
"promotions":{
"type":"array",
"items":{
"type":"object",
"properties":{
"totalAdjustment":{
"type":"integer",
"example":0
},
"secondaryCurrencyTotalAdjustment":{
"type":"integer",
"example":0
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
}
}
},
"shippingAddress":{
"description":"The shipping address details.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name.",
"type":"string",
"example":"Muir"
},
"country":{
"description":"Country.",
"type":"string"
},
"address3":{
"description":"Address snippet.",
"type":"string"
},
"address2":{
"description":"Address snippet.",
"type":"string"
},
"city":{
"description":"City.",
"type":"string",
"example":"Cambridge"
},
"address1":{
"description":"Address snippet.",
"type":"string",
"example":"1 main st"
},
"prefix":{
"description":"Name prefix.",
"type":"string"
},
"companyName":{
"description":"Company name.",
"type":"string",
"example":"oracle"
},
"postalCode":{
"description":"Postal code.",
"type":"string",
"example":1122
},
"jobTitle":{
"description":"Job title.",
"type":"string",
"example":"manager"
},
"county":{
"description":"County.",
"type":"string"
},
"suffix":{
"description":"Name suffix.",
"type":"string"
},
"firstName":{
"description":"First name",
"type":"string",
"example":"John"
},
"phoneNumber":{
"description":"Phone number.",
"type":"string",
"example":1111111111
},
"faxNumber":{
"description":"Fax number.",
"type":"string"
},
"middleName":{
"description":"Middle name.",
"type":"string",
"example":"Morgan"
},
"state":{
"description":"State.",
"type":"string",
"example":"MA"
},
"email":{
"description":"Email address.",
"type":"string",
"example":"john.muir@oracle.com"
}
}
},
"items":{
"type":"array",
"items":{
"properties":{
"availablePickupDate":{
"description":"The items available store pickup date.",
"type":"string",
"example":"2018-05-19T13:00:00.000Z"
},
"inventoryLocationId":{
"description":"Defines the inventory location that services the referenced commerce item.",
"type":"string"
},
"rawTotalPrice":{
"description":"The raw total price.",
"type":"number",
"example":24.99
},
"returnedQuantity":{
"type":"integer",
"example":0
},
"dynamicProperties":{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string",
"example":11502
},
"label":{
"description":"The dynamic property label.",
"type":"string",
"example":"dyn_prop"
},
"value":{
"description":"The dynamic property value.",
"type":"string",
"example":12
}
}
}
},
"shippingSurchargeValue":{
"description":"Extra handling cost for shipping the product.",
"type":"number",
"example":0
},
"availabilityDate":{
"format":"date-time",
"description":"The availability date for preOrdered/backOrdered quantity.",
"type":"string",
"example":"2018-06-13T18:09:53.493Z"
},
"discountAmount":{
"description":"The monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal. (read-only)",
"type":"number",
"example":0
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a third party system.",
"type":"array",
"items":{
"properties":{
"values":{
"description":"The map values associated with an externalData item.",
"type":"object",
"properties":{
"value":{
"description":"Map value defined by external system.",
"type":"string"
},
"key":{
"description":"Map key defined by external system.",
"type":"string"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the third party system.",
"type":"string"
}
}
}
},
"preOrderQuantity":{
"description":"The pre ordered quantity included.",
"type":"integer",
"example":0
},
"childItems":{
"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"
},
"commerceItemId":{
"description":"Commerce Item ID for this commerce item.",
"type":"string",
"example":"ci123545"
},
"price":{
"type":"number",
"example":24.99
},
"childItemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding childItems property is truncated. The value for this field will be true always if present",
"type":"boolean"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean",
"example":false
},
"actionCode":{
"description":"The action code that has been set on the item by the third party system.",
"type":"string"
},
"commerceId":{
"description":"Commerce ID for this commerce item.",
"type":"string",
"example":"ci12343"
},
"stateDetailsAsUser":{
"type":"string",
"example":"details of shippingItem"
},
"unitPrice":{
"type":"number",
"example":24.99
},
"amount":{
"description":"The monetary amount.",
"type":"number",
"example":24.99
},
"quantity":{
"description":"The number of items covered by this price info",
"type":"integer",
"example":1
},
"productId":{
"description":"The ID of the product.",
"type":"string",
"example":"product_9e"
},
"salePrice":{
"description":"The sale price",
"type":"number",
"example":0
},
"detailedItemPriceInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean",
"example":false
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number",
"example":0
},
"amount":{
"type":"number",
"example":24.99
},
"quantity":{
"type":"integer",
"example":1
},
"tax":{
"type":"number",
"example":0
},
"orderDiscountShare":{
"type":"integer",
"example":0
},
"detailedUnitPrice":{
"type":"number",
"example":24.99
},
"currencyCode":{
"type":"string",
"example":"USD"
}
}
}
},
"preferredPickupDate":{
"description":"The items preferred store pickup date.",
"type":"string",
"example":"2018-05-19T13:00:00.000Z"
},
"catRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string",
"example":"Sku_9F"
},
"discountInfo":{
"description":"Whether this item is discounted.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"Promotion BAC"
},
"external":{
"description":"if promotion is external",
"type":"boolean",
"example":false
},
"coupon":{
"type":"string",
"example":"CPN123"
},
"promotionLevel":{
"type":"string",
"example":"item"
},
"totalAdjustment":{
"type":"string",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"promotion desc"
},
"promotionId":{
"type":"string",
"example":"PRM123"
},
"giftWithPurchaseDiscountInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"gitWithPurchaseDetail":{
"type":"string",
"example":"details of gift"
},
"gitWithPurchaseIdentifier":{
"type":"integer",
"example":1223344
},
"giftWithPurchaseType":{
"description":"the gift type.For example product or sku",
"type":"string",
"example":"product"
},
"promotionDesc":{
"type":"string",
"example":"GWP Promotion description"
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
}
}
}
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"backOrderQuantity":{
"description":"The back ordered quantity included.",
"type":"integer",
"example":0
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number",
"example":24.99
},
"status":{
"type":"string",
"example":"INITIAL"
}
}
}
},
"email":{
"description":"The email address of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"john.muir@oracle.com"
}
}
}
},
"creationTime":{
"type":"integer",
"example":1.519827617E12
},
"lastModifiedDate":{
"type":"integer",
"example":"2018-02-28T14:20:17.000Z"
},
"orderId":{
"type":"string",
"example":"o123456"
},
"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",
"example":"siteUS"
},
"dynamicProperties":{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string",
"example":11502
},
"label":{
"description":"The dynamic property label.",
"type":"string",
"example":"dyn_prop"
},
"value":{
"description":"The dynamic property value.",
"type":"string",
"example":12
}
}
}
},
"payments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"paymentGroupId":{
"type":"string",
"example":"PYMT123"
},
"amount":{
"type":"integer",
"example":24
},
"balance":{
"type":"number",
"example":0
},
"gatewayName":{
"type":"string",
"example":"Chase"
},
"giftCardNumber":{
"type":"integer",
"example":0
},
"uiIntervention":{
"type":"string"
},
"paymentMethod":{
"type":"string",
"example":"card"
},
"isAmountRemaining":{
"type":"boolean",
"example":false
},
"paymentState":{
"type":"string",
"example":"AUTHORIZED"
},
"maskedCardNumber":{
"type":"string",
"example":1234
}
}
}
},
"shippingMethod":{
"type":"object",
"properties":{
"shippingTax":{
"type":"number",
"example":2.09
},
"cost":{
"type":"number",
"example":14.95
},
"value":{
"type":"string",
"example":"fedex-ground"
}
}
},
"priceListGroup":{
"type":"object",
"properties":{
"id":{
"type":"string",
"example":"defaultPriceListGroup"
}
}
},
"orderStatus":{
"type":"string",
"example":"Incomplete"
},
"creationDate":{
"type":"string",
"example":"2018-02-28T14:20:17.000Z"
},
"orderProfileId":{
"type":"string",
"example":110072
},
"priceInfo":{
"type":"object",
"properties":{
"amount":{
"type":"number",
"example":24.99
},
"total":{
"type":"number",
"example":24.99
},
"shipping":{
"type":"number",
"example":14.95
},
"shippingSurchargeValue":{
"type":"number",
"example":0
},
"tax":{
"type":"number",
"example":0
},
"subTotal":{
"type":"number",
"example":24.99
},
"currencyCode":{
"type":"string",
"example":"USD"
},
"totalWithoutTax":{
"type":"number",
"example":24.99
}
}
},
"discountInfo":{
"description":"The discount information.",
"properties":{
"unclaimedCouponMultiPromotions":{
"type":"object",
"properties":{
"promotionInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"long desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PRMName"
},
"promotionLevel":{
"type":"string",
"example":"order"
},
"totalAdjustment":{
"type":"integer",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"description of the promotion"
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
},
"orderCouponsMap":{
"description":"The coupons that were claimed.",
"type":"object",
"properties":{
"couponCode":{
"description":"Coupon Code.",
"type":"object",
"properties":{
"promotionLongDesc":{
"description":"The description of the promotion.",
"type":"string",
"example":"<p>desc Spend 10 Get 10% Off</p>"
},
"promotionName":{
"description":"The display name of the promotion.",
"type":"string",
"example":"10% Off"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean",
"example":false
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"number",
"example":-11.1
},
"promotionDesc":{
"description":"Description of the promotion. Retained for backward compatibility.",
"type":"string",
"example":"Spend 10 Get 10% Off"
},
"promotionId":{
"description":"The Id of the promotion.",
"type":"string",
"example":"promo123"
}
}
}
}
},
"orderDiscount":{
"description":"The order discount.",
"type":"number",
"example":0
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"number",
"example":5.6
},
"orderImplicitDiscountList":{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"Detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PROMO1"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean",
"example":true
},
"promotionLevel":{
"description":"the level of promotion. Value can be order or item or shipping",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string",
"example":5.6
},
"promotionDesc":{
"type":"string",
"example":"the order related promotion"
},
"secondaryCurrencyTotalAdjustment":{
"description":"The total adjustment for secondary currency",
"type":"string",
"example":0
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
},
"unclaimedCouponsMap":{
"type":"object",
"properties":{
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
},
"claimedCouponMultiPromotions":{
"type":"object",
"properties":{
"promotions":{
"type":"array",
"items":{
"type":"object",
"properties":{
"totalAdjustment":{
"type":"integer",
"example":0
},
"secondaryCurrencyTotalAdjustment":{
"type":"integer",
"example":0
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
}
}
},
"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",
"example":1
},
"items":{
"description":"The array of products in the shopping cart. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook",
"type":"array",
"items":{
"type":"object",
"properties":{
"primaryThumbImageURL":{
"type":"string",
"example":"/ccstore/v1/images/product.jpg"
},
"rawTotalPrice":{
"type":"number",
"example":24.99
},
"dynamicProperties":{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string",
"example":11052
},
"label":{
"description":"The dynamic property label.",
"type":"string",
"example":"dyn_size"
},
"value":{
"description":"The dynamic property value.",
"type":"string",
"example":12
}
}
}
},
"displayName":{
"type":"string",
"example":"ProductXYZ name"
},
"shippingSurchargeValue":{
"type":"integer",
"example":0
},
"description":{
"type":"string",
"example":"description of the product"
},
"discountAmount":{
"type":"number",
"example":0
},
"isItemValid":{
"type":"boolean",
"example":true
},
"externalData":{
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"type":"object",
"properties":{
"value":{
"type":"object"
},
"key":{
"type":"object"
}
}
},
"name":{
"type":"string",
"example":"externalDataName"
},
"actionCode":{
"type":"string"
}
}
}
},
"commerceItemId":{
"description":"id of the commerce item",
"type":"string",
"example":"ci20015"
},
"price":{
"type":"number",
"example":24.99
},
"variant":{
"description":"List of variants for the product.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value.",
"type":"string",
"example":"L"
},
"optionName":{
"description":"The variant option name.",
"type":"string",
"example":"size"
}
}
}
},
"childItemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding childItems property is truncated. The value for this field will be true always if present",
"type":"boolean"
},
"onSale":{
"type":"boolean",
"example":false
},
"id":{
"type":"string",
"example":"ci15000415"
},
"unitPrice":{
"type":"number",
"example":24.99
},
"amount":{
"description":"value of the commerce Item",
"type":"integer",
"example":24.99
},
"quantity":{
"type":"integer",
"example":1
},
"productId":{
"type":"string",
"example":"Product_9f"
},
"salePrice":{
"type":"number",
"example":0
},
"detailedItemPriceInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean",
"example":false
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number",
"example":0
},
"amount":{
"type":"number",
"example":24.99
},
"quantity":{
"type":"integer",
"example":1
},
"tax":{
"type":"number",
"example":0
},
"orderDiscountShare":{
"type":"integer",
"example":0
},
"detailedUnitPrice":{
"type":"number",
"example":24.99
},
"currencyCode":{
"type":"string",
"example":"USD"
}
}
}
},
"giftWithPurchaseCommerceItemMarkers":{
"type":"array",
"items":{
"type":"object",
"properties":{
"selectedQuantity":{
"type":"integer",
"example":0
},
"id":{
"type":"string",
"example":"gwp id"
}
}
}
},
"taxCode":{
"type":"string",
"example":"DV1001"
},
"catRefId":{
"type":"string",
"example":"sku_9f"
},
"skuProperties":{
"type":"array",
"items":{
"properties":{
"propertyType":{
"type":"string",
"example":"sku-base"
},
"name":{
"type":"string",
"example":"Not returnable"
},
"id":{
"type":"string",
"example":"nonreturnable"
},
"value":{
"type":"boolean",
"example":false
}
}
}
},
"discountInfo":{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"coupon":{
"description":"The coupon ID.",
"type":"string",
"example":"CPN123456"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string",
"example":"the example promotion"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string",
"example":"PRM1234"
}
}
}
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string",
"example":"siteUS"
},
"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"
},
"listPrice":{
"type":"number",
"example":24.99
}
}
}
}
}
},
"giftWithPurchaseInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"giftWithPurchaseQuantityAvailableForSelection":{
"type":"integer",
"example":2
},
"gitWithPurchaseDetail":{
"type":"string",
"example":"details of gift"
},
"gitWithPurchaseIdentifier":{
"type":"integer",
"example":1223344
},
"giftWithPurchaseType":{
"description":"the gift type.For example product or sku",
"type":"string",
"example":"product"
},
"promotionDesc":{
"type":"string",
"example":"GWP Promotion description"
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
},
"shippingAddress":{
"type":"object",
"properties":{
"lastName":{
"type":"string",
"example":"Muir"
},
"country":{
"type":"string",
"example":"United States"
},
"address3":{
"type":"string"
},
"address2":{
"type":"string"
},
"city":{
"type":"string",
"example":"Cambridge"
},
"address1":{
"type":"string",
"example":"1 main st"
},
"prefix":{
"type":"string",
"example":"Mr"
},
"companyName":{
"type":"string",
"example":"Oracle"
},
"postalCode":{
"type":"string",
"example":1122
},
"jobTitle":{
"type":"string",
"example":"Manager"
},
"county":{
"type":"string",
"example":"Suffolk"
},
"suffix":{
"type":"string"
},
"firstName":{
"type":"string",
"example":"John"
},
"phoneNumber":{
"type":"integer",
"example":1231231234
},
"faxNumber":{
"type":"integer",
"example":1231231234
},
"middleName":{
"type":"string",
"example":"Morgan"
},
"state":{
"type":"string",
"example":"MA"
},
"email":{
"type":"string",
"example":"john.muir@oracle.com"
}
}
},
"siteId":{
"type":"string",
"example":"siteUS"
}
}
}
}
}
Nested Schema : availableExternallyPricedShippingMethods
Type: array
Available externally priced shipping methods.
Show Source
{
"description":"Available externally priced shipping methods.",
"type":"array",
"items":{
"type":"object",
"properties":{
"eligibleForProductWithSurcharges":{
"description":"Whether this shipping method is enabled for products with surcharges or not.",
"type":"boolean",
"example":false
},
"ranges":{
"description":"The price ranges for this shipping method.",
"type":"array",
"items":{
"type":"object",
"properties":{
"amount":{
"description":"The monetary value for the range.",
"type":"number",
"example":12
},
"high":{
"description":"The upper boundary of the range",
"type":"number",
"example":15
},
"low":{
"description":"The lower boundary of the range.",
"type":"number",
"example":10
}
}
}
},
"associatedPriceListGroups":{
"description":"The associated Price list groups for this Shipping Method.",
"type":"object",
"properties":{
"displayName":{
"description":"The display name of the price list group.",
"type":"string",
"example":"USD"
},
"id":{
"description":"The id of the price list group.",
"type":"string",
"example":"PLG-ID"
}
}
},
"displayName":{
"description":"The display name of the shipping method.",
"type":"string"
},
"description":{
"description":"The description of the shipping method.",
"type":"string"
},
"allSites":{
"description":"Indicates that the shipping method is available to all sites.",
"type":"boolean"
},
"sites":{
"description":"Sites that the shipping method is available to.",
"type":"array",
"items":{
"type":"object",
"properties":{
"name":{
"description":"The name of the site.",
"type":"string"
},
"id":{
"description":"The site id.",
"type":"string"
}
}
}
},
"excludedCategoriesShippingCharge":{
"description":"Excluded categories for shipping charges.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The category id excluded from shipping charge.",
"type":"string"
}
}
}
},
"isFallback":{
"description":"Indicates if the shipping method is a fallback shipping method in case of an external shipping method failure.",
"type":"boolean"
},
"taxCode":{
"description":"A valid tax code for calculating tax on shipping.",
"type":"string"
},
"shippingGroupType":{
"description":"The shipping group type of the shipping method.",
"type":"string"
}
}
}
}
Nested Schema : order
Type: object
Show Source
{
"type":"object",
"properties":{
"taxPriceInfo":{
"type":"object",
"properties":{
"cityTax":{
"type":"number",
"example":1.99
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number",
"example":0
},
"amount":{
"type":"number",
"example":7.99
},
"valueAddedTax":{
"type":"number",
"example":0
},
"countyTax":{
"type":"number",
"example":0
},
"isTaxIncluded":{
"type":"boolean",
"example":false
},
"miscTax":{
"type":"number",
"example":1.79
},
"districtTax":{
"type":"number",
"example":0
},
"stateTax":{
"type":"number",
"example":3.99
},
"countryTax":{
"type":"number",
"example":0
}
}
},
"shippingGroups":{
"type":"array",
"items":{
"type":"object",
"properties":{
"taxPriceInfo":{
"description":"The shipping address details.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"taxAmount in secondaryCurrency",
"type":"number",
"example":0
},
"cityTax":{
"description":"City Tax",
"type":"number",
"example":3.9
},
"amount":{
"description":"The total order amount.",
"type":"number",
"example":5.99
},
"valueAddedTax":{
"description":"Value Added Tax.",
"type":"number",
"example":0
},
"countyTax":{
"description":"County Tax.",
"type":"number",
"example":0
},
"isTaxIncluded":{
"description":"If Tax is included?",
"type":"boolean",
"example":false
},
"miscTax":{
"description":"Misc Tax.",
"type":"number",
"example":1.87
},
"districtTax":{
"description":"District Tax.",
"type":"number",
"example":0
},
"stateTax":{
"description":"State Tax.",
"type":"number",
"example":3.9
},
"countryTax":{
"description":"Country Tax.",
"type":"number",
"example":0
}
}
},
"lastName":{
"description":"The second name of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"Muir"
},
"itemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding items property is truncated. The value for this field will always be true if present",
"type":"boolean"
},
"shippingMethod":{
"description":"The shipping method details for the order.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"shippingTax":{
"type":"number"
},
"cost":{
"description":"The total cost of shipping.",
"type":"number"
},
"taxCode":{
"type":"string"
},
"value":{
"description":"The shipping method applied to the order.",
"type":"string"
},
"shippingMethodDescription":{
"type":"string"
}
}
},
"shippingGroupId":{
"description":"The shipping Group id",
"type":"string",
"example":"sg1234"
},
"store":{
"description":"The store is present in the request if the type is inStorePickupShippingGroup.",
"type":"object",
"properties":{
"country":{
"description":"The country of the store",
"type":"string",
"example":"USA"
},
"hours":{
"description":"The store's opening hours.",
"type":"string",
"example":"Mon - Sat 10AM - 7PM Sun 11AM - 6 PM"
},
"address3":{
"description":"Address line 3 of store.",
"type":"string",
"example":"Main Street"
},
"address2":{
"description":"Address line 2 of store.",
"type":"string",
"example":"4th Floor"
},
"city":{
"description":"The store's city.",
"type":"string",
"example":"Boston"
},
"address1":{
"description":"Address line 1 of store.",
"type":"string",
"example":"One Beacon Street"
},
"stateAddress":{
"description":"The store's state address.",
"type":"string",
"example":"MA"
},
"county":{
"description":"The store's county",
"type":"string",
"example":"MA"
},
"phoneNumber":{
"description":"The store's phone number.",
"type":"string",
"example":"(617) 386-1201"
},
"locationId":{
"description":"The store's location Id.",
"type":"string",
"example":"Boston138"
},
"name":{
"description":"The store's name.",
"type":"string",
"example":"Boston Store #138"
},
"faxNumber":{
"description":"Fax number.",
"type":"string",
"example":"(617) 386-1200"
},
"postCode":{
"description":"The store's post code.",
"type":"string",
"example":"2108"
},
"email":{
"description":"The store's email address.",
"type":"string",
"example":"store138@example.com"
}
}
},
"type":{
"description":"the shippingGroup type",
"type":"string",
"example":"inStorePickupShippingGroup"
},
"firstName":{
"description":"The first name of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"John"
},
"priceInfo":{
"description":"The price information.",
"type":"object",
"properties":{
"amount":{
"description":"The total order amount.",
"type":"number",
"example":24.99
},
"total":{
"description":"The order total.",
"type":"number",
"example":47.93
},
"lkpValExcludingFreeShip":{
"description":"The total shipping cost excluding items with free shipping.",
"type":"number",
"example":0
},
"shipping":{
"description":"The total shipping cost.",
"type":"number",
"example":14.95
},
"shippingSurchargeValue":{
"description":"Extra handling costs for shipping the products",
"type":"number",
"example":0
},
"tax":{
"description":"The total tax amount.",
"type":"number",
"example":7.99
},
"subTotal":{
"description":"Sub-total.",
"type":"number",
"example":24.99
},
"currencyCode":{
"description":"The currency code.",
"type":"string",
"example":"USD"
},
"totalWithoutTax":{
"description":"The total amount without tax.",
"type":"number",
"example":39.49
}
}
},
"phoneNumber":{
"description":"The phone number of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"1231231234"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"total":{
"description":"The total price of the recurring charge.",
"type":"number"
},
"frequencyAmountTotals":{
"description":"The total for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string"
}
}
}
},
"shipping":{
"description":"Cost of shipping the product.",
"type":"number"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"subTotal":{
"description":"The sub-total price of the recurring charge.",
"type":"number"
},
"frequencyTaxTotals":{
"description":"The tax for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string"
}
}
}
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"totalWithoutTax":{
"description":"Total of recurring amount without tax included.",
"type":"number"
}
}
},
"discountInfo":{
"description":"The discount information.",
"type":"object",
"properties":{
"unclaimedCouponMultiPromotions":{
"type":"object",
"properties":{
"promotionInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"long desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PRMName"
},
"promotionLevel":{
"type":"string",
"example":"order"
},
"totalAdjustment":{
"type":"integer",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"description of the promotion"
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
},
"orderCouponsMap":{
"description":"The coupons that were claimed.",
"type":"object",
"properties":{
"couponCode":{
"description":"Coupon Code.",
"type":"object",
"properties":{
"promotionLongDesc":{
"description":"The description of the promotion.",
"type":"string",
"example":"<p>desc Spend 10 Get 10% Off</p>"
},
"promotionName":{
"description":"The display name of the promotion.",
"type":"string",
"example":"10% Off"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean",
"example":false
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"number",
"example":-11.1
},
"promotionDesc":{
"description":"Description of the promotion. Retained for backward compatibility.",
"type":"string",
"example":"Spend 10 Get 10% Off"
},
"promotionId":{
"description":"The Id of the promotion.",
"type":"string",
"example":"promo123"
}
}
}
}
},
"orderDiscount":{
"description":"The order discount.",
"type":"number",
"example":0
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"number",
"example":5.6
},
"orderImplicitDiscountList":{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"Detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PROMO1"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean",
"example":true
},
"promotionLevel":{
"description":"promotion level - order or item",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string",
"example":5.6
},
"promotionDesc":{
"type":"string",
"example":"the order related promotion"
},
"secondaryCurrencyTotalAdjustment":{
"description":"The total adjustment for secondary currency",
"type":"string",
"example":0
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
},
"unclaimedCouponsMap":{
"type":"object",
"properties":{
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
},
"claimedCouponMultiPromotions":{
"type":"object",
"properties":{
"promotions":{
"type":"array",
"items":{
"type":"object",
"properties":{
"totalAdjustment":{
"type":"integer",
"example":0
},
"secondaryCurrencyTotalAdjustment":{
"type":"integer",
"example":0
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
}
}
},
"shippingAddress":{
"description":"The shipping address details.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name.",
"type":"string",
"example":"Muir"
},
"country":{
"description":"Country.",
"type":"string"
},
"address3":{
"description":"Address snippet.",
"type":"string"
},
"address2":{
"description":"Address snippet.",
"type":"string"
},
"city":{
"description":"City.",
"type":"string",
"example":"Cambridge"
},
"address1":{
"description":"Address snippet.",
"type":"string",
"example":"1 main st"
},
"prefix":{
"description":"Name prefix.",
"type":"string"
},
"companyName":{
"description":"Company name.",
"type":"string",
"example":"oracle"
},
"postalCode":{
"description":"Postal code.",
"type":"string",
"example":1122
},
"jobTitle":{
"description":"Job title.",
"type":"string",
"example":"manager"
},
"county":{
"description":"County.",
"type":"string"
},
"suffix":{
"description":"Name suffix.",
"type":"string"
},
"firstName":{
"description":"First name",
"type":"string",
"example":"John"
},
"phoneNumber":{
"description":"Phone number.",
"type":"string",
"example":1111111111
},
"faxNumber":{
"description":"Fax number.",
"type":"string"
},
"middleName":{
"description":"Middle name.",
"type":"string",
"example":"Morgan"
},
"state":{
"description":"State.",
"type":"string",
"example":"MA"
},
"email":{
"description":"Email address.",
"type":"string",
"example":"john.muir@oracle.com"
}
}
},
"items":{
"type":"array",
"items":{
"properties":{
"availablePickupDate":{
"description":"The items available store pickup date.",
"type":"string",
"example":"2018-05-19T13:00:00.000Z"
},
"inventoryLocationId":{
"description":"Defines the inventory location that services the referenced commerce item.",
"type":"string"
},
"rawTotalPrice":{
"description":"The raw total price.",
"type":"number",
"example":24.99
},
"returnedQuantity":{
"type":"integer",
"example":0
},
"dynamicProperties":{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string",
"example":11502
},
"label":{
"description":"The dynamic property label.",
"type":"string",
"example":"dyn_prop"
},
"value":{
"description":"The dynamic property value.",
"type":"string",
"example":12
}
}
}
},
"shippingSurchargeValue":{
"description":"Extra handling cost for shipping the product.",
"type":"number",
"example":0
},
"availabilityDate":{
"format":"date-time",
"description":"The availability date for preOrdered/backOrdered quantity.",
"type":"string",
"example":"2018-06-13T18:09:53.493Z"
},
"discountAmount":{
"description":"The monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal. (read-only)",
"type":"number",
"example":0
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a third party system.",
"type":"array",
"items":{
"properties":{
"values":{
"description":"The map values associated with an externalData item.",
"type":"object",
"properties":{
"value":{
"description":"Map value defined by external system.",
"type":"string"
},
"key":{
"description":"Map key defined by external system.",
"type":"string"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the third party system.",
"type":"string"
}
}
}
},
"preOrderQuantity":{
"description":"The pre ordered quantity included.",
"type":"integer",
"example":0
},
"childItems":{
"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"
},
"commerceItemId":{
"description":"Commerce Item ID for this commerce item.",
"type":"string",
"example":"ci123545"
},
"price":{
"type":"number",
"example":24.99
},
"childItemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding childItems property is truncated. The value for this field will be true always if present",
"type":"boolean"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean",
"example":false
},
"actionCode":{
"description":"The action code that has been set on the item by the third party system.",
"type":"string"
},
"commerceId":{
"description":"Commerce ID for this commerce item.",
"type":"string",
"example":"ci12343"
},
"stateDetailsAsUser":{
"type":"string",
"example":"details of shippingItem"
},
"unitPrice":{
"type":"number",
"example":24.99
},
"amount":{
"description":"The monetary amount.",
"type":"number",
"example":24.99
},
"quantity":{
"description":"The number of items covered by this price info",
"type":"integer",
"example":1
},
"productId":{
"description":"The ID of the product.",
"type":"string",
"example":"product_9e"
},
"salePrice":{
"description":"The sale price",
"type":"number",
"example":0
},
"detailedItemPriceInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean",
"example":false
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number",
"example":0
},
"amount":{
"type":"number",
"example":24.99
},
"quantity":{
"type":"integer",
"example":1
},
"tax":{
"type":"number",
"example":0
},
"orderDiscountShare":{
"type":"integer",
"example":0
},
"detailedUnitPrice":{
"type":"number",
"example":24.99
},
"currencyCode":{
"type":"string",
"example":"USD"
}
}
}
},
"preferredPickupDate":{
"description":"The items preferred store pickup date.",
"type":"string",
"example":"2018-05-19T13:00:00.000Z"
},
"catRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string",
"example":"Sku_9F"
},
"discountInfo":{
"description":"Whether this item is discounted.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"Promotion BAC"
},
"external":{
"description":"if promotion is external",
"type":"boolean",
"example":false
},
"coupon":{
"type":"string",
"example":"CPN123"
},
"promotionLevel":{
"type":"string",
"example":"item"
},
"totalAdjustment":{
"type":"string",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"promotion desc"
},
"promotionId":{
"type":"string",
"example":"PRM123"
},
"giftWithPurchaseDiscountInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"gitWithPurchaseDetail":{
"type":"string",
"example":"details of gift"
},
"gitWithPurchaseIdentifier":{
"type":"integer",
"example":1223344
},
"giftWithPurchaseType":{
"description":"the gift type.For example product or sku",
"type":"string",
"example":"product"
},
"promotionDesc":{
"type":"string",
"example":"GWP Promotion description"
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
}
}
}
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"backOrderQuantity":{
"description":"The back ordered quantity included.",
"type":"integer",
"example":0
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number",
"example":24.99
},
"status":{
"type":"string",
"example":"INITIAL"
}
}
}
},
"email":{
"description":"The email address of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"john.muir@oracle.com"
}
}
}
},
"creationTime":{
"type":"integer",
"example":1.519827617E12
},
"lastModifiedDate":{
"type":"integer",
"example":"2018-02-28T14:20:17.000Z"
},
"orderId":{
"type":"string",
"example":"o123456"
},
"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",
"example":"siteUS"
},
"dynamicProperties":{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string",
"example":11502
},
"label":{
"description":"The dynamic property label.",
"type":"string",
"example":"dyn_prop"
},
"value":{
"description":"The dynamic property value.",
"type":"string",
"example":12
}
}
}
},
"payments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"paymentGroupId":{
"type":"string",
"example":"PYMT123"
},
"amount":{
"type":"integer",
"example":24
},
"balance":{
"type":"number",
"example":0
},
"gatewayName":{
"type":"string",
"example":"Chase"
},
"giftCardNumber":{
"type":"integer",
"example":0
},
"uiIntervention":{
"type":"string"
},
"paymentMethod":{
"type":"string",
"example":"card"
},
"isAmountRemaining":{
"type":"boolean",
"example":false
},
"paymentState":{
"type":"string",
"example":"AUTHORIZED"
},
"maskedCardNumber":{
"type":"string",
"example":1234
}
}
}
},
"shippingMethod":{
"type":"object",
"properties":{
"shippingTax":{
"type":"number",
"example":2.09
},
"cost":{
"type":"number",
"example":14.95
},
"value":{
"type":"string",
"example":"fedex-ground"
}
}
},
"priceListGroup":{
"type":"object",
"properties":{
"id":{
"type":"string",
"example":"defaultPriceListGroup"
}
}
},
"orderStatus":{
"type":"string",
"example":"Incomplete"
},
"creationDate":{
"type":"string",
"example":"2018-02-28T14:20:17.000Z"
},
"orderProfileId":{
"type":"string",
"example":110072
},
"priceInfo":{
"type":"object",
"properties":{
"amount":{
"type":"number",
"example":24.99
},
"total":{
"type":"number",
"example":24.99
},
"shipping":{
"type":"number",
"example":14.95
},
"shippingSurchargeValue":{
"type":"number",
"example":0
},
"tax":{
"type":"number",
"example":0
},
"subTotal":{
"type":"number",
"example":24.99
},
"currencyCode":{
"type":"string",
"example":"USD"
},
"totalWithoutTax":{
"type":"number",
"example":24.99
}
}
},
"discountInfo":{
"description":"The discount information.",
"properties":{
"unclaimedCouponMultiPromotions":{
"type":"object",
"properties":{
"promotionInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"long desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PRMName"
},
"promotionLevel":{
"type":"string",
"example":"order"
},
"totalAdjustment":{
"type":"integer",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"description of the promotion"
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
},
"orderCouponsMap":{
"description":"The coupons that were claimed.",
"type":"object",
"properties":{
"couponCode":{
"description":"Coupon Code.",
"type":"object",
"properties":{
"promotionLongDesc":{
"description":"The description of the promotion.",
"type":"string",
"example":"<p>desc Spend 10 Get 10% Off</p>"
},
"promotionName":{
"description":"The display name of the promotion.",
"type":"string",
"example":"10% Off"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean",
"example":false
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"number",
"example":-11.1
},
"promotionDesc":{
"description":"Description of the promotion. Retained for backward compatibility.",
"type":"string",
"example":"Spend 10 Get 10% Off"
},
"promotionId":{
"description":"The Id of the promotion.",
"type":"string",
"example":"promo123"
}
}
}
}
},
"orderDiscount":{
"description":"The order discount.",
"type":"number",
"example":0
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"number",
"example":5.6
},
"orderImplicitDiscountList":{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"Detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PROMO1"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean",
"example":true
},
"promotionLevel":{
"description":"the level of promotion. Value can be order or item or shipping",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string",
"example":5.6
},
"promotionDesc":{
"type":"string",
"example":"the order related promotion"
},
"secondaryCurrencyTotalAdjustment":{
"description":"The total adjustment for secondary currency",
"type":"string",
"example":0
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
},
"unclaimedCouponsMap":{
"type":"object",
"properties":{
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
},
"claimedCouponMultiPromotions":{
"type":"object",
"properties":{
"promotions":{
"type":"array",
"items":{
"type":"object",
"properties":{
"totalAdjustment":{
"type":"integer",
"example":0
},
"secondaryCurrencyTotalAdjustment":{
"type":"integer",
"example":0
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
}
}
},
"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",
"example":1
},
"items":{
"description":"The array of products in the shopping cart. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook",
"type":"array",
"items":{
"type":"object",
"properties":{
"primaryThumbImageURL":{
"type":"string",
"example":"/ccstore/v1/images/product.jpg"
},
"rawTotalPrice":{
"type":"number",
"example":24.99
},
"dynamicProperties":{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string",
"example":11052
},
"label":{
"description":"The dynamic property label.",
"type":"string",
"example":"dyn_size"
},
"value":{
"description":"The dynamic property value.",
"type":"string",
"example":12
}
}
}
},
"displayName":{
"type":"string",
"example":"ProductXYZ name"
},
"shippingSurchargeValue":{
"type":"integer",
"example":0
},
"description":{
"type":"string",
"example":"description of the product"
},
"discountAmount":{
"type":"number",
"example":0
},
"isItemValid":{
"type":"boolean",
"example":true
},
"externalData":{
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"type":"object",
"properties":{
"value":{
"type":"object"
},
"key":{
"type":"object"
}
}
},
"name":{
"type":"string",
"example":"externalDataName"
},
"actionCode":{
"type":"string"
}
}
}
},
"commerceItemId":{
"description":"id of the commerce item",
"type":"string",
"example":"ci20015"
},
"price":{
"type":"number",
"example":24.99
},
"variant":{
"description":"List of variants for the product.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value.",
"type":"string",
"example":"L"
},
"optionName":{
"description":"The variant option name.",
"type":"string",
"example":"size"
}
}
}
},
"childItemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding childItems property is truncated. The value for this field will be true always if present",
"type":"boolean"
},
"onSale":{
"type":"boolean",
"example":false
},
"id":{
"type":"string",
"example":"ci15000415"
},
"unitPrice":{
"type":"number",
"example":24.99
},
"amount":{
"description":"value of the commerce Item",
"type":"integer",
"example":24.99
},
"quantity":{
"type":"integer",
"example":1
},
"productId":{
"type":"string",
"example":"Product_9f"
},
"salePrice":{
"type":"number",
"example":0
},
"detailedItemPriceInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean",
"example":false
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number",
"example":0
},
"amount":{
"type":"number",
"example":24.99
},
"quantity":{
"type":"integer",
"example":1
},
"tax":{
"type":"number",
"example":0
},
"orderDiscountShare":{
"type":"integer",
"example":0
},
"detailedUnitPrice":{
"type":"number",
"example":24.99
},
"currencyCode":{
"type":"string",
"example":"USD"
}
}
}
},
"giftWithPurchaseCommerceItemMarkers":{
"type":"array",
"items":{
"type":"object",
"properties":{
"selectedQuantity":{
"type":"integer",
"example":0
},
"id":{
"type":"string",
"example":"gwp id"
}
}
}
},
"taxCode":{
"type":"string",
"example":"DV1001"
},
"catRefId":{
"type":"string",
"example":"sku_9f"
},
"skuProperties":{
"type":"array",
"items":{
"properties":{
"propertyType":{
"type":"string",
"example":"sku-base"
},
"name":{
"type":"string",
"example":"Not returnable"
},
"id":{
"type":"string",
"example":"nonreturnable"
},
"value":{
"type":"boolean",
"example":false
}
}
}
},
"discountInfo":{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"coupon":{
"description":"The coupon ID.",
"type":"string",
"example":"CPN123456"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string",
"example":"the example promotion"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string",
"example":"PRM1234"
}
}
}
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string",
"example":"siteUS"
},
"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"
},
"listPrice":{
"type":"number",
"example":24.99
}
}
}
}
}
},
"giftWithPurchaseInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"giftWithPurchaseQuantityAvailableForSelection":{
"type":"integer",
"example":2
},
"gitWithPurchaseDetail":{
"type":"string",
"example":"details of gift"
},
"gitWithPurchaseIdentifier":{
"type":"integer",
"example":1223344
},
"giftWithPurchaseType":{
"description":"the gift type.For example product or sku",
"type":"string",
"example":"product"
},
"promotionDesc":{
"type":"string",
"example":"GWP Promotion description"
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
},
"shippingAddress":{
"type":"object",
"properties":{
"lastName":{
"type":"string",
"example":"Muir"
},
"country":{
"type":"string",
"example":"United States"
},
"address3":{
"type":"string"
},
"address2":{
"type":"string"
},
"city":{
"type":"string",
"example":"Cambridge"
},
"address1":{
"type":"string",
"example":"1 main st"
},
"prefix":{
"type":"string",
"example":"Mr"
},
"companyName":{
"type":"string",
"example":"Oracle"
},
"postalCode":{
"type":"string",
"example":1122
},
"jobTitle":{
"type":"string",
"example":"Manager"
},
"county":{
"type":"string",
"example":"Suffolk"
},
"suffix":{
"type":"string"
},
"firstName":{
"type":"string",
"example":"John"
},
"phoneNumber":{
"type":"integer",
"example":1231231234
},
"faxNumber":{
"type":"integer",
"example":1231231234
},
"middleName":{
"type":"string",
"example":"Morgan"
},
"state":{
"type":"string",
"example":"MA"
},
"email":{
"type":"string",
"example":"john.muir@oracle.com"
}
}
},
"siteId":{
"type":"string",
"example":"siteUS"
}
}
}
Nested Schema : productInformation
Type: object
Show Source
{
"type":"object",
"properties":{
"length":{
"description":"length of the product",
"type":"number",
"example":1
},
"width":{
"description":"width of the product",
"type":"number",
"example":1
},
"weight":{
"description":"weight of the product",
"type":"number",
"example":1
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number",
"example":0
},
"id":{
"description":"id of the product",
"type":"string",
"example":"Product_xyz"
},
"taxCode":{
"description":"Tax Code of the product.",
"type":"string",
"example":"DV10010"
},
"height":{
"description":"height of the product",
"type":"number",
"example":1
}
}
}
Nested Schema : profile
Type: object
Show Source
{
"type":"object",
"properties":{
"lastName":{
"type":"string",
"example":"Muir"
},
"taxExempt":{
"default":false,
"description":"Indicates if the user profile is taxExempt",
"type":"boolean",
"example":false
},
"taxExemptionCode":{
"description":"Describes the tax exemption code",
"type":"string",
"example":"TX123"
},
"locale":{
"description":"Locale of the storefront",
"type":"string",
"example":"en"
},
"parentOrganization":{
"type":"object",
"properties":{
"contract":{
"description":"Describes the contract details of the organization and user",
"type":"object",
"properties":{
"displayName":{
"type":"string",
"example":"Contract_ABC"
},
"description":{
"type":"string",
"example":"Contract with companyA"
},
"id":{
"type":"string",
"example":"ct-1001"
}
}
},
"name":{
"description":"name of the parent organization user belongs to",
"type":"string",
"example":"CompanyA"
},
"description":{
"type":"string",
"example":"CompanyA description"
},
"id":{
"description":"String representation of the parent organization id",
"type":"string",
"example":"or-1001"
}
}
},
"sitePropertiesList":{
"description":"The list of site related properties for the profile",
"type":"array",
"items":{
"type":"object",
"properties":{
"site":{
"description":"The site data",
"type":"object",
"properties":{
"id":{
"description":"The id of the site",
"type":"string",
"example":"siteUS"
}
}
},
"properties":{
"description":"The site related properties for the profile",
"type":"object",
"properties":{
"GDPRProfileP13nConsentDate":{
"description":"The date on which GDPR personalization consent was granted by the user.",
"type":"string",
"example":"2013-04-12 14:48:45 -0400"
},
"GDPRProfileP13nConsentGranted":{
"description":"If user has given consent for his/her profile information to be used for personalization purposes.",
"type":"boolean",
"example":false
},
"receiveEmail":{
"description":"Indicates whether the user should receive marketing emails on the current site. Can be yes or no.",
"type":"string",
"example":"no"
},
"receiveEmailDate":{
"description":"The date on which email marketing consent was granted by the user.",
"type":"string",
"example":"2013-04-12 14:48:45 -0400"
}
}
}
}
}
},
"firstName":{
"type":"string",
"example":"John"
},
"profileType":{
"description":"Indicates if the user is B2B user. For a b2b user, this is b2b_user",
"type":"string",
"example":"b2b_user"
},
"loyaltyPrograms":{
"type":"array",
"items":{
"type":"object",
"properties":{
"profileId":{
"description":"User profile id on storefront",
"type":"string",
"example":117012
},
"programName":{
"type":"string",
"example":"Loyalty Program1"
},
"membershipId":{
"description":"MembershipId of the user enrolled in the program",
"type":"string",
"example":"LPM1234"
},
"programId":{
"description":"Id of the loyaltyProgram",
"type":"string",
"example":"LP1234"
},
"status":{
"description":"Provides the current status of user in loyaltyProgram",
"enum":[
"RequestForEnrollment",
"Enrolled",
"RequestForUnenrollment",
"Unenrolled",
"Failed"
],
"example":"Enrolled"
}
}
}
},
"middleName":{
"type":"string",
"example":"Muir"
},
"currentOrganization":{
"type":"object",
"properties":{
"contract":{
"description":"Describes the contract details of the organization and user",
"type":"object",
"properties":{
"displayName":{
"type":"string",
"example":"Contract_ABC"
},
"description":{
"type":"string",
"example":"Contract with companyA"
},
"id":{
"type":"string",
"example":"ct-1001"
}
}
},
"name":{
"description":"name of the current organization user belongs to",
"type":"string",
"example":"CompanyA"
},
"description":{
"type":"string",
"example":"CompanyA description"
},
"id":{
"description":"String representation of the current organization id",
"type":"string",
"example":"or-1001"
}
}
},
"id":{
"description":"profileId of the user",
"type":"string",
"example":117012
},
"email":{
"description":"Email address of the user",
"type":"string",
"example":"john.muir@oracle.com"
},
"secondaryOrganizations":{
"type":"array",
"items":{
"type":"object",
"properties":{
"contract":{
"description":"Describes the contract details of the organization and user",
"type":"object",
"properties":{
"displayName":{
"type":"string",
"example":"Contract_ABC"
},
"description":{
"type":"string",
"example":"Contract with companyA"
},
"id":{
"type":"string",
"example":"ct-1001"
}
}
},
"name":{
"description":"name of the secondary organization user belongs to",
"type":"string",
"example":"CompanyA"
},
"description":{
"type":"string",
"example":"CompanyA description"
},
"id":{
"description":"String representation of the secondary organization id",
"type":"string",
"example":"or-1001"
}
}
}
},
"daytimeTelephoneNumber":{
"description":"user contact phone number",
"type":"number",
"example":"123-123-1234"
}
}
}
Nested Schema : request
Type: object
Show Source
{
"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"
},
"secondaryCurrencyCode":{
"description":"Secondary currencyCode",
"type":"string",
"example":"USD"
},
"address":{
"description":"Address",
"type":"object",
"properties":{
"lastName":{
"description":"lastName of person",
"type":"string",
"example":"Muir"
},
"firstName":{
"description":"firstName of person",
"type":"string",
"example":"John"
},
"country":{
"description":"the country of the Address",
"type":"string",
"example":"US"
},
"address2":{
"description":"address2 of the person",
"type":"string",
"example":"Apt 123"
},
"address1":{
"description":"address1 of the person",
"type":"string",
"example":"1 main st"
},
"postalCode":{
"description":"postalCode of the person",
"type":"string",
"example":1122
},
"state":{
"description":"state of the person",
"type":"string",
"example":"New York"
}
}
},
"appliedCoupons":{
"description":"Coupons applied to order.",
"type":"array",
"items":{
"type":"string",
"example":"CPN123"
}
},
"locale":{
"description":"locale",
"type":"object",
"properties":{
"country":{
"description":"country",
"type":"string",
"example":"US"
},
"displayName":{
"description":"the display name",
"type":"string",
"example":"English"
},
"language":{
"description":"language",
"type":"string",
"example":"en"
}
}
},
"orderTotal":{
"description":"The total price of the order.",
"type":"number",
"example":24.99
},
"exchangeRate":{
"description":"exchangeRate",
"type":"number",
"example":0
},
"profileId":{
"description":"Id of the profile",
"type":"string",
"example":117012
},
"orderDiscount":{
"description":"Discount given on an order.",
"type":"number",
"example":0
},
"siteId":{
"description":"site associated with this request",
"type":"string",
"example":"siteUS"
},
"rawOrderTotal":{
"description":"the raw order total",
"type":"number",
"example":24.99
},
"currencyCode":{
"description":"Indicates the currency of the price. For example, USD indicates that the price is in US dollars.",
"type":"string",
"example":"USD"
},
"items":{
"description":"items",
"type":"array",
"items":{
"type":"object",
"properties":{
"product":{
"description":"product",
"type":"object",
"properties":{
"width":{
"description":"width of the product",
"type":"number",
"example":1
},
"length":{
"description":"length of the product",
"type":"number",
"example":1
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number",
"example":0
},
"weight":{
"description":"weight of the product",
"type":"number",
"example":1
},
"id":{
"description":"id of the product",
"type":"string",
"example":"Product_XYZ"
},
"taxCode":{
"description":"Tax Code of the product.",
"type":"string",
"example":"DV10010"
},
"height":{
"description":"height of the product",
"type":"number",
"example":1
}
}
},
"amount":{
"description":"amount",
"type":"number",
"example":24.99
},
"quantity":{
"description":"quantity",
"type":"integer",
"example":1
},
"rawTotalPrice":{
"description":"The raw total price.",
"type":"number",
"example":24.99
},
"discount":{
"description":"discount of the order",
"type":"number",
"example":0
},
"catalogRefId":{
"description":"The catalog ref id",
"type":"string",
"example":"SKU_Ref"
}
}
}
}
}
}
Nested Schema : shippingGroupIdsToPrice
Type: array
List of shipping group ids provided by the client for retrieval of shipping methods.
Show Source
{
"description":"List of shipping group ids provided by the client for retrieval of shipping methods.",
"type":"array",
"items":{
"type":"string"
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"eligibleForProductWithSurcharges":{
"description":"Whether this shipping method is enabled for products with surcharges or not.",
"type":"boolean",
"example":false
},
"ranges":{
"description":"The price ranges for this shipping method.",
"type":"array",
"items":{
"type":"object",
"properties":{
"amount":{
"description":"The monetary value for the range.",
"type":"number",
"example":12
},
"high":{
"description":"The upper boundary of the range",
"type":"number",
"example":15
},
"low":{
"description":"The lower boundary of the range.",
"type":"number",
"example":10
}
}
}
},
"associatedPriceListGroups":{
"description":"The associated Price list groups for this Shipping Method.",
"type":"object",
"properties":{
"displayName":{
"description":"The display name of the price list group.",
"type":"string",
"example":"USD"
},
"id":{
"description":"The id of the price list group.",
"type":"string",
"example":"PLG-ID"
}
}
},
"displayName":{
"description":"The display name of the shipping method.",
"type":"string"
},
"description":{
"description":"The description of the shipping method.",
"type":"string"
},
"allSites":{
"description":"Indicates that the shipping method is available to all sites.",
"type":"boolean"
},
"sites":{
"description":"Sites that the shipping method is available to.",
"type":"array",
"items":{
"type":"object",
"properties":{
"name":{
"description":"The name of the site.",
"type":"string"
},
"id":{
"description":"The site id.",
"type":"string"
}
}
}
},
"excludedCategoriesShippingCharge":{
"description":"Excluded categories for shipping charges.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The category id excluded from shipping charge.",
"type":"string"
}
}
}
},
"isFallback":{
"description":"Indicates if the shipping method is a fallback shipping method in case of an external shipping method failure.",
"type":"boolean"
},
"taxCode":{
"description":"A valid tax code for calculating tax on shipping.",
"type":"string"
},
"shippingGroupType":{
"description":"The shipping group type of the shipping method.",
"type":"string"
}
}
}
Nested Schema : associatedPriceListGroups
Type: object
The associated Price list groups for this Shipping Method.
Show Source
{
"description":"The associated Price list groups for this Shipping Method.",
"type":"object",
"properties":{
"displayName":{
"description":"The display name of the price list group.",
"type":"string",
"example":"USD"
},
"id":{
"description":"The id of the price list group.",
"type":"string",
"example":"PLG-ID"
}
}
}
Nested Schema : excludedCategoriesShippingCharge
Type: array
Excluded categories for shipping charges.
Show Source
{
"description":"Excluded categories for shipping charges.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The category id excluded from shipping charge.",
"type":"string"
}
}
}
}
Nested Schema : ranges
Type: array
The price ranges for this shipping method.
Show Source
{
"description":"The price ranges for this shipping method.",
"type":"array",
"items":{
"type":"object",
"properties":{
"amount":{
"description":"The monetary value for the range.",
"type":"number",
"example":12
},
"high":{
"description":"The upper boundary of the range",
"type":"number",
"example":15
},
"low":{
"description":"The lower boundary of the range.",
"type":"number",
"example":10
}
}
}
}
Nested Schema : sites
Type: array
Sites that the shipping method is available to.
Show Source
{
"description":"Sites that the shipping method is available to.",
"type":"array",
"items":{
"type":"object",
"properties":{
"name":{
"description":"The name of the site.",
"type":"string"
},
"id":{
"description":"The site id.",
"type":"string"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"id":{
"description":"The category id excluded from shipping charge.",
"type":"string"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"amount":{
"description":"The monetary value for the range.",
"type":"number",
"example":12
},
"high":{
"description":"The upper boundary of the range",
"type":"number",
"example":15
},
"low":{
"description":"The lower boundary of the range.",
"type":"number",
"example":10
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"name":{
"description":"The name of the site.",
"type":"string"
},
"id":{
"description":"The site id.",
"type":"string"
}
}
}
Nested Schema : discountInfo
Type: object
The discount information.
Show Source
{
"description":"The discount information.",
"properties":{
"unclaimedCouponMultiPromotions":{
"type":"object",
"properties":{
"promotionInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"long desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PRMName"
},
"promotionLevel":{
"type":"string",
"example":"order"
},
"totalAdjustment":{
"type":"integer",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"description of the promotion"
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
},
"orderCouponsMap":{
"description":"The coupons that were claimed.",
"type":"object",
"properties":{
"couponCode":{
"description":"Coupon Code.",
"type":"object",
"properties":{
"promotionLongDesc":{
"description":"The description of the promotion.",
"type":"string",
"example":"<p>desc Spend 10 Get 10% Off</p>"
},
"promotionName":{
"description":"The display name of the promotion.",
"type":"string",
"example":"10% Off"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean",
"example":false
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"number",
"example":-11.1
},
"promotionDesc":{
"description":"Description of the promotion. Retained for backward compatibility.",
"type":"string",
"example":"Spend 10 Get 10% Off"
},
"promotionId":{
"description":"The Id of the promotion.",
"type":"string",
"example":"promo123"
}
}
}
}
},
"orderDiscount":{
"description":"The order discount.",
"type":"number",
"example":0
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"number",
"example":5.6
},
"orderImplicitDiscountList":{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"Detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PROMO1"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean",
"example":true
},
"promotionLevel":{
"description":"the level of promotion. Value can be order or item or shipping",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string",
"example":5.6
},
"promotionDesc":{
"type":"string",
"example":"the order related promotion"
},
"secondaryCurrencyTotalAdjustment":{
"description":"The total adjustment for secondary currency",
"type":"string",
"example":0
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
},
"unclaimedCouponsMap":{
"type":"object",
"properties":{
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
},
"claimedCouponMultiPromotions":{
"type":"object",
"properties":{
"promotions":{
"type":"array",
"items":{
"type":"object",
"properties":{
"totalAdjustment":{
"type":"integer",
"example":0
},
"secondaryCurrencyTotalAdjustment":{
"type":"integer",
"example":0
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
}
}
}
Nested Schema : dynamicProperties
Type: array
List of dynamic properties at line item level.
Show Source
{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string",
"example":11502
},
"label":{
"description":"The dynamic property label.",
"type":"string",
"example":"dyn_prop"
},
"value":{
"description":"The dynamic property value.",
"type":"string",
"example":12
}
}
}
}
Nested Schema : giftWithPurchaseInfo
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"giftWithPurchaseQuantityAvailableForSelection":{
"type":"integer",
"example":2
},
"gitWithPurchaseDetail":{
"type":"string",
"example":"details of gift"
},
"gitWithPurchaseIdentifier":{
"type":"integer",
"example":1223344
},
"giftWithPurchaseType":{
"description":"the gift type.For example product or sku",
"type":"string",
"example":"product"
},
"promotionDesc":{
"type":"string",
"example":"GWP Promotion description"
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
}
Nested Schema : payments
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"paymentGroupId":{
"type":"string",
"example":"PYMT123"
},
"amount":{
"type":"integer",
"example":24
},
"balance":{
"type":"number",
"example":0
},
"gatewayName":{
"type":"string",
"example":"Chase"
},
"giftCardNumber":{
"type":"integer",
"example":0
},
"uiIntervention":{
"type":"string"
},
"paymentMethod":{
"type":"string",
"example":"card"
},
"isAmountRemaining":{
"type":"boolean",
"example":false
},
"paymentState":{
"type":"string",
"example":"AUTHORIZED"
},
"maskedCardNumber":{
"type":"string",
"example":1234
}
}
}
}
Nested Schema : priceInfo
Type: object
Show Source
{
"type":"object",
"properties":{
"amount":{
"type":"number",
"example":24.99
},
"total":{
"type":"number",
"example":24.99
},
"shipping":{
"type":"number",
"example":14.95
},
"shippingSurchargeValue":{
"type":"number",
"example":0
},
"tax":{
"type":"number",
"example":0
},
"subTotal":{
"type":"number",
"example":24.99
},
"currencyCode":{
"type":"string",
"example":"USD"
},
"totalWithoutTax":{
"type":"number",
"example":24.99
}
}
}
Nested Schema : priceListGroup
Type: object
Show Source
{
"type":"object",
"properties":{
"id":{
"type":"string",
"example":"defaultPriceListGroup"
}
}
}
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",
"example":"Muir"
},
"country":{
"type":"string",
"example":"United States"
},
"address3":{
"type":"string"
},
"address2":{
"type":"string"
},
"city":{
"type":"string",
"example":"Cambridge"
},
"address1":{
"type":"string",
"example":"1 main st"
},
"prefix":{
"type":"string",
"example":"Mr"
},
"companyName":{
"type":"string",
"example":"Oracle"
},
"postalCode":{
"type":"string",
"example":1122
},
"jobTitle":{
"type":"string",
"example":"Manager"
},
"county":{
"type":"string",
"example":"Suffolk"
},
"suffix":{
"type":"string"
},
"firstName":{
"type":"string",
"example":"John"
},
"phoneNumber":{
"type":"integer",
"example":1231231234
},
"faxNumber":{
"type":"integer",
"example":1231231234
},
"middleName":{
"type":"string",
"example":"Morgan"
},
"state":{
"type":"string",
"example":"MA"
},
"email":{
"type":"string",
"example":"john.muir@oracle.com"
}
}
}
Nested Schema : shippingGroups
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"taxPriceInfo":{
"description":"The shipping address details.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"taxAmount in secondaryCurrency",
"type":"number",
"example":0
},
"cityTax":{
"description":"City Tax",
"type":"number",
"example":3.9
},
"amount":{
"description":"The total order amount.",
"type":"number",
"example":5.99
},
"valueAddedTax":{
"description":"Value Added Tax.",
"type":"number",
"example":0
},
"countyTax":{
"description":"County Tax.",
"type":"number",
"example":0
},
"isTaxIncluded":{
"description":"If Tax is included?",
"type":"boolean",
"example":false
},
"miscTax":{
"description":"Misc Tax.",
"type":"number",
"example":1.87
},
"districtTax":{
"description":"District Tax.",
"type":"number",
"example":0
},
"stateTax":{
"description":"State Tax.",
"type":"number",
"example":3.9
},
"countryTax":{
"description":"Country Tax.",
"type":"number",
"example":0
}
}
},
"lastName":{
"description":"The second name of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"Muir"
},
"itemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding items property is truncated. The value for this field will always be true if present",
"type":"boolean"
},
"shippingMethod":{
"description":"The shipping method details for the order.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"shippingTax":{
"type":"number"
},
"cost":{
"description":"The total cost of shipping.",
"type":"number"
},
"taxCode":{
"type":"string"
},
"value":{
"description":"The shipping method applied to the order.",
"type":"string"
},
"shippingMethodDescription":{
"type":"string"
}
}
},
"shippingGroupId":{
"description":"The shipping Group id",
"type":"string",
"example":"sg1234"
},
"store":{
"description":"The store is present in the request if the type is inStorePickupShippingGroup.",
"type":"object",
"properties":{
"country":{
"description":"The country of the store",
"type":"string",
"example":"USA"
},
"hours":{
"description":"The store's opening hours.",
"type":"string",
"example":"Mon - Sat 10AM - 7PM Sun 11AM - 6 PM"
},
"address3":{
"description":"Address line 3 of store.",
"type":"string",
"example":"Main Street"
},
"address2":{
"description":"Address line 2 of store.",
"type":"string",
"example":"4th Floor"
},
"city":{
"description":"The store's city.",
"type":"string",
"example":"Boston"
},
"address1":{
"description":"Address line 1 of store.",
"type":"string",
"example":"One Beacon Street"
},
"stateAddress":{
"description":"The store's state address.",
"type":"string",
"example":"MA"
},
"county":{
"description":"The store's county",
"type":"string",
"example":"MA"
},
"phoneNumber":{
"description":"The store's phone number.",
"type":"string",
"example":"(617) 386-1201"
},
"locationId":{
"description":"The store's location Id.",
"type":"string",
"example":"Boston138"
},
"name":{
"description":"The store's name.",
"type":"string",
"example":"Boston Store #138"
},
"faxNumber":{
"description":"Fax number.",
"type":"string",
"example":"(617) 386-1200"
},
"postCode":{
"description":"The store's post code.",
"type":"string",
"example":"2108"
},
"email":{
"description":"The store's email address.",
"type":"string",
"example":"store138@example.com"
}
}
},
"type":{
"description":"the shippingGroup type",
"type":"string",
"example":"inStorePickupShippingGroup"
},
"firstName":{
"description":"The first name of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"John"
},
"priceInfo":{
"description":"The price information.",
"type":"object",
"properties":{
"amount":{
"description":"The total order amount.",
"type":"number",
"example":24.99
},
"total":{
"description":"The order total.",
"type":"number",
"example":47.93
},
"lkpValExcludingFreeShip":{
"description":"The total shipping cost excluding items with free shipping.",
"type":"number",
"example":0
},
"shipping":{
"description":"The total shipping cost.",
"type":"number",
"example":14.95
},
"shippingSurchargeValue":{
"description":"Extra handling costs for shipping the products",
"type":"number",
"example":0
},
"tax":{
"description":"The total tax amount.",
"type":"number",
"example":7.99
},
"subTotal":{
"description":"Sub-total.",
"type":"number",
"example":24.99
},
"currencyCode":{
"description":"The currency code.",
"type":"string",
"example":"USD"
},
"totalWithoutTax":{
"description":"The total amount without tax.",
"type":"number",
"example":39.49
}
}
},
"phoneNumber":{
"description":"The phone number of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"1231231234"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"total":{
"description":"The total price of the recurring charge.",
"type":"number"
},
"frequencyAmountTotals":{
"description":"The total for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string"
}
}
}
},
"shipping":{
"description":"Cost of shipping the product.",
"type":"number"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"subTotal":{
"description":"The sub-total price of the recurring charge.",
"type":"number"
},
"frequencyTaxTotals":{
"description":"The tax for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string"
}
}
}
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"totalWithoutTax":{
"description":"Total of recurring amount without tax included.",
"type":"number"
}
}
},
"discountInfo":{
"description":"The discount information.",
"type":"object",
"properties":{
"unclaimedCouponMultiPromotions":{
"type":"object",
"properties":{
"promotionInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"long desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PRMName"
},
"promotionLevel":{
"type":"string",
"example":"order"
},
"totalAdjustment":{
"type":"integer",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"description of the promotion"
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
},
"orderCouponsMap":{
"description":"The coupons that were claimed.",
"type":"object",
"properties":{
"couponCode":{
"description":"Coupon Code.",
"type":"object",
"properties":{
"promotionLongDesc":{
"description":"The description of the promotion.",
"type":"string",
"example":"<p>desc Spend 10 Get 10% Off</p>"
},
"promotionName":{
"description":"The display name of the promotion.",
"type":"string",
"example":"10% Off"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean",
"example":false
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"number",
"example":-11.1
},
"promotionDesc":{
"description":"Description of the promotion. Retained for backward compatibility.",
"type":"string",
"example":"Spend 10 Get 10% Off"
},
"promotionId":{
"description":"The Id of the promotion.",
"type":"string",
"example":"promo123"
}
}
}
}
},
"orderDiscount":{
"description":"The order discount.",
"type":"number",
"example":0
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"number",
"example":5.6
},
"orderImplicitDiscountList":{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"Detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PROMO1"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean",
"example":true
},
"promotionLevel":{
"description":"promotion level - order or item",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string",
"example":5.6
},
"promotionDesc":{
"type":"string",
"example":"the order related promotion"
},
"secondaryCurrencyTotalAdjustment":{
"description":"The total adjustment for secondary currency",
"type":"string",
"example":0
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
},
"unclaimedCouponsMap":{
"type":"object",
"properties":{
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
},
"claimedCouponMultiPromotions":{
"type":"object",
"properties":{
"promotions":{
"type":"array",
"items":{
"type":"object",
"properties":{
"totalAdjustment":{
"type":"integer",
"example":0
},
"secondaryCurrencyTotalAdjustment":{
"type":"integer",
"example":0
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
}
}
},
"shippingAddress":{
"description":"The shipping address details.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name.",
"type":"string",
"example":"Muir"
},
"country":{
"description":"Country.",
"type":"string"
},
"address3":{
"description":"Address snippet.",
"type":"string"
},
"address2":{
"description":"Address snippet.",
"type":"string"
},
"city":{
"description":"City.",
"type":"string",
"example":"Cambridge"
},
"address1":{
"description":"Address snippet.",
"type":"string",
"example":"1 main st"
},
"prefix":{
"description":"Name prefix.",
"type":"string"
},
"companyName":{
"description":"Company name.",
"type":"string",
"example":"oracle"
},
"postalCode":{
"description":"Postal code.",
"type":"string",
"example":1122
},
"jobTitle":{
"description":"Job title.",
"type":"string",
"example":"manager"
},
"county":{
"description":"County.",
"type":"string"
},
"suffix":{
"description":"Name suffix.",
"type":"string"
},
"firstName":{
"description":"First name",
"type":"string",
"example":"John"
},
"phoneNumber":{
"description":"Phone number.",
"type":"string",
"example":1111111111
},
"faxNumber":{
"description":"Fax number.",
"type":"string"
},
"middleName":{
"description":"Middle name.",
"type":"string",
"example":"Morgan"
},
"state":{
"description":"State.",
"type":"string",
"example":"MA"
},
"email":{
"description":"Email address.",
"type":"string",
"example":"john.muir@oracle.com"
}
}
},
"items":{
"type":"array",
"items":{
"properties":{
"availablePickupDate":{
"description":"The items available store pickup date.",
"type":"string",
"example":"2018-05-19T13:00:00.000Z"
},
"inventoryLocationId":{
"description":"Defines the inventory location that services the referenced commerce item.",
"type":"string"
},
"rawTotalPrice":{
"description":"The raw total price.",
"type":"number",
"example":24.99
},
"returnedQuantity":{
"type":"integer",
"example":0
},
"dynamicProperties":{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string",
"example":11502
},
"label":{
"description":"The dynamic property label.",
"type":"string",
"example":"dyn_prop"
},
"value":{
"description":"The dynamic property value.",
"type":"string",
"example":12
}
}
}
},
"shippingSurchargeValue":{
"description":"Extra handling cost for shipping the product.",
"type":"number",
"example":0
},
"availabilityDate":{
"format":"date-time",
"description":"The availability date for preOrdered/backOrdered quantity.",
"type":"string",
"example":"2018-06-13T18:09:53.493Z"
},
"discountAmount":{
"description":"The monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal. (read-only)",
"type":"number",
"example":0
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a third party system.",
"type":"array",
"items":{
"properties":{
"values":{
"description":"The map values associated with an externalData item.",
"type":"object",
"properties":{
"value":{
"description":"Map value defined by external system.",
"type":"string"
},
"key":{
"description":"Map key defined by external system.",
"type":"string"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the third party system.",
"type":"string"
}
}
}
},
"preOrderQuantity":{
"description":"The pre ordered quantity included.",
"type":"integer",
"example":0
},
"childItems":{
"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"
},
"commerceItemId":{
"description":"Commerce Item ID for this commerce item.",
"type":"string",
"example":"ci123545"
},
"price":{
"type":"number",
"example":24.99
},
"childItemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding childItems property is truncated. The value for this field will be true always if present",
"type":"boolean"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean",
"example":false
},
"actionCode":{
"description":"The action code that has been set on the item by the third party system.",
"type":"string"
},
"commerceId":{
"description":"Commerce ID for this commerce item.",
"type":"string",
"example":"ci12343"
},
"stateDetailsAsUser":{
"type":"string",
"example":"details of shippingItem"
},
"unitPrice":{
"type":"number",
"example":24.99
},
"amount":{
"description":"The monetary amount.",
"type":"number",
"example":24.99
},
"quantity":{
"description":"The number of items covered by this price info",
"type":"integer",
"example":1
},
"productId":{
"description":"The ID of the product.",
"type":"string",
"example":"product_9e"
},
"salePrice":{
"description":"The sale price",
"type":"number",
"example":0
},
"detailedItemPriceInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean",
"example":false
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number",
"example":0
},
"amount":{
"type":"number",
"example":24.99
},
"quantity":{
"type":"integer",
"example":1
},
"tax":{
"type":"number",
"example":0
},
"orderDiscountShare":{
"type":"integer",
"example":0
},
"detailedUnitPrice":{
"type":"number",
"example":24.99
},
"currencyCode":{
"type":"string",
"example":"USD"
}
}
}
},
"preferredPickupDate":{
"description":"The items preferred store pickup date.",
"type":"string",
"example":"2018-05-19T13:00:00.000Z"
},
"catRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string",
"example":"Sku_9F"
},
"discountInfo":{
"description":"Whether this item is discounted.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"Promotion BAC"
},
"external":{
"description":"if promotion is external",
"type":"boolean",
"example":false
},
"coupon":{
"type":"string",
"example":"CPN123"
},
"promotionLevel":{
"type":"string",
"example":"item"
},
"totalAdjustment":{
"type":"string",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"promotion desc"
},
"promotionId":{
"type":"string",
"example":"PRM123"
},
"giftWithPurchaseDiscountInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"gitWithPurchaseDetail":{
"type":"string",
"example":"details of gift"
},
"gitWithPurchaseIdentifier":{
"type":"integer",
"example":1223344
},
"giftWithPurchaseType":{
"description":"the gift type.For example product or sku",
"type":"string",
"example":"product"
},
"promotionDesc":{
"type":"string",
"example":"GWP Promotion description"
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
}
}
}
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"backOrderQuantity":{
"description":"The back ordered quantity included.",
"type":"integer",
"example":0
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number",
"example":24.99
},
"status":{
"type":"string",
"example":"INITIAL"
}
}
}
},
"email":{
"description":"The email address of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"john.muir@oracle.com"
}
}
}
}
Nested Schema : shippingMethod
Type: object
Show Source
{
"type":"object",
"properties":{
"shippingTax":{
"type":"number",
"example":2.09
},
"cost":{
"type":"number",
"example":14.95
},
"value":{
"type":"string",
"example":"fedex-ground"
}
}
}
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",
"example":1
},
"items":{
"description":"The array of products in the shopping cart. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook",
"type":"array",
"items":{
"type":"object",
"properties":{
"primaryThumbImageURL":{
"type":"string",
"example":"/ccstore/v1/images/product.jpg"
},
"rawTotalPrice":{
"type":"number",
"example":24.99
},
"dynamicProperties":{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string",
"example":11052
},
"label":{
"description":"The dynamic property label.",
"type":"string",
"example":"dyn_size"
},
"value":{
"description":"The dynamic property value.",
"type":"string",
"example":12
}
}
}
},
"displayName":{
"type":"string",
"example":"ProductXYZ name"
},
"shippingSurchargeValue":{
"type":"integer",
"example":0
},
"description":{
"type":"string",
"example":"description of the product"
},
"discountAmount":{
"type":"number",
"example":0
},
"isItemValid":{
"type":"boolean",
"example":true
},
"externalData":{
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"type":"object",
"properties":{
"value":{
"type":"object"
},
"key":{
"type":"object"
}
}
},
"name":{
"type":"string",
"example":"externalDataName"
},
"actionCode":{
"type":"string"
}
}
}
},
"commerceItemId":{
"description":"id of the commerce item",
"type":"string",
"example":"ci20015"
},
"price":{
"type":"number",
"example":24.99
},
"variant":{
"description":"List of variants for the product.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value.",
"type":"string",
"example":"L"
},
"optionName":{
"description":"The variant option name.",
"type":"string",
"example":"size"
}
}
}
},
"childItemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding childItems property is truncated. The value for this field will be true always if present",
"type":"boolean"
},
"onSale":{
"type":"boolean",
"example":false
},
"id":{
"type":"string",
"example":"ci15000415"
},
"unitPrice":{
"type":"number",
"example":24.99
},
"amount":{
"description":"value of the commerce Item",
"type":"integer",
"example":24.99
},
"quantity":{
"type":"integer",
"example":1
},
"productId":{
"type":"string",
"example":"Product_9f"
},
"salePrice":{
"type":"number",
"example":0
},
"detailedItemPriceInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean",
"example":false
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number",
"example":0
},
"amount":{
"type":"number",
"example":24.99
},
"quantity":{
"type":"integer",
"example":1
},
"tax":{
"type":"number",
"example":0
},
"orderDiscountShare":{
"type":"integer",
"example":0
},
"detailedUnitPrice":{
"type":"number",
"example":24.99
},
"currencyCode":{
"type":"string",
"example":"USD"
}
}
}
},
"giftWithPurchaseCommerceItemMarkers":{
"type":"array",
"items":{
"type":"object",
"properties":{
"selectedQuantity":{
"type":"integer",
"example":0
},
"id":{
"type":"string",
"example":"gwp id"
}
}
}
},
"taxCode":{
"type":"string",
"example":"DV1001"
},
"catRefId":{
"type":"string",
"example":"sku_9f"
},
"skuProperties":{
"type":"array",
"items":{
"properties":{
"propertyType":{
"type":"string",
"example":"sku-base"
},
"name":{
"type":"string",
"example":"Not returnable"
},
"id":{
"type":"string",
"example":"nonreturnable"
},
"value":{
"type":"boolean",
"example":false
}
}
}
},
"discountInfo":{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"coupon":{
"description":"The coupon ID.",
"type":"string",
"example":"CPN123456"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string",
"example":"the example promotion"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string",
"example":"PRM1234"
}
}
}
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string",
"example":"siteUS"
},
"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"
},
"listPrice":{
"type":"number",
"example":24.99
}
}
}
}
}
}
Nested Schema : taxPriceInfo
Type: object
Show Source
{
"type":"object",
"properties":{
"cityTax":{
"type":"number",
"example":1.99
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number",
"example":0
},
"amount":{
"type":"number",
"example":7.99
},
"valueAddedTax":{
"type":"number",
"example":0
},
"countyTax":{
"type":"number",
"example":0
},
"isTaxIncluded":{
"type":"boolean",
"example":false
},
"miscTax":{
"type":"number",
"example":1.79
},
"districtTax":{
"type":"number",
"example":0
},
"stateTax":{
"type":"number",
"example":3.99
},
"countryTax":{
"type":"number",
"example":0
}
}
}
Nested Schema : claimedCouponMultiPromotions
Type: object
Show Source
{
"type":"object",
"properties":{
"promotions":{
"type":"array",
"items":{
"type":"object",
"properties":{
"totalAdjustment":{
"type":"integer",
"example":0
},
"secondaryCurrencyTotalAdjustment":{
"type":"integer",
"example":0
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
}
Nested Schema : orderCouponsMap
Type: 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",
"example":"<p>desc Spend 10 Get 10% Off</p>"
},
"promotionName":{
"description":"The display name of the promotion.",
"type":"string",
"example":"10% Off"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean",
"example":false
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"number",
"example":-11.1
},
"promotionDesc":{
"description":"Description of the promotion. Retained for backward compatibility.",
"type":"string",
"example":"Spend 10 Get 10% Off"
},
"promotionId":{
"description":"The Id of the promotion.",
"type":"string",
"example":"promo123"
}
}
}
}
}
Nested Schema : orderImplicitDiscountList
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"Detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PROMO1"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean",
"example":true
},
"promotionLevel":{
"description":"the level of promotion. Value can be order or item or shipping",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string",
"example":5.6
},
"promotionDesc":{
"type":"string",
"example":"the order related promotion"
},
"secondaryCurrencyTotalAdjustment":{
"description":"The total adjustment for secondary currency",
"type":"string",
"example":0
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
}
Nested Schema : unclaimedCouponMultiPromotions
Type: object
Show Source
{
"type":"object",
"properties":{
"promotionInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"long desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PRMName"
},
"promotionLevel":{
"type":"string",
"example":"order"
},
"totalAdjustment":{
"type":"integer",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"description of the promotion"
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
}
Nested Schema : unclaimedCouponsMap
Type: object
Show Source
{
"type":"object",
"properties":{
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
}
Nested Schema : promotions
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"totalAdjustment":{
"type":"integer",
"example":0
},
"secondaryCurrencyTotalAdjustment":{
"type":"integer",
"example":0
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"totalAdjustment":{
"type":"integer",
"example":0
},
"secondaryCurrencyTotalAdjustment":{
"type":"integer",
"example":0
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
Nested Schema : couponCode
Type: object
Coupon Code.
Show Source
{
"description":"Coupon Code.",
"type":"object",
"properties":{
"promotionLongDesc":{
"description":"The description of the promotion.",
"type":"string",
"example":"<p>desc Spend 10 Get 10% Off</p>"
},
"promotionName":{
"description":"The display name of the promotion.",
"type":"string",
"example":"10% Off"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean",
"example":false
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"number",
"example":-11.1
},
"promotionDesc":{
"description":"Description of the promotion. Retained for backward compatibility.",
"type":"string",
"example":"Spend 10 Get 10% Off"
},
"promotionId":{
"description":"The Id of the promotion.",
"type":"string",
"example":"promo123"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"Detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PROMO1"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean",
"example":true
},
"promotionLevel":{
"description":"the level of promotion. Value can be order or item or shipping",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string",
"example":5.6
},
"promotionDesc":{
"type":"string",
"example":"the order related promotion"
},
"secondaryCurrencyTotalAdjustment":{
"description":"The total adjustment for secondary currency",
"type":"string",
"example":0
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
Nested Schema : promotionInfo
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"long desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PRMName"
},
"promotionLevel":{
"type":"string",
"example":"order"
},
"totalAdjustment":{
"type":"integer",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"description of the promotion"
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"long desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PRMName"
},
"promotionLevel":{
"type":"string",
"example":"order"
},
"totalAdjustment":{
"type":"integer",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"description of the promotion"
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string",
"example":11502
},
"label":{
"description":"The dynamic property label.",
"type":"string",
"example":"dyn_prop"
},
"value":{
"description":"The dynamic property value.",
"type":"string",
"example":12
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"giftWithPurchaseQuantityAvailableForSelection":{
"type":"integer",
"example":2
},
"gitWithPurchaseDetail":{
"type":"string",
"example":"details of gift"
},
"gitWithPurchaseIdentifier":{
"type":"integer",
"example":1223344
},
"giftWithPurchaseType":{
"description":"the gift type.For example product or sku",
"type":"string",
"example":"product"
},
"promotionDesc":{
"type":"string",
"example":"GWP Promotion description"
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"paymentGroupId":{
"type":"string",
"example":"PYMT123"
},
"amount":{
"type":"integer",
"example":24
},
"balance":{
"type":"number",
"example":0
},
"gatewayName":{
"type":"string",
"example":"Chase"
},
"giftCardNumber":{
"type":"integer",
"example":0
},
"uiIntervention":{
"type":"string"
},
"paymentMethod":{
"type":"string",
"example":"card"
},
"isAmountRemaining":{
"type":"boolean",
"example":false
},
"paymentState":{
"type":"string",
"example":"AUTHORIZED"
},
"maskedCardNumber":{
"type":"string",
"example":1234
}
}
}
Nested Schema : frequencyAmountTotals
Type: array
The total for each recurring charge frequency
Show Source
{
"description":"The total for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string"
}
}
}
}
Nested Schema : frequencyTaxTotals
Type: array
The tax for each recurring charge frequency
Show Source
{
"description":"The tax for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"taxPriceInfo":{
"description":"The shipping address details.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"taxAmount in secondaryCurrency",
"type":"number",
"example":0
},
"cityTax":{
"description":"City Tax",
"type":"number",
"example":3.9
},
"amount":{
"description":"The total order amount.",
"type":"number",
"example":5.99
},
"valueAddedTax":{
"description":"Value Added Tax.",
"type":"number",
"example":0
},
"countyTax":{
"description":"County Tax.",
"type":"number",
"example":0
},
"isTaxIncluded":{
"description":"If Tax is included?",
"type":"boolean",
"example":false
},
"miscTax":{
"description":"Misc Tax.",
"type":"number",
"example":1.87
},
"districtTax":{
"description":"District Tax.",
"type":"number",
"example":0
},
"stateTax":{
"description":"State Tax.",
"type":"number",
"example":3.9
},
"countryTax":{
"description":"Country Tax.",
"type":"number",
"example":0
}
}
},
"lastName":{
"description":"The second name of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"Muir"
},
"itemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding items property is truncated. The value for this field will always be true if present",
"type":"boolean"
},
"shippingMethod":{
"description":"The shipping method details for the order.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"shippingTax":{
"type":"number"
},
"cost":{
"description":"The total cost of shipping.",
"type":"number"
},
"taxCode":{
"type":"string"
},
"value":{
"description":"The shipping method applied to the order.",
"type":"string"
},
"shippingMethodDescription":{
"type":"string"
}
}
},
"shippingGroupId":{
"description":"The shipping Group id",
"type":"string",
"example":"sg1234"
},
"store":{
"description":"The store is present in the request if the type is inStorePickupShippingGroup.",
"type":"object",
"properties":{
"country":{
"description":"The country of the store",
"type":"string",
"example":"USA"
},
"hours":{
"description":"The store's opening hours.",
"type":"string",
"example":"Mon - Sat 10AM - 7PM Sun 11AM - 6 PM"
},
"address3":{
"description":"Address line 3 of store.",
"type":"string",
"example":"Main Street"
},
"address2":{
"description":"Address line 2 of store.",
"type":"string",
"example":"4th Floor"
},
"city":{
"description":"The store's city.",
"type":"string",
"example":"Boston"
},
"address1":{
"description":"Address line 1 of store.",
"type":"string",
"example":"One Beacon Street"
},
"stateAddress":{
"description":"The store's state address.",
"type":"string",
"example":"MA"
},
"county":{
"description":"The store's county",
"type":"string",
"example":"MA"
},
"phoneNumber":{
"description":"The store's phone number.",
"type":"string",
"example":"(617) 386-1201"
},
"locationId":{
"description":"The store's location Id.",
"type":"string",
"example":"Boston138"
},
"name":{
"description":"The store's name.",
"type":"string",
"example":"Boston Store #138"
},
"faxNumber":{
"description":"Fax number.",
"type":"string",
"example":"(617) 386-1200"
},
"postCode":{
"description":"The store's post code.",
"type":"string",
"example":"2108"
},
"email":{
"description":"The store's email address.",
"type":"string",
"example":"store138@example.com"
}
}
},
"type":{
"description":"the shippingGroup type",
"type":"string",
"example":"inStorePickupShippingGroup"
},
"firstName":{
"description":"The first name of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"John"
},
"priceInfo":{
"description":"The price information.",
"type":"object",
"properties":{
"amount":{
"description":"The total order amount.",
"type":"number",
"example":24.99
},
"total":{
"description":"The order total.",
"type":"number",
"example":47.93
},
"lkpValExcludingFreeShip":{
"description":"The total shipping cost excluding items with free shipping.",
"type":"number",
"example":0
},
"shipping":{
"description":"The total shipping cost.",
"type":"number",
"example":14.95
},
"shippingSurchargeValue":{
"description":"Extra handling costs for shipping the products",
"type":"number",
"example":0
},
"tax":{
"description":"The total tax amount.",
"type":"number",
"example":7.99
},
"subTotal":{
"description":"Sub-total.",
"type":"number",
"example":24.99
},
"currencyCode":{
"description":"The currency code.",
"type":"string",
"example":"USD"
},
"totalWithoutTax":{
"description":"The total amount without tax.",
"type":"number",
"example":39.49
}
}
},
"phoneNumber":{
"description":"The phone number of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"1231231234"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"total":{
"description":"The total price of the recurring charge.",
"type":"number"
},
"frequencyAmountTotals":{
"description":"The total for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string"
}
}
}
},
"shipping":{
"description":"Cost of shipping the product.",
"type":"number"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"subTotal":{
"description":"The sub-total price of the recurring charge.",
"type":"number"
},
"frequencyTaxTotals":{
"description":"The tax for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string"
}
}
}
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"totalWithoutTax":{
"description":"Total of recurring amount without tax included.",
"type":"number"
}
}
},
"discountInfo":{
"description":"The discount information.",
"type":"object",
"properties":{
"unclaimedCouponMultiPromotions":{
"type":"object",
"properties":{
"promotionInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"long desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PRMName"
},
"promotionLevel":{
"type":"string",
"example":"order"
},
"totalAdjustment":{
"type":"integer",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"description of the promotion"
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
},
"orderCouponsMap":{
"description":"The coupons that were claimed.",
"type":"object",
"properties":{
"couponCode":{
"description":"Coupon Code.",
"type":"object",
"properties":{
"promotionLongDesc":{
"description":"The description of the promotion.",
"type":"string",
"example":"<p>desc Spend 10 Get 10% Off</p>"
},
"promotionName":{
"description":"The display name of the promotion.",
"type":"string",
"example":"10% Off"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean",
"example":false
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"number",
"example":-11.1
},
"promotionDesc":{
"description":"Description of the promotion. Retained for backward compatibility.",
"type":"string",
"example":"Spend 10 Get 10% Off"
},
"promotionId":{
"description":"The Id of the promotion.",
"type":"string",
"example":"promo123"
}
}
}
}
},
"orderDiscount":{
"description":"The order discount.",
"type":"number",
"example":0
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"number",
"example":5.6
},
"orderImplicitDiscountList":{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"Detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PROMO1"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean",
"example":true
},
"promotionLevel":{
"description":"promotion level - order or item",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string",
"example":5.6
},
"promotionDesc":{
"type":"string",
"example":"the order related promotion"
},
"secondaryCurrencyTotalAdjustment":{
"description":"The total adjustment for secondary currency",
"type":"string",
"example":0
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
},
"unclaimedCouponsMap":{
"type":"object",
"properties":{
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
},
"claimedCouponMultiPromotions":{
"type":"object",
"properties":{
"promotions":{
"type":"array",
"items":{
"type":"object",
"properties":{
"totalAdjustment":{
"type":"integer",
"example":0
},
"secondaryCurrencyTotalAdjustment":{
"type":"integer",
"example":0
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
}
}
},
"shippingAddress":{
"description":"The shipping address details.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name.",
"type":"string",
"example":"Muir"
},
"country":{
"description":"Country.",
"type":"string"
},
"address3":{
"description":"Address snippet.",
"type":"string"
},
"address2":{
"description":"Address snippet.",
"type":"string"
},
"city":{
"description":"City.",
"type":"string",
"example":"Cambridge"
},
"address1":{
"description":"Address snippet.",
"type":"string",
"example":"1 main st"
},
"prefix":{
"description":"Name prefix.",
"type":"string"
},
"companyName":{
"description":"Company name.",
"type":"string",
"example":"oracle"
},
"postalCode":{
"description":"Postal code.",
"type":"string",
"example":1122
},
"jobTitle":{
"description":"Job title.",
"type":"string",
"example":"manager"
},
"county":{
"description":"County.",
"type":"string"
},
"suffix":{
"description":"Name suffix.",
"type":"string"
},
"firstName":{
"description":"First name",
"type":"string",
"example":"John"
},
"phoneNumber":{
"description":"Phone number.",
"type":"string",
"example":1111111111
},
"faxNumber":{
"description":"Fax number.",
"type":"string"
},
"middleName":{
"description":"Middle name.",
"type":"string",
"example":"Morgan"
},
"state":{
"description":"State.",
"type":"string",
"example":"MA"
},
"email":{
"description":"Email address.",
"type":"string",
"example":"john.muir@oracle.com"
}
}
},
"items":{
"type":"array",
"items":{
"properties":{
"availablePickupDate":{
"description":"The items available store pickup date.",
"type":"string",
"example":"2018-05-19T13:00:00.000Z"
},
"inventoryLocationId":{
"description":"Defines the inventory location that services the referenced commerce item.",
"type":"string"
},
"rawTotalPrice":{
"description":"The raw total price.",
"type":"number",
"example":24.99
},
"returnedQuantity":{
"type":"integer",
"example":0
},
"dynamicProperties":{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string",
"example":11502
},
"label":{
"description":"The dynamic property label.",
"type":"string",
"example":"dyn_prop"
},
"value":{
"description":"The dynamic property value.",
"type":"string",
"example":12
}
}
}
},
"shippingSurchargeValue":{
"description":"Extra handling cost for shipping the product.",
"type":"number",
"example":0
},
"availabilityDate":{
"format":"date-time",
"description":"The availability date for preOrdered/backOrdered quantity.",
"type":"string",
"example":"2018-06-13T18:09:53.493Z"
},
"discountAmount":{
"description":"The monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal. (read-only)",
"type":"number",
"example":0
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a third party system.",
"type":"array",
"items":{
"properties":{
"values":{
"description":"The map values associated with an externalData item.",
"type":"object",
"properties":{
"value":{
"description":"Map value defined by external system.",
"type":"string"
},
"key":{
"description":"Map key defined by external system.",
"type":"string"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the third party system.",
"type":"string"
}
}
}
},
"preOrderQuantity":{
"description":"The pre ordered quantity included.",
"type":"integer",
"example":0
},
"childItems":{
"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"
},
"commerceItemId":{
"description":"Commerce Item ID for this commerce item.",
"type":"string",
"example":"ci123545"
},
"price":{
"type":"number",
"example":24.99
},
"childItemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding childItems property is truncated. The value for this field will be true always if present",
"type":"boolean"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean",
"example":false
},
"actionCode":{
"description":"The action code that has been set on the item by the third party system.",
"type":"string"
},
"commerceId":{
"description":"Commerce ID for this commerce item.",
"type":"string",
"example":"ci12343"
},
"stateDetailsAsUser":{
"type":"string",
"example":"details of shippingItem"
},
"unitPrice":{
"type":"number",
"example":24.99
},
"amount":{
"description":"The monetary amount.",
"type":"number",
"example":24.99
},
"quantity":{
"description":"The number of items covered by this price info",
"type":"integer",
"example":1
},
"productId":{
"description":"The ID of the product.",
"type":"string",
"example":"product_9e"
},
"salePrice":{
"description":"The sale price",
"type":"number",
"example":0
},
"detailedItemPriceInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean",
"example":false
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number",
"example":0
},
"amount":{
"type":"number",
"example":24.99
},
"quantity":{
"type":"integer",
"example":1
},
"tax":{
"type":"number",
"example":0
},
"orderDiscountShare":{
"type":"integer",
"example":0
},
"detailedUnitPrice":{
"type":"number",
"example":24.99
},
"currencyCode":{
"type":"string",
"example":"USD"
}
}
}
},
"preferredPickupDate":{
"description":"The items preferred store pickup date.",
"type":"string",
"example":"2018-05-19T13:00:00.000Z"
},
"catRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string",
"example":"Sku_9F"
},
"discountInfo":{
"description":"Whether this item is discounted.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"Promotion BAC"
},
"external":{
"description":"if promotion is external",
"type":"boolean",
"example":false
},
"coupon":{
"type":"string",
"example":"CPN123"
},
"promotionLevel":{
"type":"string",
"example":"item"
},
"totalAdjustment":{
"type":"string",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"promotion desc"
},
"promotionId":{
"type":"string",
"example":"PRM123"
},
"giftWithPurchaseDiscountInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"gitWithPurchaseDetail":{
"type":"string",
"example":"details of gift"
},
"gitWithPurchaseIdentifier":{
"type":"integer",
"example":1223344
},
"giftWithPurchaseType":{
"description":"the gift type.For example product or sku",
"type":"string",
"example":"product"
},
"promotionDesc":{
"type":"string",
"example":"GWP Promotion description"
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
}
}
}
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"backOrderQuantity":{
"description":"The back ordered quantity included.",
"type":"integer",
"example":0
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number",
"example":24.99
},
"status":{
"type":"string",
"example":"INITIAL"
}
}
}
},
"email":{
"description":"The email address of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"john.muir@oracle.com"
}
}
}
Nested Schema : discountInfo
Type: object
The discount information.
Show Source
{
"description":"The discount information.",
"type":"object",
"properties":{
"unclaimedCouponMultiPromotions":{
"type":"object",
"properties":{
"promotionInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"long desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PRMName"
},
"promotionLevel":{
"type":"string",
"example":"order"
},
"totalAdjustment":{
"type":"integer",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"description of the promotion"
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
},
"orderCouponsMap":{
"description":"The coupons that were claimed.",
"type":"object",
"properties":{
"couponCode":{
"description":"Coupon Code.",
"type":"object",
"properties":{
"promotionLongDesc":{
"description":"The description of the promotion.",
"type":"string",
"example":"<p>desc Spend 10 Get 10% Off</p>"
},
"promotionName":{
"description":"The display name of the promotion.",
"type":"string",
"example":"10% Off"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean",
"example":false
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"number",
"example":-11.1
},
"promotionDesc":{
"description":"Description of the promotion. Retained for backward compatibility.",
"type":"string",
"example":"Spend 10 Get 10% Off"
},
"promotionId":{
"description":"The Id of the promotion.",
"type":"string",
"example":"promo123"
}
}
}
}
},
"orderDiscount":{
"description":"The order discount.",
"type":"number",
"example":0
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"number",
"example":5.6
},
"orderImplicitDiscountList":{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"Detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PROMO1"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean",
"example":true
},
"promotionLevel":{
"description":"promotion level - order or item",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string",
"example":5.6
},
"promotionDesc":{
"type":"string",
"example":"the order related promotion"
},
"secondaryCurrencyTotalAdjustment":{
"description":"The total adjustment for secondary currency",
"type":"string",
"example":0
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
},
"unclaimedCouponsMap":{
"type":"object",
"properties":{
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
},
"claimedCouponMultiPromotions":{
"type":"object",
"properties":{
"promotions":{
"type":"array",
"items":{
"type":"object",
"properties":{
"totalAdjustment":{
"type":"integer",
"example":0
},
"secondaryCurrencyTotalAdjustment":{
"type":"integer",
"example":0
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
}
}
}
Nested Schema : items
Type: array
Show Source
{
"type":"array",
"items":{
"properties":{
"availablePickupDate":{
"description":"The items available store pickup date.",
"type":"string",
"example":"2018-05-19T13:00:00.000Z"
},
"inventoryLocationId":{
"description":"Defines the inventory location that services the referenced commerce item.",
"type":"string"
},
"rawTotalPrice":{
"description":"The raw total price.",
"type":"number",
"example":24.99
},
"returnedQuantity":{
"type":"integer",
"example":0
},
"dynamicProperties":{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string",
"example":11502
},
"label":{
"description":"The dynamic property label.",
"type":"string",
"example":"dyn_prop"
},
"value":{
"description":"The dynamic property value.",
"type":"string",
"example":12
}
}
}
},
"shippingSurchargeValue":{
"description":"Extra handling cost for shipping the product.",
"type":"number",
"example":0
},
"availabilityDate":{
"format":"date-time",
"description":"The availability date for preOrdered/backOrdered quantity.",
"type":"string",
"example":"2018-06-13T18:09:53.493Z"
},
"discountAmount":{
"description":"The monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal. (read-only)",
"type":"number",
"example":0
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a third party system.",
"type":"array",
"items":{
"properties":{
"values":{
"description":"The map values associated with an externalData item.",
"type":"object",
"properties":{
"value":{
"description":"Map value defined by external system.",
"type":"string"
},
"key":{
"description":"Map key defined by external system.",
"type":"string"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the third party system.",
"type":"string"
}
}
}
},
"preOrderQuantity":{
"description":"The pre ordered quantity included.",
"type":"integer",
"example":0
},
"childItems":{
"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"
},
"commerceItemId":{
"description":"Commerce Item ID for this commerce item.",
"type":"string",
"example":"ci123545"
},
"price":{
"type":"number",
"example":24.99
},
"childItemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding childItems property is truncated. The value for this field will be true always if present",
"type":"boolean"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean",
"example":false
},
"actionCode":{
"description":"The action code that has been set on the item by the third party system.",
"type":"string"
},
"commerceId":{
"description":"Commerce ID for this commerce item.",
"type":"string",
"example":"ci12343"
},
"stateDetailsAsUser":{
"type":"string",
"example":"details of shippingItem"
},
"unitPrice":{
"type":"number",
"example":24.99
},
"amount":{
"description":"The monetary amount.",
"type":"number",
"example":24.99
},
"quantity":{
"description":"The number of items covered by this price info",
"type":"integer",
"example":1
},
"productId":{
"description":"The ID of the product.",
"type":"string",
"example":"product_9e"
},
"salePrice":{
"description":"The sale price",
"type":"number",
"example":0
},
"detailedItemPriceInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean",
"example":false
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number",
"example":0
},
"amount":{
"type":"number",
"example":24.99
},
"quantity":{
"type":"integer",
"example":1
},
"tax":{
"type":"number",
"example":0
},
"orderDiscountShare":{
"type":"integer",
"example":0
},
"detailedUnitPrice":{
"type":"number",
"example":24.99
},
"currencyCode":{
"type":"string",
"example":"USD"
}
}
}
},
"preferredPickupDate":{
"description":"The items preferred store pickup date.",
"type":"string",
"example":"2018-05-19T13:00:00.000Z"
},
"catRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string",
"example":"Sku_9F"
},
"discountInfo":{
"description":"Whether this item is discounted.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"Promotion BAC"
},
"external":{
"description":"if promotion is external",
"type":"boolean",
"example":false
},
"coupon":{
"type":"string",
"example":"CPN123"
},
"promotionLevel":{
"type":"string",
"example":"item"
},
"totalAdjustment":{
"type":"string",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"promotion desc"
},
"promotionId":{
"type":"string",
"example":"PRM123"
},
"giftWithPurchaseDiscountInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"gitWithPurchaseDetail":{
"type":"string",
"example":"details of gift"
},
"gitWithPurchaseIdentifier":{
"type":"integer",
"example":1223344
},
"giftWithPurchaseType":{
"description":"the gift type.For example product or sku",
"type":"string",
"example":"product"
},
"promotionDesc":{
"type":"string",
"example":"GWP Promotion description"
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
}
}
}
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"backOrderQuantity":{
"description":"The back ordered quantity included.",
"type":"integer",
"example":0
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number",
"example":24.99
},
"status":{
"type":"string",
"example":"INITIAL"
}
}
}
}
Nested Schema : priceInfo
Type: object
The price information.
Show Source
{
"description":"The price information.",
"type":"object",
"properties":{
"amount":{
"description":"The total order amount.",
"type":"number",
"example":24.99
},
"total":{
"description":"The order total.",
"type":"number",
"example":47.93
},
"lkpValExcludingFreeShip":{
"description":"The total shipping cost excluding items with free shipping.",
"type":"number",
"example":0
},
"shipping":{
"description":"The total shipping cost.",
"type":"number",
"example":14.95
},
"shippingSurchargeValue":{
"description":"Extra handling costs for shipping the products",
"type":"number",
"example":0
},
"tax":{
"description":"The total tax amount.",
"type":"number",
"example":7.99
},
"subTotal":{
"description":"Sub-total.",
"type":"number",
"example":24.99
},
"currencyCode":{
"description":"The currency code.",
"type":"string",
"example":"USD"
},
"totalWithoutTax":{
"description":"The total amount without tax.",
"type":"number",
"example":39.49
}
}
}
Nested Schema : recurringChargePriceInfo
Type: object
Recurring charge price information.
Show Source
{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"total":{
"description":"The total price of the recurring charge.",
"type":"number"
},
"frequencyAmountTotals":{
"description":"The total for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string"
}
}
}
},
"shipping":{
"description":"Cost of shipping the product.",
"type":"number"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"subTotal":{
"description":"The sub-total price of the recurring charge.",
"type":"number"
},
"frequencyTaxTotals":{
"description":"The tax for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string"
}
}
}
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"totalWithoutTax":{
"description":"Total of recurring amount without tax included.",
"type":"number"
}
}
}
Nested Schema : shippingAddress
Type: object
The shipping address details.
Show Source
{
"description":"The shipping address details.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name.",
"type":"string",
"example":"Muir"
},
"country":{
"description":"Country.",
"type":"string"
},
"address3":{
"description":"Address snippet.",
"type":"string"
},
"address2":{
"description":"Address snippet.",
"type":"string"
},
"city":{
"description":"City.",
"type":"string",
"example":"Cambridge"
},
"address1":{
"description":"Address snippet.",
"type":"string",
"example":"1 main st"
},
"prefix":{
"description":"Name prefix.",
"type":"string"
},
"companyName":{
"description":"Company name.",
"type":"string",
"example":"oracle"
},
"postalCode":{
"description":"Postal code.",
"type":"string",
"example":1122
},
"jobTitle":{
"description":"Job title.",
"type":"string",
"example":"manager"
},
"county":{
"description":"County.",
"type":"string"
},
"suffix":{
"description":"Name suffix.",
"type":"string"
},
"firstName":{
"description":"First name",
"type":"string",
"example":"John"
},
"phoneNumber":{
"description":"Phone number.",
"type":"string",
"example":1111111111
},
"faxNumber":{
"description":"Fax number.",
"type":"string"
},
"middleName":{
"description":"Middle name.",
"type":"string",
"example":"Morgan"
},
"state":{
"description":"State.",
"type":"string",
"example":"MA"
},
"email":{
"description":"Email address.",
"type":"string",
"example":"john.muir@oracle.com"
}
}
}
Nested Schema : shippingMethod
Type: object
The shipping method details for the order.
Show Source
{
"description":"The shipping method details for the order.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"shippingTax":{
"type":"number"
},
"cost":{
"description":"The total cost of shipping.",
"type":"number"
},
"taxCode":{
"type":"string"
},
"value":{
"description":"The shipping method applied to the order.",
"type":"string"
},
"shippingMethodDescription":{
"type":"string"
}
}
}
Nested Schema : store
Type: object
The store is present in the request if the type is inStorePickupShippingGroup.
Show Source
{
"description":"The store is present in the request if the type is inStorePickupShippingGroup.",
"type":"object",
"properties":{
"country":{
"description":"The country of the store",
"type":"string",
"example":"USA"
},
"hours":{
"description":"The store's opening hours.",
"type":"string",
"example":"Mon - Sat 10AM - 7PM Sun 11AM - 6 PM"
},
"address3":{
"description":"Address line 3 of store.",
"type":"string",
"example":"Main Street"
},
"address2":{
"description":"Address line 2 of store.",
"type":"string",
"example":"4th Floor"
},
"city":{
"description":"The store's city.",
"type":"string",
"example":"Boston"
},
"address1":{
"description":"Address line 1 of store.",
"type":"string",
"example":"One Beacon Street"
},
"stateAddress":{
"description":"The store's state address.",
"type":"string",
"example":"MA"
},
"county":{
"description":"The store's county",
"type":"string",
"example":"MA"
},
"phoneNumber":{
"description":"The store's phone number.",
"type":"string",
"example":"(617) 386-1201"
},
"locationId":{
"description":"The store's location Id.",
"type":"string",
"example":"Boston138"
},
"name":{
"description":"The store's name.",
"type":"string",
"example":"Boston Store #138"
},
"faxNumber":{
"description":"Fax number.",
"type":"string",
"example":"(617) 386-1200"
},
"postCode":{
"description":"The store's post code.",
"type":"string",
"example":"2108"
},
"email":{
"description":"The store's email address.",
"type":"string",
"example":"store138@example.com"
}
}
}
Nested Schema : taxPriceInfo
Type: object
The shipping address details.
Show Source
{
"description":"The shipping address details.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"taxAmount in secondaryCurrency",
"type":"number",
"example":0
},
"cityTax":{
"description":"City Tax",
"type":"number",
"example":3.9
},
"amount":{
"description":"The total order amount.",
"type":"number",
"example":5.99
},
"valueAddedTax":{
"description":"Value Added Tax.",
"type":"number",
"example":0
},
"countyTax":{
"description":"County Tax.",
"type":"number",
"example":0
},
"isTaxIncluded":{
"description":"If Tax is included?",
"type":"boolean",
"example":false
},
"miscTax":{
"description":"Misc Tax.",
"type":"number",
"example":1.87
},
"districtTax":{
"description":"District Tax.",
"type":"number",
"example":0
},
"stateTax":{
"description":"State Tax.",
"type":"number",
"example":3.9
},
"countryTax":{
"description":"Country Tax.",
"type":"number",
"example":0
}
}
}
Nested Schema : claimedCouponMultiPromotions
Type: object
Show Source
{
"type":"object",
"properties":{
"promotions":{
"type":"array",
"items":{
"type":"object",
"properties":{
"totalAdjustment":{
"type":"integer",
"example":0
},
"secondaryCurrencyTotalAdjustment":{
"type":"integer",
"example":0
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
}
Nested Schema : orderCouponsMap
Type: 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",
"example":"<p>desc Spend 10 Get 10% Off</p>"
},
"promotionName":{
"description":"The display name of the promotion.",
"type":"string",
"example":"10% Off"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean",
"example":false
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"number",
"example":-11.1
},
"promotionDesc":{
"description":"Description of the promotion. Retained for backward compatibility.",
"type":"string",
"example":"Spend 10 Get 10% Off"
},
"promotionId":{
"description":"The Id of the promotion.",
"type":"string",
"example":"promo123"
}
}
}
}
}
Nested Schema : orderImplicitDiscountList
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"Detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PROMO1"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean",
"example":true
},
"promotionLevel":{
"description":"promotion level - order or item",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string",
"example":5.6
},
"promotionDesc":{
"type":"string",
"example":"the order related promotion"
},
"secondaryCurrencyTotalAdjustment":{
"description":"The total adjustment for secondary currency",
"type":"string",
"example":0
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
}
Nested Schema : unclaimedCouponMultiPromotions
Type: object
Show Source
{
"type":"object",
"properties":{
"promotionInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"long desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PRMName"
},
"promotionLevel":{
"type":"string",
"example":"order"
},
"totalAdjustment":{
"type":"integer",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"description of the promotion"
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
}
Nested Schema : unclaimedCouponsMap
Type: object
Show Source
{
"type":"object",
"properties":{
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
}
Nested Schema : promotions
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"totalAdjustment":{
"type":"integer",
"example":0
},
"secondaryCurrencyTotalAdjustment":{
"type":"integer",
"example":0
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"totalAdjustment":{
"type":"integer",
"example":0
},
"secondaryCurrencyTotalAdjustment":{
"type":"integer",
"example":0
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
Nested Schema : couponCode
Type: object
Coupon Code.
Show Source
{
"description":"Coupon Code.",
"type":"object",
"properties":{
"promotionLongDesc":{
"description":"The description of the promotion.",
"type":"string",
"example":"<p>desc Spend 10 Get 10% Off</p>"
},
"promotionName":{
"description":"The display name of the promotion.",
"type":"string",
"example":"10% Off"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean",
"example":false
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"number",
"example":-11.1
},
"promotionDesc":{
"description":"Description of the promotion. Retained for backward compatibility.",
"type":"string",
"example":"Spend 10 Get 10% Off"
},
"promotionId":{
"description":"The Id of the promotion.",
"type":"string",
"example":"promo123"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"Detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PROMO1"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean",
"example":true
},
"promotionLevel":{
"description":"promotion level - order or item",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string",
"example":5.6
},
"promotionDesc":{
"type":"string",
"example":"the order related promotion"
},
"secondaryCurrencyTotalAdjustment":{
"description":"The total adjustment for secondary currency",
"type":"string",
"example":0
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
Nested Schema : promotionInfo
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"long desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PRMName"
},
"promotionLevel":{
"type":"string",
"example":"order"
},
"totalAdjustment":{
"type":"integer",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"description of the promotion"
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"long desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PRMName"
},
"promotionLevel":{
"type":"string",
"example":"order"
},
"totalAdjustment":{
"type":"integer",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"description of the promotion"
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"properties":{
"availablePickupDate":{
"description":"The items available store pickup date.",
"type":"string",
"example":"2018-05-19T13:00:00.000Z"
},
"inventoryLocationId":{
"description":"Defines the inventory location that services the referenced commerce item.",
"type":"string"
},
"rawTotalPrice":{
"description":"The raw total price.",
"type":"number",
"example":24.99
},
"returnedQuantity":{
"type":"integer",
"example":0
},
"dynamicProperties":{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string",
"example":11502
},
"label":{
"description":"The dynamic property label.",
"type":"string",
"example":"dyn_prop"
},
"value":{
"description":"The dynamic property value.",
"type":"string",
"example":12
}
}
}
},
"shippingSurchargeValue":{
"description":"Extra handling cost for shipping the product.",
"type":"number",
"example":0
},
"availabilityDate":{
"format":"date-time",
"description":"The availability date for preOrdered/backOrdered quantity.",
"type":"string",
"example":"2018-06-13T18:09:53.493Z"
},
"discountAmount":{
"description":"The monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal. (read-only)",
"type":"number",
"example":0
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a third party system.",
"type":"array",
"items":{
"properties":{
"values":{
"description":"The map values associated with an externalData item.",
"type":"object",
"properties":{
"value":{
"description":"Map value defined by external system.",
"type":"string"
},
"key":{
"description":"Map key defined by external system.",
"type":"string"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the third party system.",
"type":"string"
}
}
}
},
"preOrderQuantity":{
"description":"The pre ordered quantity included.",
"type":"integer",
"example":0
},
"childItems":{
"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"
},
"commerceItemId":{
"description":"Commerce Item ID for this commerce item.",
"type":"string",
"example":"ci123545"
},
"price":{
"type":"number",
"example":24.99
},
"childItemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding childItems property is truncated. The value for this field will be true always if present",
"type":"boolean"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean",
"example":false
},
"actionCode":{
"description":"The action code that has been set on the item by the third party system.",
"type":"string"
},
"commerceId":{
"description":"Commerce ID for this commerce item.",
"type":"string",
"example":"ci12343"
},
"stateDetailsAsUser":{
"type":"string",
"example":"details of shippingItem"
},
"unitPrice":{
"type":"number",
"example":24.99
},
"amount":{
"description":"The monetary amount.",
"type":"number",
"example":24.99
},
"quantity":{
"description":"The number of items covered by this price info",
"type":"integer",
"example":1
},
"productId":{
"description":"The ID of the product.",
"type":"string",
"example":"product_9e"
},
"salePrice":{
"description":"The sale price",
"type":"number",
"example":0
},
"detailedItemPriceInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean",
"example":false
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number",
"example":0
},
"amount":{
"type":"number",
"example":24.99
},
"quantity":{
"type":"integer",
"example":1
},
"tax":{
"type":"number",
"example":0
},
"orderDiscountShare":{
"type":"integer",
"example":0
},
"detailedUnitPrice":{
"type":"number",
"example":24.99
},
"currencyCode":{
"type":"string",
"example":"USD"
}
}
}
},
"preferredPickupDate":{
"description":"The items preferred store pickup date.",
"type":"string",
"example":"2018-05-19T13:00:00.000Z"
},
"catRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string",
"example":"Sku_9F"
},
"discountInfo":{
"description":"Whether this item is discounted.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"Promotion BAC"
},
"external":{
"description":"if promotion is external",
"type":"boolean",
"example":false
},
"coupon":{
"type":"string",
"example":"CPN123"
},
"promotionLevel":{
"type":"string",
"example":"item"
},
"totalAdjustment":{
"type":"string",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"promotion desc"
},
"promotionId":{
"type":"string",
"example":"PRM123"
},
"giftWithPurchaseDiscountInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"gitWithPurchaseDetail":{
"type":"string",
"example":"details of gift"
},
"gitWithPurchaseIdentifier":{
"type":"integer",
"example":1223344
},
"giftWithPurchaseType":{
"description":"the gift type.For example product or sku",
"type":"string",
"example":"product"
},
"promotionDesc":{
"type":"string",
"example":"GWP Promotion description"
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
}
}
}
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"backOrderQuantity":{
"description":"The back ordered quantity included.",
"type":"integer",
"example":0
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number",
"example":24.99
},
"status":{
"type":"string",
"example":"INITIAL"
}
}
}
Nested Schema : childItems
Type: array
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",
"example":false
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number",
"example":0
},
"amount":{
"type":"number",
"example":24.99
},
"quantity":{
"type":"integer",
"example":1
},
"tax":{
"type":"number",
"example":0
},
"orderDiscountShare":{
"type":"integer",
"example":0
},
"detailedUnitPrice":{
"type":"number",
"example":24.99
},
"currencyCode":{
"type":"string",
"example":"USD"
}
}
}
}
Nested Schema : detailedRecurringChargeInfo
Type: object
Detailed Item Price Information.
Show Source
{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
Nested Schema : discountInfo
Type: array
Whether this item is discounted.
Show Source
{
"description":"Whether this item is discounted.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"Promotion BAC"
},
"external":{
"description":"if promotion is external",
"type":"boolean",
"example":false
},
"coupon":{
"type":"string",
"example":"CPN123"
},
"promotionLevel":{
"type":"string",
"example":"item"
},
"totalAdjustment":{
"type":"string",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"promotion desc"
},
"promotionId":{
"type":"string",
"example":"PRM123"
},
"giftWithPurchaseDiscountInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"gitWithPurchaseDetail":{
"type":"string",
"example":"details of gift"
},
"gitWithPurchaseIdentifier":{
"type":"integer",
"example":1223344
},
"giftWithPurchaseType":{
"description":"the gift type.For example product or sku",
"type":"string",
"example":"product"
},
"promotionDesc":{
"type":"string",
"example":"GWP Promotion description"
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
}
}
}
}
Nested Schema : dynamicProperties
Type: array
List of dynamic properties at line item level.
Show Source
{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string",
"example":11502
},
"label":{
"description":"The dynamic property label.",
"type":"string",
"example":"dyn_prop"
},
"value":{
"description":"The dynamic property value.",
"type":"string",
"example":12
}
}
}
}
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a third party system.
Show Source
{
"description":"External data to be associated with a commerce item, provided by a third party system.",
"type":"array",
"items":{
"properties":{
"values":{
"description":"The map values associated with an externalData item.",
"type":"object",
"properties":{
"value":{
"description":"Map value defined by external system.",
"type":"string"
},
"key":{
"description":"Map key defined by external system.",
"type":"string"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the third party system.",
"type":"string"
}
}
}
}
Nested Schema : shopperInput
Type: object
Additional Properties Allowed
Show Source
{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
}
Map of shopper input keys to values
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"discounted":{
"type":"boolean",
"example":false
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number",
"example":0
},
"amount":{
"type":"number",
"example":24.99
},
"quantity":{
"type":"integer",
"example":1
},
"tax":{
"type":"number",
"example":0
},
"orderDiscountShare":{
"type":"integer",
"example":0
},
"detailedUnitPrice":{
"type":"number",
"example":24.99
},
"currencyCode":{
"type":"string",
"example":"USD"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"Promotion BAC"
},
"external":{
"description":"if promotion is external",
"type":"boolean",
"example":false
},
"coupon":{
"type":"string",
"example":"CPN123"
},
"promotionLevel":{
"type":"string",
"example":"item"
},
"totalAdjustment":{
"type":"string",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"promotion desc"
},
"promotionId":{
"type":"string",
"example":"PRM123"
},
"giftWithPurchaseDiscountInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"gitWithPurchaseDetail":{
"type":"string",
"example":"details of gift"
},
"gitWithPurchaseIdentifier":{
"type":"integer",
"example":1223344
},
"giftWithPurchaseType":{
"description":"the gift type.For example product or sku",
"type":"string",
"example":"product"
},
"promotionDesc":{
"type":"string",
"example":"GWP Promotion description"
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
}
}
}
Nested Schema : giftWithPurchaseDiscountInfo
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"gitWithPurchaseDetail":{
"type":"string",
"example":"details of gift"
},
"gitWithPurchaseIdentifier":{
"type":"integer",
"example":1223344
},
"giftWithPurchaseType":{
"description":"the gift type.For example product or sku",
"type":"string",
"example":"product"
},
"promotionDesc":{
"type":"string",
"example":"GWP Promotion description"
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"gitWithPurchaseDetail":{
"type":"string",
"example":"details of gift"
},
"gitWithPurchaseIdentifier":{
"type":"integer",
"example":1223344
},
"giftWithPurchaseType":{
"description":"the gift type.For example product or sku",
"type":"string",
"example":"product"
},
"promotionDesc":{
"type":"string",
"example":"GWP Promotion description"
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string",
"example":11502
},
"label":{
"description":"The dynamic property label.",
"type":"string",
"example":"dyn_prop"
},
"value":{
"description":"The dynamic property value.",
"type":"string",
"example":12
}
}
}
Nested Schema : items
Type: object
Show Source
{
"properties":{
"values":{
"description":"The map values associated with an externalData item.",
"type":"object",
"properties":{
"value":{
"description":"Map value defined by external system.",
"type":"string"
},
"key":{
"description":"Map key defined by external system.",
"type":"string"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the third party system.",
"type":"string"
}
}
}
Nested Schema : values
Type: object
The map values associated with an externalData item.
Show Source
{
"description":"The map values associated with an externalData item.",
"type":"object",
"properties":{
"value":{
"description":"Map value defined by external system.",
"type":"string"
},
"key":{
"description":"Map key defined by external system.",
"type":"string"
}
}
}
Nested Schema : frequencyAmountTotals
Type: array
The total for each recurring charge frequency
Show Source
{
"description":"The total for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string"
}
}
}
}
Nested Schema : frequencyTaxTotals
Type: array
The tax for each recurring charge frequency
Show Source
{
"description":"The tax for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string"
}
}
}
Nested Schema : items
Type: array
The array of products in the shopping cart. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook
Show Source
{
"description":"The array of products in the shopping cart. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook",
"type":"array",
"items":{
"type":"object",
"properties":{
"primaryThumbImageURL":{
"type":"string",
"example":"/ccstore/v1/images/product.jpg"
},
"rawTotalPrice":{
"type":"number",
"example":24.99
},
"dynamicProperties":{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string",
"example":11052
},
"label":{
"description":"The dynamic property label.",
"type":"string",
"example":"dyn_size"
},
"value":{
"description":"The dynamic property value.",
"type":"string",
"example":12
}
}
}
},
"displayName":{
"type":"string",
"example":"ProductXYZ name"
},
"shippingSurchargeValue":{
"type":"integer",
"example":0
},
"description":{
"type":"string",
"example":"description of the product"
},
"discountAmount":{
"type":"number",
"example":0
},
"isItemValid":{
"type":"boolean",
"example":true
},
"externalData":{
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"type":"object",
"properties":{
"value":{
"type":"object"
},
"key":{
"type":"object"
}
}
},
"name":{
"type":"string",
"example":"externalDataName"
},
"actionCode":{
"type":"string"
}
}
}
},
"commerceItemId":{
"description":"id of the commerce item",
"type":"string",
"example":"ci20015"
},
"price":{
"type":"number",
"example":24.99
},
"variant":{
"description":"List of variants for the product.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value.",
"type":"string",
"example":"L"
},
"optionName":{
"description":"The variant option name.",
"type":"string",
"example":"size"
}
}
}
},
"childItemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding childItems property is truncated. The value for this field will be true always if present",
"type":"boolean"
},
"onSale":{
"type":"boolean",
"example":false
},
"id":{
"type":"string",
"example":"ci15000415"
},
"unitPrice":{
"type":"number",
"example":24.99
},
"amount":{
"description":"value of the commerce Item",
"type":"integer",
"example":24.99
},
"quantity":{
"type":"integer",
"example":1
},
"productId":{
"type":"string",
"example":"Product_9f"
},
"salePrice":{
"type":"number",
"example":0
},
"detailedItemPriceInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean",
"example":false
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number",
"example":0
},
"amount":{
"type":"number",
"example":24.99
},
"quantity":{
"type":"integer",
"example":1
},
"tax":{
"type":"number",
"example":0
},
"orderDiscountShare":{
"type":"integer",
"example":0
},
"detailedUnitPrice":{
"type":"number",
"example":24.99
},
"currencyCode":{
"type":"string",
"example":"USD"
}
}
}
},
"giftWithPurchaseCommerceItemMarkers":{
"type":"array",
"items":{
"type":"object",
"properties":{
"selectedQuantity":{
"type":"integer",
"example":0
},
"id":{
"type":"string",
"example":"gwp id"
}
}
}
},
"taxCode":{
"type":"string",
"example":"DV1001"
},
"catRefId":{
"type":"string",
"example":"sku_9f"
},
"skuProperties":{
"type":"array",
"items":{
"properties":{
"propertyType":{
"type":"string",
"example":"sku-base"
},
"name":{
"type":"string",
"example":"Not returnable"
},
"id":{
"type":"string",
"example":"nonreturnable"
},
"value":{
"type":"boolean",
"example":false
}
}
}
},
"discountInfo":{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"coupon":{
"description":"The coupon ID.",
"type":"string",
"example":"CPN123456"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string",
"example":"the example promotion"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string",
"example":"PRM1234"
}
}
}
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string",
"example":"siteUS"
},
"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"
},
"listPrice":{
"type":"number",
"example":24.99
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"primaryThumbImageURL":{
"type":"string",
"example":"/ccstore/v1/images/product.jpg"
},
"rawTotalPrice":{
"type":"number",
"example":24.99
},
"dynamicProperties":{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string",
"example":11052
},
"label":{
"description":"The dynamic property label.",
"type":"string",
"example":"dyn_size"
},
"value":{
"description":"The dynamic property value.",
"type":"string",
"example":12
}
}
}
},
"displayName":{
"type":"string",
"example":"ProductXYZ name"
},
"shippingSurchargeValue":{
"type":"integer",
"example":0
},
"description":{
"type":"string",
"example":"description of the product"
},
"discountAmount":{
"type":"number",
"example":0
},
"isItemValid":{
"type":"boolean",
"example":true
},
"externalData":{
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"type":"object",
"properties":{
"value":{
"type":"object"
},
"key":{
"type":"object"
}
}
},
"name":{
"type":"string",
"example":"externalDataName"
},
"actionCode":{
"type":"string"
}
}
}
},
"commerceItemId":{
"description":"id of the commerce item",
"type":"string",
"example":"ci20015"
},
"price":{
"type":"number",
"example":24.99
},
"variant":{
"description":"List of variants for the product.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value.",
"type":"string",
"example":"L"
},
"optionName":{
"description":"The variant option name.",
"type":"string",
"example":"size"
}
}
}
},
"childItemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding childItems property is truncated. The value for this field will be true always if present",
"type":"boolean"
},
"onSale":{
"type":"boolean",
"example":false
},
"id":{
"type":"string",
"example":"ci15000415"
},
"unitPrice":{
"type":"number",
"example":24.99
},
"amount":{
"description":"value of the commerce Item",
"type":"integer",
"example":24.99
},
"quantity":{
"type":"integer",
"example":1
},
"productId":{
"type":"string",
"example":"Product_9f"
},
"salePrice":{
"type":"number",
"example":0
},
"detailedItemPriceInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean",
"example":false
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number",
"example":0
},
"amount":{
"type":"number",
"example":24.99
},
"quantity":{
"type":"integer",
"example":1
},
"tax":{
"type":"number",
"example":0
},
"orderDiscountShare":{
"type":"integer",
"example":0
},
"detailedUnitPrice":{
"type":"number",
"example":24.99
},
"currencyCode":{
"type":"string",
"example":"USD"
}
}
}
},
"giftWithPurchaseCommerceItemMarkers":{
"type":"array",
"items":{
"type":"object",
"properties":{
"selectedQuantity":{
"type":"integer",
"example":0
},
"id":{
"type":"string",
"example":"gwp id"
}
}
}
},
"taxCode":{
"type":"string",
"example":"DV1001"
},
"catRefId":{
"type":"string",
"example":"sku_9f"
},
"skuProperties":{
"type":"array",
"items":{
"properties":{
"propertyType":{
"type":"string",
"example":"sku-base"
},
"name":{
"type":"string",
"example":"Not returnable"
},
"id":{
"type":"string",
"example":"nonreturnable"
},
"value":{
"type":"boolean",
"example":false
}
}
}
},
"discountInfo":{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"coupon":{
"description":"The coupon ID.",
"type":"string",
"example":"CPN123456"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string",
"example":"the example promotion"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string",
"example":"PRM1234"
}
}
}
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string",
"example":"siteUS"
},
"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"
},
"listPrice":{
"type":"number",
"example":24.99
}
}
}
Nested Schema : detailedItemPriceInfo
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean",
"example":false
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number",
"example":0
},
"amount":{
"type":"number",
"example":24.99
},
"quantity":{
"type":"integer",
"example":1
},
"tax":{
"type":"number",
"example":0
},
"orderDiscountShare":{
"type":"integer",
"example":0
},
"detailedUnitPrice":{
"type":"number",
"example":24.99
},
"currencyCode":{
"type":"string",
"example":"USD"
}
}
}
}
Nested Schema : detailedRecurringChargeInfo
Type: object
Detailed Item Price Information.
Show Source
{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
Nested Schema : discountInfo
Type: array
The discount information.
Show Source
{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"coupon":{
"description":"The coupon ID.",
"type":"string",
"example":"CPN123456"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string",
"example":"the example promotion"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string",
"example":"PRM1234"
}
}
}
}
Nested Schema : dynamicProperties
Type: array
List of dynamic properties at line item level.
Show Source
{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string",
"example":11052
},
"label":{
"description":"The dynamic property label.",
"type":"string",
"example":"dyn_size"
},
"value":{
"description":"The dynamic property value.",
"type":"string",
"example":12
}
}
}
}
Nested Schema : externalData
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"type":"object",
"properties":{
"value":{
"type":"object"
},
"key":{
"type":"object"
}
}
},
"name":{
"type":"string",
"example":"externalDataName"
},
"actionCode":{
"type":"string"
}
}
}
}
Nested Schema : giftWithPurchaseCommerceItemMarkers
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"selectedQuantity":{
"type":"integer",
"example":0
},
"id":{
"type":"string",
"example":"gwp id"
}
}
}
}
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 : skuProperties
Type: array
Show Source
{
"type":"array",
"items":{
"properties":{
"propertyType":{
"type":"string",
"example":"sku-base"
},
"name":{
"type":"string",
"example":"Not returnable"
},
"id":{
"type":"string",
"example":"nonreturnable"
},
"value":{
"type":"boolean",
"example":false
}
}
}
}
Nested Schema : variant
Type: array
List of variants for the product.
Show Source
{
"description":"List of variants for the product.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value.",
"type":"string",
"example":"L"
},
"optionName":{
"description":"The variant option name.",
"type":"string",
"example":"size"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"discounted":{
"type":"boolean",
"example":false
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number",
"example":0
},
"amount":{
"type":"number",
"example":24.99
},
"quantity":{
"type":"integer",
"example":1
},
"tax":{
"type":"number",
"example":0
},
"orderDiscountShare":{
"type":"integer",
"example":0
},
"detailedUnitPrice":{
"type":"number",
"example":24.99
},
"currencyCode":{
"type":"string",
"example":"USD"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"coupon":{
"description":"The coupon ID.",
"type":"string",
"example":"CPN123456"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string",
"example":"the example promotion"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string",
"example":"PRM1234"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string",
"example":11052
},
"label":{
"description":"The dynamic property label.",
"type":"string",
"example":"dyn_size"
},
"value":{
"description":"The dynamic property value.",
"type":"string",
"example":12
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"values":{
"type":"object",
"properties":{
"value":{
"type":"object"
},
"key":{
"type":"object"
}
}
},
"name":{
"type":"string",
"example":"externalDataName"
},
"actionCode":{
"type":"string"
}
}
}
Nested Schema : values
Type: object
Show Source
{
"type":"object",
"properties":{
"value":{
"type":"object"
},
"key":{
"type":"object"
}
}
}
Nested Schema : key
Type: object
Nested Schema : value
Type: object
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"selectedQuantity":{
"type":"integer",
"example":0
},
"id":{
"type":"string",
"example":"gwp id"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"properties":{
"propertyType":{
"type":"string",
"example":"sku-base"
},
"name":{
"type":"string",
"example":"Not returnable"
},
"id":{
"type":"string",
"example":"nonreturnable"
},
"value":{
"type":"boolean",
"example":false
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value.",
"type":"string",
"example":"L"
},
"optionName":{
"description":"The variant option name.",
"type":"string",
"example":"size"
}
}
}
Nested Schema : currentOrganization
Type: object
Show Source
{
"type":"object",
"properties":{
"contract":{
"description":"Describes the contract details of the organization and user",
"type":"object",
"properties":{
"displayName":{
"type":"string",
"example":"Contract_ABC"
},
"description":{
"type":"string",
"example":"Contract with companyA"
},
"id":{
"type":"string",
"example":"ct-1001"
}
}
},
"name":{
"description":"name of the current organization user belongs to",
"type":"string",
"example":"CompanyA"
},
"description":{
"type":"string",
"example":"CompanyA description"
},
"id":{
"description":"String representation of the current organization id",
"type":"string",
"example":"or-1001"
}
}
}
Nested Schema : loyaltyPrograms
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"profileId":{
"description":"User profile id on storefront",
"type":"string",
"example":117012
},
"programName":{
"type":"string",
"example":"Loyalty Program1"
},
"membershipId":{
"description":"MembershipId of the user enrolled in the program",
"type":"string",
"example":"LPM1234"
},
"programId":{
"description":"Id of the loyaltyProgram",
"type":"string",
"example":"LP1234"
},
"status":{
"description":"Provides the current status of user in loyaltyProgram",
"enum":[
"RequestForEnrollment",
"Enrolled",
"RequestForUnenrollment",
"Unenrolled",
"Failed"
],
"example":"Enrolled"
}
}
}
}
Nested Schema : parentOrganization
Type: object
Show Source
{
"type":"object",
"properties":{
"contract":{
"description":"Describes the contract details of the organization and user",
"type":"object",
"properties":{
"displayName":{
"type":"string",
"example":"Contract_ABC"
},
"description":{
"type":"string",
"example":"Contract with companyA"
},
"id":{
"type":"string",
"example":"ct-1001"
}
}
},
"name":{
"description":"name of the parent organization user belongs to",
"type":"string",
"example":"CompanyA"
},
"description":{
"type":"string",
"example":"CompanyA description"
},
"id":{
"description":"String representation of the parent organization id",
"type":"string",
"example":"or-1001"
}
}
}
Nested Schema : secondaryOrganizations
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"contract":{
"description":"Describes the contract details of the organization and user",
"type":"object",
"properties":{
"displayName":{
"type":"string",
"example":"Contract_ABC"
},
"description":{
"type":"string",
"example":"Contract with companyA"
},
"id":{
"type":"string",
"example":"ct-1001"
}
}
},
"name":{
"description":"name of the secondary organization user belongs to",
"type":"string",
"example":"CompanyA"
},
"description":{
"type":"string",
"example":"CompanyA description"
},
"id":{
"description":"String representation of the secondary organization id",
"type":"string",
"example":"or-1001"
}
}
}
}
Nested Schema : sitePropertiesList
Type: array
The list of site related properties for the profile
Show Source
{
"description":"The list of site related properties for the profile",
"type":"array",
"items":{
"type":"object",
"properties":{
"site":{
"description":"The site data",
"type":"object",
"properties":{
"id":{
"description":"The id of the site",
"type":"string",
"example":"siteUS"
}
}
},
"properties":{
"description":"The site related properties for the profile",
"type":"object",
"properties":{
"GDPRProfileP13nConsentDate":{
"description":"The date on which GDPR personalization consent was granted by the user.",
"type":"string",
"example":"2013-04-12 14:48:45 -0400"
},
"GDPRProfileP13nConsentGranted":{
"description":"If user has given consent for his/her profile information to be used for personalization purposes.",
"type":"boolean",
"example":false
},
"receiveEmail":{
"description":"Indicates whether the user should receive marketing emails on the current site. Can be yes or no.",
"type":"string",
"example":"no"
},
"receiveEmailDate":{
"description":"The date on which email marketing consent was granted by the user.",
"type":"string",
"example":"2013-04-12 14:48:45 -0400"
}
}
}
}
}
}
Nested Schema : contract
Type: object
Describes the contract details of the organization and user
Show Source
{
"description":"Describes the contract details of the organization and user",
"type":"object",
"properties":{
"displayName":{
"type":"string",
"example":"Contract_ABC"
},
"description":{
"type":"string",
"example":"Contract with companyA"
},
"id":{
"type":"string",
"example":"ct-1001"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"profileId":{
"description":"User profile id on storefront",
"type":"string",
"example":117012
},
"programName":{
"type":"string",
"example":"Loyalty Program1"
},
"membershipId":{
"description":"MembershipId of the user enrolled in the program",
"type":"string",
"example":"LPM1234"
},
"programId":{
"description":"Id of the loyaltyProgram",
"type":"string",
"example":"LP1234"
},
"status":{
"description":"Provides the current status of user in loyaltyProgram",
"enum":[
"RequestForEnrollment",
"Enrolled",
"RequestForUnenrollment",
"Unenrolled",
"Failed"
],
"example":"Enrolled"
}
}
}
Nested Schema : contract
Type: object
Describes the contract details of the organization and user
Show Source
{
"description":"Describes the contract details of the organization and user",
"type":"object",
"properties":{
"displayName":{
"type":"string",
"example":"Contract_ABC"
},
"description":{
"type":"string",
"example":"Contract with companyA"
},
"id":{
"type":"string",
"example":"ct-1001"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"contract":{
"description":"Describes the contract details of the organization and user",
"type":"object",
"properties":{
"displayName":{
"type":"string",
"example":"Contract_ABC"
},
"description":{
"type":"string",
"example":"Contract with companyA"
},
"id":{
"type":"string",
"example":"ct-1001"
}
}
},
"name":{
"description":"name of the secondary organization user belongs to",
"type":"string",
"example":"CompanyA"
},
"description":{
"type":"string",
"example":"CompanyA description"
},
"id":{
"description":"String representation of the secondary organization id",
"type":"string",
"example":"or-1001"
}
}
}
Nested Schema : contract
Type: object
Describes the contract details of the organization and user
Show Source
{
"description":"Describes the contract details of the organization and user",
"type":"object",
"properties":{
"displayName":{
"type":"string",
"example":"Contract_ABC"
},
"description":{
"type":"string",
"example":"Contract with companyA"
},
"id":{
"type":"string",
"example":"ct-1001"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"site":{
"description":"The site data",
"type":"object",
"properties":{
"id":{
"description":"The id of the site",
"type":"string",
"example":"siteUS"
}
}
},
"properties":{
"description":"The site related properties for the profile",
"type":"object",
"properties":{
"GDPRProfileP13nConsentDate":{
"description":"The date on which GDPR personalization consent was granted by the user.",
"type":"string",
"example":"2013-04-12 14:48:45 -0400"
},
"GDPRProfileP13nConsentGranted":{
"description":"If user has given consent for his/her profile information to be used for personalization purposes.",
"type":"boolean",
"example":false
},
"receiveEmail":{
"description":"Indicates whether the user should receive marketing emails on the current site. Can be yes or no.",
"type":"string",
"example":"no"
},
"receiveEmailDate":{
"description":"The date on which email marketing consent was granted by the user.",
"type":"string",
"example":"2013-04-12 14:48:45 -0400"
}
}
}
}
}
Nested Schema : properties
Type: object
The site related properties for the profile
Show Source
{
"description":"The site related properties for the profile",
"type":"object",
"properties":{
"GDPRProfileP13nConsentDate":{
"description":"The date on which GDPR personalization consent was granted by the user.",
"type":"string",
"example":"2013-04-12 14:48:45 -0400"
},
"GDPRProfileP13nConsentGranted":{
"description":"If user has given consent for his/her profile information to be used for personalization purposes.",
"type":"boolean",
"example":false
},
"receiveEmail":{
"description":"Indicates whether the user should receive marketing emails on the current site. Can be yes or no.",
"type":"string",
"example":"no"
},
"receiveEmailDate":{
"description":"The date on which email marketing consent was granted by the user.",
"type":"string",
"example":"2013-04-12 14:48:45 -0400"
}
}
}
Nested Schema : site
Type: object
The site data
Show Source
{
"description":"The site data",
"type":"object",
"properties":{
"id":{
"description":"The id of the site",
"type":"string",
"example":"siteUS"
}
}
}
Nested Schema : address
Type: object
Address
Show Source
{
"description":"Address",
"type":"object",
"properties":{
"lastName":{
"description":"lastName of person",
"type":"string",
"example":"Muir"
},
"firstName":{
"description":"firstName of person",
"type":"string",
"example":"John"
},
"country":{
"description":"the country of the Address",
"type":"string",
"example":"US"
},
"address2":{
"description":"address2 of the person",
"type":"string",
"example":"Apt 123"
},
"address1":{
"description":"address1 of the person",
"type":"string",
"example":"1 main st"
},
"postalCode":{
"description":"postalCode of the person",
"type":"string",
"example":1122
},
"state":{
"description":"state of the person",
"type":"string",
"example":"New York"
}
}
}
Nested Schema : appliedCoupons
Type: array
Coupons applied to order.
Show Source
{
"description":"Coupons applied to order.",
"type":"array",
"items":{
"type":"string",
"example":"CPN123"
}
}
Nested Schema : items
Type: array
items
Show Source
{
"description":"items",
"type":"array",
"items":{
"type":"object",
"properties":{
"product":{
"description":"product",
"type":"object",
"properties":{
"width":{
"description":"width of the product",
"type":"number",
"example":1
},
"length":{
"description":"length of the product",
"type":"number",
"example":1
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number",
"example":0
},
"weight":{
"description":"weight of the product",
"type":"number",
"example":1
},
"id":{
"description":"id of the product",
"type":"string",
"example":"Product_XYZ"
},
"taxCode":{
"description":"Tax Code of the product.",
"type":"string",
"example":"DV10010"
},
"height":{
"description":"height of the product",
"type":"number",
"example":1
}
}
},
"amount":{
"description":"amount",
"type":"number",
"example":24.99
},
"quantity":{
"description":"quantity",
"type":"integer",
"example":1
},
"rawTotalPrice":{
"description":"The raw total price.",
"type":"number",
"example":24.99
},
"discount":{
"description":"discount of the order",
"type":"number",
"example":0
},
"catalogRefId":{
"description":"The catalog ref id",
"type":"string",
"example":"SKU_Ref"
}
}
}
}
Nested Schema : locale
Type: object
locale
Show Source
{
"description":"locale",
"type":"object",
"properties":{
"country":{
"description":"country",
"type":"string",
"example":"US"
},
"displayName":{
"description":"the display name",
"type":"string",
"example":"English"
},
"language":{
"description":"language",
"type":"string",
"example":"en"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"product":{
"description":"product",
"type":"object",
"properties":{
"width":{
"description":"width of the product",
"type":"number",
"example":1
},
"length":{
"description":"length of the product",
"type":"number",
"example":1
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number",
"example":0
},
"weight":{
"description":"weight of the product",
"type":"number",
"example":1
},
"id":{
"description":"id of the product",
"type":"string",
"example":"Product_XYZ"
},
"taxCode":{
"description":"Tax Code of the product.",
"type":"string",
"example":"DV10010"
},
"height":{
"description":"height of the product",
"type":"number",
"example":1
}
}
},
"amount":{
"description":"amount",
"type":"number",
"example":24.99
},
"quantity":{
"description":"quantity",
"type":"integer",
"example":1
},
"rawTotalPrice":{
"description":"The raw total price.",
"type":"number",
"example":24.99
},
"discount":{
"description":"discount of the order",
"type":"number",
"example":0
},
"catalogRefId":{
"description":"The catalog ref id",
"type":"string",
"example":"SKU_Ref"
}
}
}
Nested Schema : product
Type: object
product
Show Source
{
"description":"product",
"type":"object",
"properties":{
"width":{
"description":"width of the product",
"type":"number",
"example":1
},
"length":{
"description":"length of the product",
"type":"number",
"example":1
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number",
"example":0
},
"weight":{
"description":"weight of the product",
"type":"number",
"example":1
},
"id":{
"description":"id of the product",
"type":"string",
"example":"Product_XYZ"
},
"taxCode":{
"description":"Tax Code of the product.",
"type":"string",
"example":"DV10010"
},
"height":{
"description":"height of the product",
"type":"number",
"example":1
}
}
}