calculateShipping

post

/ccadmin/v1/webhook/calculateShipping

This event is triggered at 'add to cart' page requesting for external shipping pricing details

• Request
• Response

Request

Supported Media Types

• application/json

Body Parameter

This event is triggered at 'add to cart' page requesting for external shipping pricing details

Root Schema : calculateShipping_request

This event is triggered at 'add to cart' page requesting for external shipping pricing details

Properties

request

Type: object request

Additional Properties Allowed:

Nested Schema : request

Type: object

Properties

address

Type: object address

Additional Properties Allowed:

Address

currencyCode

Type: string

Indicates the currency of the price. For example, USD indicates that the price is in US dollars.

exchangeRate

Type: number

exchangeRate

items

Type: array items

Additional Properties Allowed:

items

locale

Type: object locale

Additional Properties Allowed:

locale

orderDiscount

Type: number

Discount given on an order.

orderTotal

Type: number

The total price of the order.

rawOrderTotal

Type: number

the raw order total

secondaryCurrencyCode

Type: string

Secondary currencyCode

siteId

Type: string

site associated with this request

Nested Schema : address

Type: object

Address

Properties

address1

Type: string

address1 of the person

address2

Type: string

address2 of the person

country

Type: string

the country of the Address

firstName

Type: string

firstName of person

lastName

Type: string

lastName of person

postalCode

Type: string

postalCode of the person

state

Type: string

state of the person

Nested Schema : items

Type: array

items

Items

• Type: object items
  Additional Properties Allowed:

Nested Schema : locale

Type: object

locale

Properties

country

Type: string

country

displayName

Type: string

the display name

language

Type: string

language

Nested Schema : items

Type: object

Properties

amount

Type: number

amount

catalogRefId

Type: string

The catalog ref id

discount

Type: number

discount of the order

product

Type: object product

Additional Properties Allowed:

product

quantity

Type: integer

quantity

rawTotalPrice

Type: number

The raw total price.

Nested Schema : product

Type: object

product

Properties

height

Type: number

height of the product

id

Type: string

id of the product

length

Type: number

length of the product

shippingSurcharge

Type: number

Extra handling cost for shipping the product.

taxCode

Type: string

Tax Code of the product.

weight

Type: number

weight of the product

width

Type: number

width of the product

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : calculateShipping_response

Properties

error

Type: object error

Additional Properties Allowed:

shippingMethods

Type: array shippingMethods

Additional Properties Allowed:

shippingMethods

Nested Schema : error

Type: object

Properties

code

Type: string

message

Type: string

Nested Schema : shippingMethods

Type: array

shippingMethods

Items

• Type: object items
  Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

carrierId

Type: string

the id of carrier

currency

Type: string

the currency

deliveryDays

Type: integer

the number of delivery days

displayName

Type: string

the display name

eligibleForProductWithSurcharges

Type: boolean

Whether this shipping method is enabled for products with surcharges or not. Defaults to null.

estimatedDeliveryDate

Type: string

the estimated delivery date

estimatedDeliveryDateGuaranteed

Type: boolean

Whether the delivery date is guaranteed

internationalDutiesTaxesFees

Type: number

the international tax duties

shippingCost

Type: number

the cost of shipping

shippingTax

Type: number

the shipping tax

shippingTotal

Type: number

The total shipping

taxcode

Type: string

the tax code