externalTaxCalculation
post
/ccadmin/v1/webhook/externalTaxCalculation
This event is triggered at checkout page to get tax for cart from external service
Request
Supported Media Types
- application/json
This event is triggered at checkout page to get tax for cart from external service
Root Schema : externalTaxCalculation_request
Type:
object
This event is triggered at checkout page to get tax for cart from external service
Show Source
Nested Schema : request
Type:
Show Source
object
-
callType(optional):
string
The tax call type.Example:
SalesOrder
-
creationDate(optional):
string
The order creation date.Example:
2018-07-30T15:49:10.184Z
-
creationSiteId(optional):
string
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.
-
creationTime(optional):
number
The creation time of the order.Example:
1.532965750184E12
-
currencyConversionEnabled(optional):
boolean
Indicates whether currency conversion is enabledExample:
false
-
discountInfo(optional):
object discountInfo
The discount information.
-
dynamicProperties(optional):
array dynamicProperties
List of dynamic properties at line item level.
-
exchangeRate(optional):
number
The conversion rate between the order currency and base currency.Example:
0
-
giftWithPurchaseInfo(optional):
array giftWithPurchaseInfo
-
isTaxIncluded(optional):
boolean
Indicates whether order is inclusive of tax.Example:
false
-
markers(optional):
array markers
Order marker information
-
orderCurrencyCode(optional):
string
The currency code of the order currencyExample:
USD
-
orderId(optional):
string
The ID of the order.Example:
o30429
-
orderProfileId(optional):
string
The profile id on the order.Example:
111669
-
orderStatus(optional):
string
The order status.Example:
Incomplete
-
priceInfo(optional):
object priceInfo
-
profile(optional):
object profile
-
recurringChargePriceInfo(optional):
object recurringChargePriceInfo
Recurring charge price information.
-
secondaryCurrencyCode(optional):
string
The currency code of secondary currency.Example:
UK
-
secondaryCurrencyShippingAmount(optional):
number
The secondary currency shipping amount and this will be present only if it is a points based orderExample:
0
-
secondaryCurrencyTaxAmount(optional):
number
The secondary currency tax amount and this will be present only if it is a points based orderExample:
0
-
shipFromAddress(optional):
object shipFromAddress
-
shippingGroups(optional):
array shippingGroups
-
shoppingCart(optional):
object shoppingCart
-
siteId(optional):
string
The ID of the site on which the order was placed.
-
taxDate(optional):
string
Date when the tax has to be considered. This parameter accepts a date format of dd-MM-yyyyExample:
04-11-2019
Nested Schema : discountInfo
Type:
object
The discount information.
Show Source
-
claimedCouponMultiPromotions(optional):
object claimedCouponMultiPromotions
-
orderCouponsMap(optional):
object orderCouponsMap
The coupons that were claimed.
-
orderDiscount(optional):
number
The order discount.Example:
0
-
orderImplicitDiscountList(optional):
array orderImplicitDiscountList
-
shippingDiscount(optional):
number
The shipping discount.Example:
5.6
-
unclaimedCouponMultiPromotions(optional):
object unclaimedCouponMultiPromotions
-
unclaimedCouponsMap(optional):
object unclaimedCouponsMap
Nested Schema : dynamicProperties
Type:
array
List of dynamic properties at line item level.
Show Source
Nested Schema : priceInfo
Type:
Show Source
object
-
amount(optional):
number
Example:
21.99
-
currencyCode(optional):
string
Example:
USD
-
shipping(optional):
number
Example:
25
-
shippingSurchargeValue(optional):
number
Example:
0
-
subTotal(optional):
number
Example:
21.99
-
tax(optional):
number
Example:
0
-
total(optional):
number
Example:
21.99
-
totalWithoutTax(optional):
number
Example:
21.99
Nested Schema : profile
Type:
Show Source
object
-
customerContactId(optional):
string
The external customer contact id.Example:
externalId
-
daytimeTelephoneNumber(optional):
string
The day time phone number of the profileExample:
781-781-7811
-
email(optional):
string
Example:
john.muir@oracle.com
-
firstName(optional):
string
Example:
John
-
id(optional):
string
IdExample:
11169
-
lastName(optional):
string
Example:
Muir
-
locale(optional):
string
Example:
en
-
loyaltyPrograms(optional):
array loyaltyPrograms
Loyalty Programs Information
-
middleName(optional):
string
Example:
Morgan
-
receiveEmail(optional):
string
The string representation of whether the user wants to receive email or notExample:
no
-
sitePropertiesList(optional):
array sitePropertiesList
The list of site related properties for the profile
-
taxExempt(optional):
boolean
Indicates if user is taxExemptExample:
false
-
taxExemptionCode(optional):
string
Example:
TX123
Nested Schema : recurringChargePriceInfo
Type:
object
Recurring charge price information.
Show Source
-
amount(optional):
number
The monetary amount of this recurring charge.Example:
21.99
-
currencyCode(optional):
string
The currency code for the monetary amounts. A three character currency code such as USD.Example:
USD
-
frequencyAmountTotals(optional):
array frequencyAmountTotals
The total for each recurring charge frequency
-
frequencyTaxTotals(optional):
array frequencyTaxTotals
The tax for each recurring charge frequency
-
shipping(optional):
number
Cost of shipping the product.Example:
25
-
subTotal(optional):
number
The sub-total price of the recurring charge.Example:
21.99
-
tax(optional):
number
Monetary tax amount.Example:
0
-
total(optional):
number
The total price of the recurring charge.Example:
21.99
-
totalWithoutTax(optional):
number
Total of recurring amount without tax included.Example:
21.99
Nested Schema : shipFromAddress
Type:
Show Source
object
-
address1(optional):
string
Example:
1 main st
-
address2(optional):
string
Example:
2 cross
-
address3(optional):
string
Example:
Suite 6
-
city(optional):
string
Example:
Cambridge
-
companyName(optional):
string
Example:
oracle
-
country(optional):
string
Example:
United States
-
county(optional):
string
Example:
Suffolk
-
email(optional):
string
Example:
john.muir@oracle.com
-
faxNumber(optional):
number
Example:
123123134
-
firstName(optional):
string
Example:
John
-
jobTitle(optional):
string
Example:
Manager
-
lastName(optional):
string
Example:
Muir
-
middleName(optional):
string
Example:
Morgan
-
phoneNumber(optional):
number
Example:
1231231234
-
postalCode(optional):
string
Example:
1122
-
prefix(optional):
string
Example:
Mr
-
state(optional):
string
Example:
MA
-
suffix(optional):
string
Example:
Sr
Nested Schema : shoppingCart
Type:
Show Source
object
-
items(optional):
array items
The array of products in the shopping cart. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook
-
itemsIsTruncated(optional):
boolean
This property will be added to the webhook payload only if the corresponding items property is truncated. The value for this field will always be true if present
-
numberOfItems(optional):
number
Example:
1
Nested Schema : claimedCouponMultiPromotions
Type:
Show Source
object
-
couponCode(optional):
string
Example:
CPN123
-
promotions(optional):
array promotions
Nested Schema : orderCouponsMap
Type:
object
The coupons that were claimed.
Show Source
-
couponCode(optional):
object couponCode
Coupon Code.
Nested Schema : unclaimedCouponMultiPromotions
Type:
Show Source
object
-
couponCode(optional):
string
Example:
CPN123
-
promotionInfo(optional):
array promotionInfo
Nested Schema : unclaimedCouponsMap
Type:
Show Source
object
-
couponCode(optional):
string
Example:
CPN123
Nested Schema : items
Type:
Show Source
object
-
promotionID(optional):
string
Example:
PRM123
-
secondaryCurrencyTotalAdjustment(optional):
number
Example:
0
-
totalAdjustment(optional):
number
Example:
0
Nested Schema : couponCode
Type:
object
Coupon Code.
Show Source
-
external(optional):
boolean
States whether this promotion was applied by an external system (only present on external promotions).Example:
false
-
promotionDesc(optional):
string
Description of the promotion. Retained for backward compatibility.Example:
Spend 10 Get 10% Off
-
promotionId(optional):
string
The Id of the promotion.Example:
promo123
-
promotionLevel(optional):
string
The promotion level.Example:
order
-
promotionLongDesc(optional):
string
The description of the promotion.Example:
<p>desc Spend 10 Get 10% Off</p>
-
promotionName(optional):
string
The display name of the promotion.Example:
10% Off
-
totalAdjustment(optional):
number
Total adjustment caused by the promotion.Example:
-11.1
Nested Schema : items
Type:
Show Source
object
-
external(optional):
boolean
States whether this promotion was applied by an external system (only present on external promotions).Example:
true
-
promotionDesc(optional):
string
Example:
the order related promotion
-
promotionId(optional):
string
Example:
PRM1234
-
promotionLevel(optional):
string
promotion level - order or itemExample:
order
-
promotionLongDesc(optional):
string
Example:
Detailed desc of promotion
-
promotionName(optional):
string
Example:
PROMO1
-
secondaryCurrencyTotalAdjustment(optional):
string
The total adjustment for secondary currencyExample:
0
-
totalAdjustment(optional):
string
The total adjustment.Example:
5.6
Nested Schema : items
Type:
Show Source
object
-
promotionDesc(optional):
string
Example:
description of the promotion
-
promotionID(optional):
string
Example:
PRM123
-
promotionLevel(optional):
string
Example:
order
-
promotionLongDesc(optional):
string
Example:
long desc of promotion
-
promotionName(optional):
string
Example:
PRMName
-
totalAdjustment(optional):
number
Example:
0
Nested Schema : items
Type:
Show Source
object
-
id(optional):
string
The dynamic property id.Example:
11502
-
label(optional):
string
The dynamic property label.Example:
dyn_prop
-
value(optional):
string
The dynamic property value.Example:
12
Nested Schema : items
Type:
Show Source
object
-
giftWithPurchaseDetail(optional):
string
String identifying the free gift, usually the repository id of the gift type.Example:
FreePerfumeSku
-
giftWithPurchaseIdentifier(optional):
number
An identifier used to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one. example: SKU_986
-
giftWithPurchaseQuantityAvailableForSelection(optional):
number
gift quantity available for selectionExample:
1
-
giftWithPurchaseType(optional):
string
The type of the gift. (sku, product)Example:
sku
-
promotionId(optional):
string
The gift with purchase promotion idExample:
PROMO123
Nested Schema : items
Type:
Show Source
object
-
key(optional):
string
Order marker key. In a marketing campaign marker, a key signifies that it is a campaign marker. Also, it identifies the external marketing system that is the source of the campaign, e.g., campaign_eloqua
-
value(optional):
string
Order marker value. e.g. In case of marketing campaign, value represents actual unique campaign Id
Nested Schema : sitePropertiesList
Type:
array
The list of site related properties for the profile
Show Source
Nested Schema : items
Type:
Show Source
object
-
membershipId(optional):
string
membershipId of the profile.Example:
MM123
-
programId(optional):
string
programId of Loyalty ProgramExample:
LYT123
-
programName(optional):
string
programName of Loyalty ProgramExample:
Loyalty Program Demo
-
repositoryId(optional):
string
repository IdExample:
123345
-
status(optional):
string
status of Enrollment.Example:
Enrolled
Nested Schema : items
Type:
Show Source
object
-
properties(optional):
object properties
The site related properties for the profile
-
site(optional):
object site
The site data
Nested Schema : properties
Type:
object
The site related properties for the profile
Show Source
-
GDPRProfileP13nConsentDate(optional):
string
The date on which GDPR personalization consent was granted by the user.Example:
null
-
GDPRProfileP13nConsentGranted(optional):
boolean
If user has given consent for his/her profile information to be used for personalization purposes.Example:
false
-
receiveEmail(optional):
string
Indicates whether the user should receive marketing emails on the current site. Can be yes or no.Example:
no
-
receiveEmailDate(optional):
string
The date on which email marketing consent was granted by the user.Example:
2018-07-30T15:49:10.184Z
Nested Schema : site
Type:
object
The site data
Show Source
-
id(optional):
string
The id of the siteExample:
SiteUS
Nested Schema : frequencyAmountTotals
Type:
array
The total for each recurring charge frequency
Show Source
Nested Schema : frequencyTaxTotals
Type:
array
The tax for each recurring charge frequency
Show Source
Nested Schema : items
Type:
Show Source
object
-
frequency(optional):
string
The frequency for the item's total e.g. Monthly.Example:
Monthly
-
total(optional):
string
The total amount for the frequency.Example:
21.99
Nested Schema : items
Type:
Show Source
object
-
frequency(optional):
string
The frequency for the item's tax e.g. Monthly.Example:
Monthly
-
tax(optional):
string
The tax amount for the frequency.Example:
0
Nested Schema : items
Type:
Show Source
object
-
discountInfo(optional):
object discountInfo
The discount information.
-
email(optional):
string
The email address of the person responsible for picking up the contents of this shipping group.Example:
john.muir@oracle.com
-
firstName(optional):
string
The first name of the person responsible for picking up the contents of this shipping group.Example:
John
-
items(optional):
array items
-
itemsIsTruncated(optional):
boolean
This property will be added to the webhook payload only if the corresponding items property is truncated. The value for this field will always be true if present
-
lastName(optional):
string
The second name of the person responsible for picking up the contents of this shipping group.Example:
Muir
-
phoneNumber(optional):
string
The phone number of the person responsible for picking up the contents of this shipping group.Example:
1231231234
-
priceInfo(optional):
object priceInfo
-
recurringChargePriceInfo(optional):
object recurringChargePriceInfo
Recurring charge price information.
-
shippingAddress(optional):
object shippingAddress
-
shippingGroupId(optional):
string
The shipping group id.Example:
sg123
-
shippingMethod(optional):
object shippingMethod
The shipping method details for the order.
Nested Schema : discountInfo
Type:
object
The discount information.
Show Source
-
claimedCouponMultiPromotions(optional):
object claimedCouponMultiPromotions
-
orderCouponsMap(optional):
object orderCouponsMap
The coupons that were claimed.
-
orderDiscount(optional):
number
The order discount.Example:
0
-
orderImplicitDiscountList(optional):
array orderImplicitDiscountList
-
shippingDiscount(optional):
number
The shipping discount.Example:
5.6
-
unclaimedCouponMultiPromotions(optional):
object unclaimedCouponMultiPromotions
-
unclaimedCouponsMap(optional):
object unclaimedCouponsMap
Nested Schema : priceInfo
Type:
Show Source
object
-
amount(optional):
number
Example:
21.99
-
currencyCode(optional):
string
Example:
USD
-
lkpValExcludingFreeShip(optional):
number
Example:
0
-
shipping(optional):
number
Example:
25
-
shippingSurchargeValue(optional):
number
Example:
0
-
subTotal(optional):
number
Example:
21.99
-
tax(optional):
number
Example:
0
-
total(optional):
number
Example:
21.99
-
totalWithoutTax(optional):
number
Example:
21.99
Nested Schema : recurringChargePriceInfo
Type:
object
Recurring charge price information.
Show Source
-
amount(optional):
number
The monetary amount of this recurring charge.Example:
21.99
-
currencyCode(optional):
string
The currency code for the monetary amounts. A three character currency code such as USD.Example:
USD
-
frequencyAmountTotals(optional):
array frequencyAmountTotals
The total for each recurring charge frequency
-
frequencyTaxTotals(optional):
array frequencyTaxTotals
The tax for each recurring charge frequency
-
shipping(optional):
number
Cost of shipping the product.Example:
25
-
subTotal(optional):
number
The sub-total price of the recurring charge.Example:
21.99
-
tax(optional):
number
Monetary tax amount.Example:
0
-
total(optional):
number
The total price of the recurring charge.Example:
21.99
-
totalWithoutTax(optional):
number
Total of recurring amount without tax included.Example:
21.99
Nested Schema : shippingAddress
Type:
Show Source
object
-
address1(optional):
string
Example:
1 main st
-
address2(optional):
string
Example:
2 cross
-
address3(optional):
string
Example:
Suite 6
-
city(optional):
string
Example:
Boston
-
companyName(optional):
string
Example:
Oracle
-
country(optional):
string
Example:
United States
-
county(optional):
string
Example:
Suffolk
-
email(optional):
string
Example:
john.muir@oracle.com
-
faxNumber(optional):
number
Example:
1231231234
-
firstName(optional):
string
Example:
John
-
jobTitle(optional):
string
Example:
Manager
-
lastName(optional):
string
Example:
Muir
-
middleName(optional):
string
Example:
Morgan
-
phoneNumber(optional):
number
Example:
1231231234
-
postalCode(optional):
string
Example:
12345
-
prefix(optional):
string
Example:
Mr
-
state(optional):
string
Example:
MA
-
suffix(optional):
string
Example:
Sr
Nested Schema : shippingMethod
Type:
object
The shipping method details for the order.
Show Source
-
cost(optional):
number
The cost of shipping.Example:
25
-
shippingMethodDescription(optional):
string
The shipping method description.Example:
Two day shipping
-
shippingTax(optional):
number
The shipping tax.Example:
0
-
taxCode(optional):
string
The tax code for shipping method.Example:
TX123
-
value(optional):
string
The shipping method .Example:
TwoDay
Nested Schema : claimedCouponMultiPromotions
Type:
Show Source
object
-
couponCode(optional):
string
Example:
CPN123
-
promotions(optional):
array promotions
Nested Schema : orderCouponsMap
Type:
object
The coupons that were claimed.
Show Source
-
couponCode(optional):
object couponCode
Coupon Code.
Nested Schema : unclaimedCouponMultiPromotions
Type:
Show Source
object
-
couponCode(optional):
string
Example:
CPN123
-
promotionInfo(optional):
array promotionInfo
Nested Schema : unclaimedCouponsMap
Type:
Show Source
object
-
couponCode(optional):
string
Example:
CPN123
Nested Schema : items
Type:
Show Source
object
-
promotionID(optional):
string
Example:
PRM123
-
secondaryCurrencyTotalAdjustment(optional):
number
Example:
0
-
totalAdjustment(optional):
number
Example:
0
Nested Schema : couponCode
Type:
object
Coupon Code.
Show Source
-
external(optional):
boolean
States whether this promotion was applied by an external system (only present on external promotions).Example:
false
-
promotionDesc(optional):
string
Description of the promotion. Retained for backward compatibility.Example:
Spend 10 Get 10% Off
-
promotionId(optional):
string
The Id of the promotion.Example:
promo123
-
promotionLevel(optional):
string
The promotion level.Example:
order
-
promotionLongDesc(optional):
string
The description of the promotion.Example:
<p>desc Spend 10 Get 10% Off</p>
-
promotionName(optional):
string
The display name of the promotion.Example:
10% Off
-
totalAdjustment(optional):
number
Total adjustment caused by the promotion.Example:
-11.1
Nested Schema : items
Type:
Show Source
object
-
external(optional):
boolean
States whether this promotion was applied by an external system (only present on external promotions).Example:
true
-
promotionDesc(optional):
string
Example:
the order related promotion
-
promotionId(optional):
string
Example:
PRM1234
-
promotionLevel(optional):
string
promotion level - order or itemExample:
order
-
promotionLongDesc(optional):
string
Example:
Detailed desc of promotion
-
promotionName(optional):
string
Example:
PROMO1
-
secondaryCurrencyTotalAdjustment(optional):
string
The total adjustment for secondary currencyExample:
0
-
totalAdjustment(optional):
string
The total adjustment.Example:
5.6
Nested Schema : items
Type:
Show Source
object
-
promotionDesc(optional):
string
Example:
description of the promotion
-
promotionID(optional):
string
Example:
PRM123
-
promotionLevel(optional):
string
Example:
order
-
promotionLongDesc(optional):
string
Example:
long desc of promotion
-
promotionName(optional):
string
Example:
PRMName
-
totalAdjustment(optional):
number
Example:
0
Nested Schema : items
Type:
Show Source
object
-
availablePickupDate(optional):
string
The items available store pickup date.Example:
2018-05-19T13:00:00.000Z
-
catRefId(optional):
string
The catalog ref id.Example:
SKu_36Fxy
-
childItemsIsTruncated(optional):
boolean
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
-
commerceItemId(optional):
string
Internal commerce item id.Example:
ci200014
-
detailedItemPriceInfo(optional):
array detailedItemPriceInfo
-
discountAmount(optional):
number
The discount amount.Example:
0
-
discountInfo(optional):
array discountInfo
Whether this item is discounted.
-
dynamicProperties(optional):
array dynamicProperties
List of dynamic properties at line item level.
-
externalData(optional):
array externalData
External data to be associated with a commerce item, provided by a third party system.
-
externalPrice(optional):
number
Individual price of configurable item
-
inventoryLocationId(optional):
string
Defines the inventory location that services the referenced commerce item.Example:
IN123
-
listPrice(optional):
number
The list price.Example:
21.99
-
onSale(optional):
boolean
Is item on sale.Example:
false
-
preferredPickupDate(optional):
string
The items preferred store pickup date.Example:
2018-05-19T13:00:00.000Z
-
price(optional):
number
The price.Example:
21.99
-
quantity(optional):
number
The quantity.Example:
1
-
rawTotalPrice(optional):
number
The raw total price.Example:
21.99
-
returnedQuantity(optional):
number
The returned quantity.Example:
0
-
salePrice(optional):
number
The sale price.Example:
0
-
shippingSurchargeValue(optional):
number
The shipping surcharge if any.Example:
0
-
shopperInput(optional):
object shopperInput
Map of shopper input keys to values
-
siteId(optional):
string
The ID of the site on which the item was added.
-
stateDetailsAsUser(optional):
string
state details.Example:
Description of user
-
status(optional):
string
status.Example:
oracle.doceng.json.BetterJsonNull@69c8126
-
unitPrice(optional):
number
The unit price.Example:
21.99
Nested Schema : dynamicProperties
Type:
array
List of dynamic properties at line item level.
Show Source
Nested Schema : externalData
Type:
array
External data to be associated with a commerce item, provided by a third party system.
Show Source
Nested Schema : shopperInput
Type:
object
Map of shopper input keys to values
Show Source
-
additionalProperties(optional):
string
Example:
SkinBlonde
Nested Schema : items
Type:
Show Source
object
-
amount(optional):
number
Example:
24.99
-
currencyCode(optional):
string
Example:
USD
-
detailedUnitPrice(optional):
number
Example:
24.99
-
discounted(optional):
boolean
Example:
false
- orderDiscountShare(optional): number
-
quantity(optional):
number
Example:
1
-
secondaryCurrencyTaxAmount(optional):
number
tax amount in secondaryCurrencyExample:
0
-
tax(optional):
number
Example:
0
Nested Schema : items
Type:
Show Source
object
-
coupon(optional):
string
Example:
CPN123
-
external(optional):
boolean
if promotion is externalExample:
false
-
giftWithPurchaseDiscountInfo(optional):
array giftWithPurchaseDiscountInfo
-
promotionDesc(optional):
string
Example:
promotion desc
-
promotionId(optional):
string
Example:
PRM123
-
promotionLevel(optional):
string
Example:
item
-
promotionLongDesc(optional):
string
Example:
detailed desc of promotion
-
promotionName(optional):
string
Example:
Promotion BAC
-
totalAdjustment(optional):
string
Example:
0
Nested Schema : items
Type:
Show Source
object
-
giftWithPurchaseType(optional):
string
the gift type.For example product or skuExample:
product
-
gitWithPurchaseDetail(optional):
string
Example:
details of gift
-
gitWithPurchaseIdentifier(optional):
number
Example:
1223344
-
promotionDesc(optional):
string
Example:
GWP Promotion description
-
promotionId(optional):
string
Example:
PRM1234
Nested Schema : items
Type:
Show Source
object
-
id(optional):
string
The dynamic property id.Example:
11502
-
label(optional):
string
The dynamic property label.Example:
dyn_prop
-
value(optional):
string
The dynamic property value.Example:
12
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the externalData item by the third party system.Example:
ExternalPropertyAction
-
name(optional):
string
The name to be associated with the externalData item.Example:
ExternalProp
-
values(optional):
object values
The map values associated with an externalData item.
Nested Schema : values
Type:
object
The map values associated with an externalData item.
Show Source
-
key(optional):
string
Map key defined by external system.Example:
ExternalPropertyKey
-
value(optional):
string
Map value defined by external system.Example:
ExternalPropertyVal
Nested Schema : frequencyAmountTotals
Type:
array
The total for each recurring charge frequency
Show Source
Nested Schema : frequencyTaxTotals
Type:
array
The tax for each recurring charge frequency
Show Source
Nested Schema : items
Type:
Show Source
object
-
frequency(optional):
string
The frequency for the item's total e.g. Monthly.Example:
Monthly
-
total(optional):
string
The total amount for the frequency.Example:
21.99
Nested Schema : items
Type:
Show Source
object
-
frequency(optional):
string
The frequency for the item's tax e.g. Monthly.Example:
Monthly
-
tax(optional):
string
The tax amount for the frequency.Example:
0
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
Nested Schema : items
Type:
Show Source
object
-
amount(optional):
number
Example:
21.99
-
catRefId(optional):
string
Example:
Sku_36Fxy
-
childItems(optional):
array childItems
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
-
childItemsIsTruncated(optional):
boolean
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
-
commerceItemId(optional):
string
CommerceItem idExample:
ci3000421
-
configuratorId(optional):
string
Example:
null
-
description(optional):
string
Example:
Best movie title
-
detailedItemPriceInfo(optional):
array detailedItemPriceInfo
-
detailedRecurringChargeInfo(optional):
object detailedRecurringChargeInfo
Detailed Item Price Information.
-
discountAmount(optional):
number
Example:
0
-
discountInfo(optional):
array discountInfo
The discount information.
-
displayName(optional):
string
Example:
The Girl with the Dragon Tattoo
-
dynamicProperties(optional):
array dynamicProperties
List of dynamic properties at line item level.
-
externalData(optional):
array externalData
External data to be associated with a commerce item, provided by a third party system.
-
externalPrice(optional):
number
Example:
0
-
externalPriceQuantity(optional):
number
Example:
0
-
giftWithPurchaseCommerceItemMarkers(optional):
array giftWithPurchaseCommerceItemMarkers
-
id(optional):
string
Commerce id of the productExample:
ci3000424
-
isItemValid(optional):
boolean
Example:
true
-
listPrice(optional):
number
Example:
21.99
-
onSale(optional):
boolean
Example:
false
-
price(optional):
number
Example:
21.99
-
primaryThumbImageURL(optional):
string
Example:
/ccstore/v1/images/product1.jpg
-
productId(optional):
string
Example:
Product_36Exy
-
quantity(optional):
number
Example:
1
-
rawTotalPrice(optional):
number
Example:
21.99
-
salePrice(optional):
number
Example:
0
-
shippingSurchargeValue(optional):
number
Example:
0
-
shopperInput(optional):
object shopperInput
Map of shopper input keys to values
-
siteId(optional):
string
The ID of the site on which the item was added.
-
skuProperties(optional):
object skuProperties
-
unitPrice(optional):
number
Example:
21.99
-
variant(optional):
array variant
List of variants for the product.
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
Nested Schema : detailedRecurringChargeInfo
Type:
object
Detailed Item Price Information.
Show Source
-
amount(optional):
number
The monetary amount for the recurring charge.Example:
21.99
-
currencyCode(optional):
string
The three character currency code for the monetary amounts.Example:
USD
-
detailedUnitPrice(optional):
number
The detailed unit price: amount / quantity. (read-only)Example:
21.99
-
discounted(optional):
boolean
Whether the price is discounted.Example:
false
- orderDiscountShare(optional): number
-
quantity(optional):
number
The number of items covered by this recurring charge price infoExample:
1
-
tax(optional):
number
Monetary tax amount.Example:
0
Nested Schema : dynamicProperties
Type:
array
List of dynamic properties at line item level.
Show Source
Nested Schema : externalData
Type:
array
External data to be associated with a commerce item, provided by a third party system.
Show Source
Nested Schema : shopperInput
Type:
object
Map of shopper input keys to values
Show Source
-
additionalProperties(optional):
string
Example:
SkinBlonde
Nested Schema : skuProperties
Type:
Show Source
object
-
id(optional):
string
Example:
nonreturnable
-
name(optional):
string
Example:
Not Returnable
-
propertyType(optional):
string
Example:
sku-base
-
value(optional):
string
Example:
false
Nested Schema : items
Type:
Show Source
object
-
addOnItem(optional):
boolean
Whether this child item is an add-on (internally configured) or not (externally configured).Example:
true
-
configurablePropertyId(optional):
string
ID of the catalog's configurableProperty associated with this item.Example:
configPropIDC1P11536825979556
-
configurationOptionId(optional):
string
ID of the catalog's configurationOption associated with this item.Example:
configOptIDC1P11536825979556
-
shopperInput(optional):
object shopperInput
Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
-
siteId(optional):
string
The ID of the site on which the item was added.
Nested Schema : shopperInput
Type:
object
Additional Properties Allowed
Show Source
-
string
Example:
SkinBlonde
Map of shopper input keys to values
Nested Schema : items
Type:
Show Source
object
-
amount(optional):
number
Example:
21.99
-
currencyCode(optional):
string
Example:
USD
-
detailedUnitPrice(optional):
number
Example:
21.99
-
discounted(optional):
boolean
Example:
false
- orderDiscountShare(optional): number
-
quantity(optional):
number
Example:
1
-
tax(optional):
number
Example:
0
Nested Schema : items
Type:
Show Source
object
-
coupon(optional):
string
The coupon ID.Example:
CPN1234
-
promotionDesc(optional):
string
The promotion description.Example:
women lead promotion
-
promotionId(optional):
string
The promotion ID.Example:
PROMO123
Nested Schema : items
Type:
Show Source
object
-
id(optional):
string
The dynamic property id.Example:
11234
-
label(optional):
string
The dynamic property label.Example:
leadActor
-
value(optional):
string
The dynamic property value.Example:
women
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the externalData item by the third party system.Example:
ExtAct1
-
name(optional):
string
The name to be associated with the externalData item.Example:
Ext1
-
values(optional):
object values
The map values associated with an externalData item.
Nested Schema : values
Type:
object
The map values associated with an externalData item.
Show Source
-
key(optional):
string
Map key defined by external system.Example:
ExtKey1
-
value(optional):
string
Map value defined by external system.Example:
ExtVal1
Nested Schema : items
Type:
Show Source
object
-
id(optional):
string
Example:
gwp id
-
selectedQuantity(optional):
number
Example:
0
Nested Schema : items
Type:
Show Source
object
-
optionName(optional):
string
The variant option name.Example:
size
-
optionValue(optional):
string
The variant option value.Example:
L
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : externalTaxCalculation_response
Type:
object
The tax calculation response from external service
Show Source
Nested Schema : response
Type:
Show Source
object
-
callType(optional):
string
Example:
SalesOrder
-
creationDate(optional):
string
Example:
2018-07-30T15:49:10.184Z
-
creationTime(optional):
number
Example:
1.532965750184E12
-
errors(optional):
array errors
In case of failures, the Webhook can return back error details to Commerce. These error details are returned back to the Store and Agent endpoints.
-
isTaxIncluded(optional):
boolean
Example:
false
-
orderId(optional):
string
Example:
o30429
-
orderProfileId(optional):
string
Example:
111669
-
orderStatus(optional):
string
Example:
Incomplete
-
shippingGroups(optional):
array shippingGroups
-
status(optional):
string
Example:
success
-
taxDate(optional):
string
Example:
07-30-2018
-
timestamp(optional):
string
Example:
2018-07-30T15:50:08.011Z
Nested Schema : errors
Type:
array
In case of failures, the Webhook can return back error details to Commerce. These error details are returned back to the Store and Agent endpoints.
Show Source
Nested Schema : items
Type:
Show Source
object
-
description(optional):
string
Example:
Error description in detail
-
errorCode(optional):
number
Example:
0
Nested Schema : items
Type:
Show Source
object
-
email(optional):
string
The email address of the person responsible for picking up the contents of this shipping group.Example:
john.muir@oracle.com
-
firstName(optional):
string
The first name of the person responsible for picking up the contents of this shipping group.Example:
John
-
items(optional):
array items
-
lastName(optional):
string
The second name of the person responsible for picking up the contents of this shipping group.Example:
Muir
-
phoneNumber(optional):
string
The phone number of the person responsible for picking up the contents of this shipping group.Example:
1231231234
-
priceInfo(optional):
object priceInfo
Pricing information, an instance of OrderPriceInfo.
-
recurringChargePriceInfo(optional):
object recurringChargePriceInfo
Recurring charge price information.
-
shippingGroupId(optional):
string
The shipping group id.Example:
sg40439
-
shippingMethod(optional):
object shippingMethod
The shipping method details for the order.
-
taxPriceInfo(optional):
object taxPriceInfo
The tax pricing details for the order.
-
type(optional):
string
The type of the ShippingGroup. Ex - "hardgoodShippingGroup", "virtualShippingGroup" etc.Example:
hardgoodShippingGroup
Nested Schema : priceInfo
Type:
object
Pricing information, an instance of OrderPriceInfo.
Show Source
-
amount(optional):
number
The monetary amount.Example:
21.99
-
amountIsFinal(optional):
boolean
Whether the amount is final.Example:
true
-
currencyCode(optional):
string
The three character currency code for the monetary amounts.Example:
USD
-
discountAmount(optional):
number
The monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal. (read-only)Example:
0
-
discounted(optional):
boolean
Whether the price is discounted.Example:
false
-
lkpValExcludingFreeShip(optional):
number
The total shipping cost excluding items with free shipping.Example:
oracle.doceng.json.BetterJsonNull@d1c17eb
-
manualAdjustmentTotal(optional):
number
The monetary total of manual adjustments.Example:
0
-
rawSubtotal(optional):
number
The monetary raw subtotal.Example:
21.99
-
shipping(optional):
number
The monetary cost of shipping.Example:
25
-
shippingSurchargeValue(optional):
number
Example:
0
-
subTotal(optional):
number
Example:
21.99
-
tax(optional):
number
Monetary tax amount.Example:
9.398
-
taxable(optional):
number
Example:
21.99
-
total(optional):
number
The monetary total: amount + shipping + tax. (read-only)Example:
56.39
-
totalWithoutTax(optional):
number
Example:
46.99
Nested Schema : recurringChargePriceInfo
Type:
object
Recurring charge price information.
Show Source
-
amount(optional):
number
The monetary amount of this recurring charge.Example:
21.99
-
currencyCode(optional):
string
The currency code for the monetary amounts. A three character currency code such as USD.Example:
USD
-
frequencyAmountTotals(optional):
array frequencyAmountTotals
The total for each recurring charge frequency
-
frequencyTaxTotals(optional):
array frequencyTaxTotals
The tax for each recurring charge frequency
-
shipping(optional):
number
Cost of shipping the product.Example:
25
-
subTotal(optional):
number
The sub-total price of the recurring charge.Example:
21.99
-
tax(optional):
number
Monetary tax amount.Example:
9.398
-
total(optional):
number
The total price of the recurring charge.Example:
56.39
-
totalWithoutTax(optional):
number
Total of recurring amount without tax included.Example:
46.39
Nested Schema : shippingMethod
Type:
object
The shipping method details for the order.
Show Source
-
cost(optional):
number
The total cost of shipping.Example:
25
-
rate(optional):
number
The effective tax rateExample:
0
-
secondaryCurrencyTaxAmount(optional):
number
Example:
0
-
shippingMethodDescription(optional):
string
The shipping method description.Example:
Two Day
-
shippingTax(optional):
number
The shipping tax.Example:
0
-
tax(optional):
number
The tax amount.Example:
5
-
taxable(optional):
number
The amount that is taxable.Example:
25
-
taxCode(optional):
string
The tax code for shipping method.Example:
TX1234
-
taxDetails(optional):
object taxDetails
-
value(optional):
string
The shipping method applied to this shipping group.Example:
twoDayShippingMethod
Nested Schema : taxPriceInfo
Type:
object
The tax pricing details for the order.
Show Source
-
amount(optional):
number
The monetary amount.Example:
9.4
-
cityTax(optional):
number
The monetary amount of city tax.Example:
4.699
-
countryTax(optional):
number
The monetary amount of country tax.Example:
0
-
countyTax(optional):
number
The monetary amount of county tax.Example:
0
-
districtTax(optional):
number
Tax amount for the district.Example:
0
-
isTaxIncluded(optional):
boolean
Whether the tax is included or notExample:
false
-
miscTax(optional):
number
The amount for miscTax.Example:
1.397
-
secondaryCurrencyTaxAmount(optional):
number
Example:
0
-
stateTax(optional):
number
Tax amount for the state.
-
valueAddedTax(optional):
number
The amount for valueAddedTax.Example:
0
Nested Schema : items
Type:
Show Source
object
-
availablePickupDate(optional):
string
The items available store pickup date.Example:
2018-05-19T13:00:00.000Z
-
backOrderQuantity(optional):
number
quantity in backorderExample:
0
-
catRefId(optional):
string
The catalog ref id.Example:
Sku_36Fxy
-
commerceId(optional):
string
commerce id of the itemExample:
ci3000424
-
commerceItemId(optional):
commerce item id of the itemExample:
ci3000421
-
discountAmount(optional):
number
The discount amount.Example:
0
-
discountInfo(optional):
array discountInfo
The discount information.
-
dynamicProperties(optional):
array dynamicProperties
List of dynamic properties at line item level.
-
externalData(optional):
array externalData
External data to be associated with a commerce item, provided by a third party system.
-
listPrice(optional):
number
The list price.Example:
21.99
-
onSale(optional):
boolean
Is item on sale.Example:
false
-
preferredPickupDate(optional):
string
The items preferred store pickup date.Example:
2018-05-19T13:00:00.000Z
-
preOrderQuantity(optional):
number
The pe-ordered itemsExample:
0
-
price(optional):
number
The price.Example:
21.99
-
productId(optional):
string
id of the productExample:
Product_36Exy
-
quantity(optional):
number
The quantity.Example:
1
-
rate(optional):
number
The tax rate.Example:
0
-
rawTotalPrice(optional):
number
The raw total price.Example:
21.99
-
returnedQuantity(optional):
number
The returned quantity.Example:
0
-
salePrice(optional):
number
The sale price.Example:
0
-
shippingSurchargeValue(optional):
number
The shipping surcharge if any.Example:
0
-
shopperInput(optional):
object shopperInput
Map of shopper input keys to values
-
siteId(optional):
string
The ID of the site on which the item was added.
-
stateDetailsAsUser(optional):
string
state details.Example:
The item has been initialized within the shipping group
-
status(optional):
string
status.Example:
INITIAL
-
tax(optional):
number
The tax.Example:
4.398
-
taxable(optional):
number
The taxable amount.Example:
21.99
-
taxDetails(optional):
array taxDetails
-
unitPrice(optional):
number
The unit price.Example:
21.99
Nested Schema : dynamicProperties
Type:
array
List of dynamic properties at line item level.
Show Source
Nested Schema : externalData
Type:
array
External data to be associated with a commerce item, provided by a third party system.
Show Source
Nested Schema : shopperInput
Type:
object
Map of shopper input keys to values
Show Source
-
additionalProperties(optional):
string
Example:
SkinBlonde
Nested Schema : items
Type:
Show Source
object
-
coupon(optional):
string
The coupon ID.Example:
CPN1234
-
promotionDesc(optional):
string
The promotion description.Example:
women lead promotion
-
promotionId(optional):
string
The promotion ID.Example:
PROMO123
Nested Schema : items
Type:
Show Source
object
-
id(optional):
string
The dynamic property id.Example:
11234
-
label(optional):
string
The dynamic property label.Example:
leadActor
-
value(optional):
string
The dynamic property value.Example:
women
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the externalData item by the third party system.Example:
ExternalActionCode
-
name(optional):
string
The name to be associated with the externalData item.Example:
ExternalProperty
-
values(optional):
object values
The map values associated with an externalData item.
Nested Schema : values
Type:
object
The map values associated with an externalData item.
Show Source
-
key(optional):
string
Map key defined by external system.Example:
Externalkey
-
value(optional):
string
Map value defined by external system.Example:
ExternalVal
Nested Schema : items
Type:
Show Source
object
-
jurisType(optional):
string
Jurisdiction Type like state tax,city taxExample:
state
-
rate(optional):
number
The tax rate.Example:
0.2
-
tax(optional):
number
The tax amount.Example:
2.199
-
taxName(optional):
string
The tax name like state, cityExample:
state tax
Nested Schema : frequencyAmountTotals
Type:
array
The total for each recurring charge frequency
Show Source
Nested Schema : frequencyTaxTotals
Type:
array
The tax for each recurring charge frequency
Show Source
Nested Schema : items
Type:
Show Source
object
-
frequency(optional):
string
The frequency for the item's total e.g. Monthly.Example:
Monthly
-
total(optional):
string
The total amount for the frequency.Example:
56.39
Nested Schema : items
Type:
Show Source
object
-
frequency(optional):
string
The frequency for the item's tax e.g. Monthly.Example:
Monthly
-
tax(optional):
string
The tax amount for the frequency.Example:
9.398
Nested Schema : taxDetails
Type:
Show Source
object
-
jurisType(optional):
string
Jurisdiction Type like state tax,city taxExample:
state
-
rate(optional):
number
The tax rate.Example:
0.2
-
tax(optional):
number
The tax amount.Example:
2.5
-
taxName(optional):
string
The tax name like state, cityExample:
state tax
Example Response (application/json)
{
"response":{
"shippingGroups":[
{
"taxPriceInfo":{
"cityTax":4.699,
"secondaryCurrencyTaxAmount":0,
"amount":9.4,
"valueAddedTax":0,
"countyTax":0,
"isTaxIncluded":false,
"miscTax":1.397,
"districtTax":0,
"stateTax":0,
"countryTax":0
},
"lastName":"Muir",
"firstName":"John",
"priceInfo":{
"discounted":false,
"amount":21.99,
"taxable":21.99,
"shippingSurchargeValue":0,
"manualAdjustmentTotal":0,
"discountAmount":0,
"tax":9.398,
"rawSubtotal":21.99,
"subTotal":21.99,
"totalWithoutTax":46.99,
"total":56.39,
"lkpValExcludingFreeShip":null,
"shipping":25,
"amountIsFinal":true,
"currencyCode":"USD"
},
"phoneNumber":"1231231234",
"recurringChargePriceInfo":{
"amount":21.99,
"total":56.39,
"frequencyAmountTotals":[
{
"total":56.39,
"frequency":"Monthly"
}
],
"shipping":25,
"tax":9.398,
"subTotal":21.99,
"frequencyTaxTotals":[
{
"tax":9.398,
"frequency":"Monthly"
}
],
"currencyCode":"USD",
"totalWithoutTax":46.39
},
"shippingMethod":{
"secondaryCurrencyTaxAmount":0,
"shippingTax":0,
"cost":25,
"taxable":25,
"taxDetails":{
"jurisType":"state",
"rate":0.2,
"tax":2.5,
"taxName":"state tax"
},
"rate":0,
"tax":5,
"taxCode":"TX1234",
"value":"twoDayShippingMethod",
"shippingMethodDescription":"Two Day"
},
"shippingGroupId":"sg40439",
"type":"hardgoodShippingGroup",
"items":[
{
"availablePickupDate":"2018-05-19T13:00:00.000Z",
"rawTotalPrice":21.99,
"taxDetails":[
{
"jurisType":"state",
"rate":0.2,
"tax":2.199,
"taxName":"state tax"
}
],
"returnedQuantity":0,
"dynamicProperties":[
{
"id":11234,
"label":"leadActor",
"value":"women"
}
],
"shippingSurchargeValue":0,
"discountAmount":0,
"externalData":[
{
"values":{
"value":"ExternalVal",
"key":"Externalkey"
},
"name":"ExternalProperty",
"actionCode":"ExternalActionCode"
}
],
"preOrderQuantity":0,
"commerceItemId":"ci3000421",
"rate":0,
"price":21.99,
"onSale":false,
"commerceId":"ci3000424",
"stateDetailsAsUser":"The item has been initialized within the shipping group",
"unitPrice":21.99,
"quantity":1,
"taxable":21.99,
"productId":"Product_36Exy",
"salePrice":0,
"preferredPickupDate":"2018-05-19T13:00:00.000Z",
"tax":4.398,
"catRefId":"Sku_36Fxy",
"discountInfo":[
{
"coupon":"CPN1234",
"promotionDesc":"women lead promotion",
"promotionId":"PROMO123"
}
],
"shopperInput":{
"additionalProperties":"SkinBlonde"
},
"backOrderQuantity":0,
"listPrice":21.99,
"status":"INITIAL"
}
],
"email":"john.muir@oracle.com"
}
],
"creationTime":1.532965750184E12,
"isTaxIncluded":false,
"orderId":"o30429",
"orderStatus":"Incomplete",
"creationDate":"2018-07-30T15:49:10.184Z",
"orderProfileId":111669,
"taxDate":"07-30-2018",
"callType":"SalesOrder",
"status":"success",
"timestamp":"2018-07-30T15:50:08.011Z"
}
}
Default Response
The error response.
Root Schema : externalTaxCalculation_response
Type:
object
The tax calculation response from external service
Show Source
Nested Schema : response
Type:
Show Source
object
-
callType(optional):
string
Example:
SalesOrder
-
creationDate(optional):
string
Example:
2018-07-30T15:49:10.184Z
-
creationTime(optional):
number
Example:
1.532965750184E12
-
errors(optional):
array errors
In case of failures, the Webhook can return back error details to Commerce. These error details are returned back to the Store and Agent endpoints.
-
isTaxIncluded(optional):
boolean
Example:
false
-
orderId(optional):
string
Example:
o30429
-
orderProfileId(optional):
string
Example:
111669
-
orderStatus(optional):
string
Example:
Incomplete
-
shippingGroups(optional):
array shippingGroups
-
status(optional):
string
Example:
success
-
taxDate(optional):
string
Example:
07-30-2018
-
timestamp(optional):
string
Example:
2018-07-30T15:50:08.011Z
Nested Schema : errors
Type:
array
In case of failures, the Webhook can return back error details to Commerce. These error details are returned back to the Store and Agent endpoints.
Show Source
Nested Schema : items
Type:
Show Source
object
-
description(optional):
string
Example:
Error description in detail
-
errorCode(optional):
number
Example:
0
Nested Schema : items
Type:
Show Source
object
-
email(optional):
string
The email address of the person responsible for picking up the contents of this shipping group.Example:
john.muir@oracle.com
-
firstName(optional):
string
The first name of the person responsible for picking up the contents of this shipping group.Example:
John
-
items(optional):
array items
-
lastName(optional):
string
The second name of the person responsible for picking up the contents of this shipping group.Example:
Muir
-
phoneNumber(optional):
string
The phone number of the person responsible for picking up the contents of this shipping group.Example:
1231231234
-
priceInfo(optional):
object priceInfo
Pricing information, an instance of OrderPriceInfo.
-
recurringChargePriceInfo(optional):
object recurringChargePriceInfo
Recurring charge price information.
-
shippingGroupId(optional):
string
The shipping group id.Example:
sg40439
-
shippingMethod(optional):
object shippingMethod
The shipping method details for the order.
-
taxPriceInfo(optional):
object taxPriceInfo
The tax pricing details for the order.
-
type(optional):
string
The type of the ShippingGroup. Ex - "hardgoodShippingGroup", "virtualShippingGroup" etc.Example:
hardgoodShippingGroup
Nested Schema : priceInfo
Type:
object
Pricing information, an instance of OrderPriceInfo.
Show Source
-
amount(optional):
number
The monetary amount.Example:
21.99
-
amountIsFinal(optional):
boolean
Whether the amount is final.Example:
true
-
currencyCode(optional):
string
The three character currency code for the monetary amounts.Example:
USD
-
discountAmount(optional):
number
The monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal. (read-only)Example:
0
-
discounted(optional):
boolean
Whether the price is discounted.Example:
false
-
lkpValExcludingFreeShip(optional):
number
The total shipping cost excluding items with free shipping.Example:
oracle.doceng.json.BetterJsonNull@d1c17eb
-
manualAdjustmentTotal(optional):
number
The monetary total of manual adjustments.Example:
0
-
rawSubtotal(optional):
number
The monetary raw subtotal.Example:
21.99
-
shipping(optional):
number
The monetary cost of shipping.Example:
25
-
shippingSurchargeValue(optional):
number
Example:
0
-
subTotal(optional):
number
Example:
21.99
-
tax(optional):
number
Monetary tax amount.Example:
9.398
-
taxable(optional):
number
Example:
21.99
-
total(optional):
number
The monetary total: amount + shipping + tax. (read-only)Example:
56.39
-
totalWithoutTax(optional):
number
Example:
46.99
Nested Schema : recurringChargePriceInfo
Type:
object
Recurring charge price information.
Show Source
-
amount(optional):
number
The monetary amount of this recurring charge.Example:
21.99
-
currencyCode(optional):
string
The currency code for the monetary amounts. A three character currency code such as USD.Example:
USD
-
frequencyAmountTotals(optional):
array frequencyAmountTotals
The total for each recurring charge frequency
-
frequencyTaxTotals(optional):
array frequencyTaxTotals
The tax for each recurring charge frequency
-
shipping(optional):
number
Cost of shipping the product.Example:
25
-
subTotal(optional):
number
The sub-total price of the recurring charge.Example:
21.99
-
tax(optional):
number
Monetary tax amount.Example:
9.398
-
total(optional):
number
The total price of the recurring charge.Example:
56.39
-
totalWithoutTax(optional):
number
Total of recurring amount without tax included.Example:
46.39
Nested Schema : shippingMethod
Type:
object
The shipping method details for the order.
Show Source
-
cost(optional):
number
The total cost of shipping.Example:
25
-
rate(optional):
number
The effective tax rateExample:
0
-
secondaryCurrencyTaxAmount(optional):
number
Example:
0
-
shippingMethodDescription(optional):
string
The shipping method description.Example:
Two Day
-
shippingTax(optional):
number
The shipping tax.Example:
0
-
tax(optional):
number
The tax amount.Example:
5
-
taxable(optional):
number
The amount that is taxable.Example:
25
-
taxCode(optional):
string
The tax code for shipping method.Example:
TX1234
-
taxDetails(optional):
object taxDetails
-
value(optional):
string
The shipping method applied to this shipping group.Example:
twoDayShippingMethod
Nested Schema : taxPriceInfo
Type:
object
The tax pricing details for the order.
Show Source
-
amount(optional):
number
The monetary amount.Example:
9.4
-
cityTax(optional):
number
The monetary amount of city tax.Example:
4.699
-
countryTax(optional):
number
The monetary amount of country tax.Example:
0
-
countyTax(optional):
number
The monetary amount of county tax.Example:
0
-
districtTax(optional):
number
Tax amount for the district.Example:
0
-
isTaxIncluded(optional):
boolean
Whether the tax is included or notExample:
false
-
miscTax(optional):
number
The amount for miscTax.Example:
1.397
-
secondaryCurrencyTaxAmount(optional):
number
Example:
0
-
stateTax(optional):
number
Tax amount for the state.
-
valueAddedTax(optional):
number
The amount for valueAddedTax.Example:
0
Nested Schema : items
Type:
Show Source
object
-
availablePickupDate(optional):
string
The items available store pickup date.Example:
2018-05-19T13:00:00.000Z
-
backOrderQuantity(optional):
number
quantity in backorderExample:
0
-
catRefId(optional):
string
The catalog ref id.Example:
Sku_36Fxy
-
commerceId(optional):
string
commerce id of the itemExample:
ci3000424
-
commerceItemId(optional):
commerce item id of the itemExample:
ci3000421
-
discountAmount(optional):
number
The discount amount.Example:
0
-
discountInfo(optional):
array discountInfo
The discount information.
-
dynamicProperties(optional):
array dynamicProperties
List of dynamic properties at line item level.
-
externalData(optional):
array externalData
External data to be associated with a commerce item, provided by a third party system.
-
listPrice(optional):
number
The list price.Example:
21.99
-
onSale(optional):
boolean
Is item on sale.Example:
false
-
preferredPickupDate(optional):
string
The items preferred store pickup date.Example:
2018-05-19T13:00:00.000Z
-
preOrderQuantity(optional):
number
The pe-ordered itemsExample:
0
-
price(optional):
number
The price.Example:
21.99
-
productId(optional):
string
id of the productExample:
Product_36Exy
-
quantity(optional):
number
The quantity.Example:
1
-
rate(optional):
number
The tax rate.Example:
0
-
rawTotalPrice(optional):
number
The raw total price.Example:
21.99
-
returnedQuantity(optional):
number
The returned quantity.Example:
0
-
salePrice(optional):
number
The sale price.Example:
0
-
shippingSurchargeValue(optional):
number
The shipping surcharge if any.Example:
0
-
shopperInput(optional):
object shopperInput
Map of shopper input keys to values
-
siteId(optional):
string
The ID of the site on which the item was added.
-
stateDetailsAsUser(optional):
string
state details.Example:
The item has been initialized within the shipping group
-
status(optional):
string
status.Example:
INITIAL
-
tax(optional):
number
The tax.Example:
4.398
-
taxable(optional):
number
The taxable amount.Example:
21.99
-
taxDetails(optional):
array taxDetails
-
unitPrice(optional):
number
The unit price.Example:
21.99
Nested Schema : dynamicProperties
Type:
array
List of dynamic properties at line item level.
Show Source
Nested Schema : externalData
Type:
array
External data to be associated with a commerce item, provided by a third party system.
Show Source
Nested Schema : shopperInput
Type:
object
Map of shopper input keys to values
Show Source
-
additionalProperties(optional):
string
Example:
SkinBlonde
Nested Schema : items
Type:
Show Source
object
-
coupon(optional):
string
The coupon ID.Example:
CPN1234
-
promotionDesc(optional):
string
The promotion description.Example:
women lead promotion
-
promotionId(optional):
string
The promotion ID.Example:
PROMO123
Nested Schema : items
Type:
Show Source
object
-
id(optional):
string
The dynamic property id.Example:
11234
-
label(optional):
string
The dynamic property label.Example:
leadActor
-
value(optional):
string
The dynamic property value.Example:
women
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the externalData item by the third party system.Example:
ExternalActionCode
-
name(optional):
string
The name to be associated with the externalData item.Example:
ExternalProperty
-
values(optional):
object values
The map values associated with an externalData item.
Nested Schema : values
Type:
object
The map values associated with an externalData item.
Show Source
-
key(optional):
string
Map key defined by external system.Example:
Externalkey
-
value(optional):
string
Map value defined by external system.Example:
ExternalVal
Nested Schema : items
Type:
Show Source
object
-
jurisType(optional):
string
Jurisdiction Type like state tax,city taxExample:
state
-
rate(optional):
number
The tax rate.Example:
0.2
-
tax(optional):
number
The tax amount.Example:
2.199
-
taxName(optional):
string
The tax name like state, cityExample:
state tax
Nested Schema : frequencyAmountTotals
Type:
array
The total for each recurring charge frequency
Show Source
Nested Schema : frequencyTaxTotals
Type:
array
The tax for each recurring charge frequency
Show Source
Nested Schema : items
Type:
Show Source
object
-
frequency(optional):
string
The frequency for the item's total e.g. Monthly.Example:
Monthly
-
total(optional):
string
The total amount for the frequency.Example:
56.39
Nested Schema : items
Type:
Show Source
object
-
frequency(optional):
string
The frequency for the item's tax e.g. Monthly.Example:
Monthly
-
tax(optional):
string
The tax amount for the frequency.Example:
9.398
Nested Schema : taxDetails
Type:
Show Source
object
-
jurisType(optional):
string
Jurisdiction Type like state tax,city taxExample:
state
-
rate(optional):
number
The tax rate.Example:
0.2
-
tax(optional):
number
The tax amount.Example:
2.5
-
taxName(optional):
string
The tax name like state, cityExample:
state tax
Example Response (application/json)
{
"response":{
"errors":[
{
"errorCode":1111,
"description":"Error message one"
},
{
"errorCode":2222,
"description":"Error message two"
}
],
"status":"failed"
}
}