REST API for Oracle Commerce Cloud December 2017

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

Body Parameter

This event is triggered at checkout page to get tax for cart from external service

Root Schema : externalTaxCalculation_request

This event is triggered at checkout page to get tax for cart from external service

Properties

request: Type: object request

Additional Properties Allowed:

Nested Schema : request

Type: object

Properties

callType: Type: string

The tax call type.
creationDate: Type: string

The order creation date.
creationTime: Type: number

The creation time of the order.
currencyConversionEnabled: Type: boolean

Indicates whether currency conversion is enabled
discountInfo: Type: object discountInfo

Additional Properties Allowed:

The discount information.
exchangeRate: Type: number

The conversion rate between the order currency and base currency.
giftWithPurchaseInfo: Type: array giftWithPurchaseInfo

Additional Properties Allowed:
isTaxIncluded: Type: boolean

Indicates whether order is inclusive of tax.
orderCurrencyCode: Type: string

The currency code of the order currency
orderId: Type: string

The ID of the order.
orderProfileId: Type: string

The profile id on the order.
orderStatus: Type: string

The order status.
priceInfo: Type: object priceInfo

Additional Properties Allowed:
profile: Type: object profile

Additional Properties Allowed:
secondaryCurrencyCode: Type: string

The currency code of secondary currency.
shipFromAddress: Type: object shipFromAddress

Additional Properties Allowed:
shippingGroups: Type: array shippingGroups

Additional Properties Allowed:
shoppingCart: Type: object shoppingCart

Additional Properties Allowed:

Nested Schema : discountInfo

Type: object

The discount information.

Properties

orderCouponsMap: Type: array orderCouponsMap

Additional Properties Allowed:

The list of all the coupons with the order.
orderDiscount: Type: integer

The order discount.
shippingDiscount: Type: integer

The shipping discount.

Nested Schema : giftWithPurchaseInfo

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : priceInfo

Type: object

Properties

amount: Type: number
currencyCode: Type: string
shipping: Type: number
shippingSurchargeValue: Type: number
subTotal: Type: number
tax: Type: number
total: Type: number
totalWithoutTax: Type: number

Nested Schema : profile

Type: object

Properties

daytimeTelephoneNumber: Type: string

The day time phone number of the profile
email: Type: string
firstName: Type: string
id: Type: string

Id
lastName: Type: string
locale: Type: string
loyaltyPrograms: Type: array loyaltyPrograms

Additional Properties Allowed:

Loyalty Programs Information
receiveEmail: Type: string

The string representation of whether the user wants to receive email or not
sitePropertiesList: Type: array sitePropertiesList

Additional Properties Allowed:

The list of site related properties for the profile

Nested Schema : shipFromAddress

Type: object

Properties

address1: Type: string
address2: Type: string
address3: Type: string
city: Type: string
companyName: Type: string
country: Type: string
county: Type: string
email: Type: string
faxNumber: Type: integer
firstName: Type: string
jobTitle: Type: string
lastName: Type: string
middleName: Type: string
phoneNumber: Type: integer
postalCode: Type: string
prefix: Type: string
state: Type: string
suffix: Type: string

Nested Schema : shippingGroups

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : shoppingCart

Type: object

Properties

items: Type: array items

Additional Properties Allowed:
numberOfItems: Type: integer

Nested Schema : orderCouponsMap

Type: array

The list of all the coupons with the order.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

promotionDesc: Type: string

The promotion description.
promotionId: Type: string

The promotion ID.
promotionLevel: Type: string

The promotion level.
totalAdjustment: Type: string

The total adjustment.

Nested Schema : items

Type: object

Properties

giftWithPurchaseDetail: Type: string

String identifying the free gift, usually the repository id of the gift type.
giftWithPurchaseIdentifier: Type: 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.
giftWithPurchaseQuantityAvailableForSelection: Type: number

gift quantity available for selection
giftWithPurchaseType: Type: string

The type of the gift. (sku, product)
promotionId: Type: string

The gift with purchase promotion id

Nested Schema : loyaltyPrograms

Type: array

Loyalty Programs Information

Items

Type: object items

Additional Properties Allowed:

Nested Schema : sitePropertiesList

Type: array

The list of site related properties for the profile

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

membershipId: Type: string

membershipId of the profile.
programId: Type: string

programId of Loyalty Program
programName: Type: string

programName of Loyalty Program
repositoryId: Type: string

repository Id
status: Type: string

status of Enrollment.

Nested Schema : items

Type: object

Properties

properties: Type: object properties

Additional Properties Allowed:

The site related properties for the profile
site: Type: object site

Additional Properties Allowed:

The site data

Nested Schema : properties

Type: object

The site related properties for the profile

Properties

receiveEmail: Type: string

Indicates whether the user should receive marketing emails on the current site. Can be yes or no.

Nested Schema : site

Type: object

The site data

Properties

id: Type: string

The id of the site

Nested Schema : items

Type: object

Properties

discountInfo: Type: object discountInfo

Additional Properties Allowed:

The discount information.
items: Type: array items

Additional Properties Allowed:
priceInfo: Type: object priceInfo

Additional Properties Allowed:
shippingAddress: Type: object shippingAddress

Additional Properties Allowed:
shippingGroupId: Type: string

The shipping group id.
shippingMethod: Type: object shippingMethod

Additional Properties Allowed:

The shipping method details for the order.

Nested Schema : discountInfo

Type: object

The discount information.

Properties

orderDiscount: Type: integer

