Call external service to determine available shipping methods and prices.

post

/ccadmin/v1/webhook/calculateShipping

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.

Request

Supported Media Types
Body ()
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
Nested Schema : availableExternallyPricedShippingMethods
Type: array
Available externally priced shipping methods.
Show Source
Nested Schema : order
Type: object
Show Source
Nested Schema : productInformation
Type: object
Show Source
Nested Schema : profile
Type: object
Show Source
Nested Schema : request
Type: object
Show Source
Nested Schema : shippingGroupIdsToPrice
Type: array
List of shipping group ids provided by the client for retrieval of shipping methods.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : associatedPriceListGroups
Type: object
The associated Price list groups for this Shipping Method.
Show Source
Nested Schema : excludedCategoriesShippingCharge
Type: array
Excluded categories for shipping charges.
Show Source
Nested Schema : ranges
Type: array
The price ranges for this shipping method.
Show Source
Nested Schema : sites
Type: array
Sites that the shipping method is available to.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : discountInfo
Type: object
The discount information.
Show Source
Nested Schema : dynamicProperties
Type: array
List of dynamic properties at line item level.
Show Source
Nested Schema : giftWithPurchaseInfo
Type: array
Show Source
Nested Schema : payments
Type: array
Show Source
Nested Schema : priceInfo
Type: object
Show Source
Nested Schema : priceListGroup
Type: object
Show Source
Nested Schema : recurringChargePriceInfo
Type: object
Recurring charge price information.
Show Source
Nested Schema : shippingAddress
Type: object
Show Source
Nested Schema : shippingGroups
Type: array
Show Source
Nested Schema : shippingMethod
Type: object
Show Source
Nested Schema : shoppingCart
Type: object
Show Source
Nested Schema : taxPriceInfo
Type: object
Show Source
Nested Schema : claimedCouponMultiPromotions
Type: object
Show Source
Nested Schema : orderCouponsMap
Type: array
The list of all the coupons with the order
Show Source
Nested Schema : orderImplicitDiscountList
Type: array
Show Source
Nested Schema : unclaimedCouponMultiPromotions
Type: object
Show Source
Nested Schema : unclaimedCouponsMap
Type: object
Show Source
Nested Schema : promotions
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : promotionInfo
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
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: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : discountInfo
Type: object
The discount information.
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : priceInfo
Type: object
The price information.
Show Source
Nested Schema : recurringChargePriceInfo
Type: object
Recurring charge price information.
Show Source
Nested Schema : shippingAddress
Type: object
The shipping address details.
Show Source
Nested Schema : shippingMethod
Type: object
The shipping method details for the order.
Show Source
Nested Schema : store
Type: object
The store is present in the request if the type is inStorePickupShippingGroup.
Show Source
Nested Schema : taxPriceInfo
Type: object
The shipping address details.
Show Source
Nested Schema : claimedCouponMultiPromotions
Type: object
Show Source
Nested Schema : orderCouponsMap
Type: array
The list of all the coupons with the order
Show Source
Nested Schema : orderImplicitDiscountList
Type: array
Show Source
Nested Schema : unclaimedCouponMultiPromotions
Type: object
Show Source
Nested Schema : unclaimedCouponsMap
Type: object
Show Source
Nested Schema : promotions
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : promotionInfo
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : childItems
Type: array
Show Source
Nested Schema : detailedItemPriceInfo
Type: array
Show Source
Nested Schema : detailedRecurringChargeInfo
Type: object
Detailed Item Price Information.
Show Source
Nested Schema : discountInfo
Type: array
Whether this item is discounted.
Show Source
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
Additional Properties Allowed
Show Source
Map of shopper input keys to values
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : giftWithPurchaseDiscountInfo
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : values
Type: object
The map values associated with an externalData item.
Show Source
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: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: array
Show Source