The discount.
shippingDiscount: Type: integer

The shipping discount.

Nested Schema : items

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : priceInfo

Type: object

Properties

amount: Type: number
currencyCode: Type: string
shipping: Type: number
shippingSurchargeValue: Type: number
subTotal: Type: number
tax: Type: number
total: Type: number
totalWithoutTax: Type: number

Nested Schema : shippingAddress

Type: object

Properties

address1: Type: string
address2: Type: string
address3: Type: string
city: Type: string
companyName: Type: string
country: Type: string
county: Type: string
email: Type: string
faxNumber: Type: integer
firstName: Type: string
jobTitle: Type: string
lastName: Type: string
middleName: Type: string
phoneNumber: Type: integer
postalCode: Type: string
prefix: Type: string
state: Type: string
suffix: Type: string

Nested Schema : shippingMethod

Type: object

The shipping method details for the order.

Properties

cost: Type: number

The cost of shipping.
shippingMethodDescription: Type: string

The shipping method description.
shippingTax: Type: number

The shipping tax.
taxCode: Type: string

The tax code for shipping method.
value: Type: string

The shipping method .

Nested Schema : items

Type: object

Properties

catRefId: Type: string

The catalog ref id.
discountAmount: Type: number

The discount amount.
listPrice: Type: number

The list price.
onSale: Type: number

Is item on sale.
price: Type: number

The price.
quantity: Type: number

The quantity.
rawTotalPrice: Type: number

The raw total price.
returnedQuantity: Type: number

The returned quantity.
salePrice: Type: number

The sale price.
shippingSurchargeValue: Type: number

The shipping surcharge if any.
stateDetailsAsUser: Type: string

state details.
status: Type: string

status.
unitPrice: Type: number

The unit price.

Nested Schema : items

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

catRefId: Type: string
configuratorId: Type: string
description: Type: string
detailedItemPriceInfo: Type: array detailedItemPriceInfo

Additional Properties Allowed:
discountAmount: Type: number
discountInfo: Type: array discountInfo

Additional Properties Allowed:

The discount information.
displayName: Type: string
dynamicProperties: Type: array dynamicProperties

Additional Properties Allowed:

List of dynamic properties at line item level.
externalPrice: Type: number
externalPriceQuantity: Type: integer
id: Type: string
isItemValid: Type: boolean
listPrice: Type: number
onSale: Type: boolean
price: Type: number
primaryThumbImageURL: Type: string
productId: Type: string
quantity: Type: integer
rawTotalPrice: Type: number
salePrice: Type: number
shippingSurchargeValue: Type: integer
unitPrice: Type: number
variant: Type: array variant

Additional Properties Allowed:

List of variants for the product.

Nested Schema : detailedItemPriceInfo

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : discountInfo

Type: array

The discount information.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : dynamicProperties

Type: array

List of dynamic properties at line item level.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : variant

Type: array

List of variants for the product.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

amount: Type: number
currencyCode: Type: string
detailedUnitPrice: Type: number
discounted: Type: boolean
orderDiscountShare: Type: integer
quantity: Type: integer
tax: Type: number

Nested Schema : items

Type: object

Properties

coupon: Type: string

The coupon ID.
promotionDesc: Type: string

The promotion description.
promotionId: Type: string

The promotion ID.

Nested Schema : items

Type: object

Properties

id: Type: string

The dynamic property id.
label: Type: string

The dynamic property label.
value: Type: string

The dynamic property value.

Nested Schema : items

Type: object

Properties

optionName: Type: string

The variant option name.
optionValue: Type: string

The variant option value.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

The tax calculation response from external service

Root Schema : externalTaxCalculation_response

The tax calculation response from external service

Properties

response: Type: object response

Additional Properties Allowed:

Nested Schema : response

Type: object

Properties

callType: Type: string
creationDate: Type: string
creationTime: Type: number
errors: Type: array errors

Additional Properties Allowed:
isTaxIncluded: Type: boolean
orderId: Type: string
orderProfileId: Type: string
orderStatus: Type: string
shippingGroups: Type: array shippingGroups

Additional Properties Allowed:
status: Type: string
taxDate: Type: string
timestamp: Type: string

Nested Schema : errors

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : shippingGroups

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

description: Type: string
errorCode: Type: integer

Nested Schema : items

Type: object

Properties

items: Type: array items

Additional Properties Allowed:
priceInfo: Type: object priceInfo

Additional Properties Allowed:

Pricing information, an instance of OrderPriceInfo.
shippingGroupId: Type: string

The shipping group id.
shippingMethod: Type: object shippingMethod

Additional Properties Allowed:

The shipping method details for the order.
taxPriceInfo: Type: object taxPriceInfo

Additional Properties Allowed:

The tax pricing details for the order.

Nested Schema : items

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : priceInfo

Type: object

Pricing information, an instance of OrderPriceInfo.

Properties

amount: Type: number

The monetary amount.
amountIsFinal: Type: boolean

Whether the amount is final.
currencyCode: Type: string

The three character currency code for the monetary amounts.
discountAmount: Type: number

The monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal. (read-only)
discounted: Type: boolean

Whether the price is discounted.
manualAdjustmentTotal: Type: number

The monetary total of manual adjustments.
rawSubtotal: Type: number

The monetary raw subtotal.
shipping: Type: number

The monetary cost of shipping.
tax: Type: number

Monetary tax amount.
total: Type: number

The monetary total: amount + shipping + tax. (read-only)