Shipping price
The object below is returned directly or within a successful response from the following API requests:
Shipping price object
Shipping prices available
Array of objects
Details below
Shipping prices available.Name
String Name of the shipping method available for the cart configuration.
Shipping prices available.Code
String System-generated identified assigned to the shipping method.
Shipping prices available.TrackingURL
String Tracking URL defined at shipping method leve.
Shipping prices available.Currency
String Currency in which shipping prices are expressed.
Shipping prices available.PriceDetails
Object Details below.
Shipping prices available.PriceDetails.Net
Object Shipping price for a NET price configuration.
Shipping prices available.PriceDetails.Net.TotalAmount
Int Total shipping price charged from customers for a cart configuration.
Shipping prices available.PriceDetails.Net.BasePrice
Int Shipping method base price amount.
Shipping prices available.PriceDetails.Net.OverweightAmount
Int Overweight amount applied to the purchase.
Shipping prices available.PriceDetails.Net.CountrySurcharge
Int Surcharge applied based on customer delivery country.
Shipping prices available.PriceDetails.Net.WeightSurcharge
Int Surcharged applied based on total order weight.
Shipping prices available.PriceDetails.Net.OrderSurcharge
Int Surcharged applied based on total order amount.
Shipping prices available.PriceDetails.Gross
Object Shipping price for a GROSS price configuration.
Shipping prices available.PriceDetails.Gross.TotalAmount
Int Total shipping price charged from customers for a cart configuration.
Shipping prices available.PriceDetails.Gross.BasePrice
Int Shipping method base price amount.
Shipping prices available.PriceDetails.Gross.OverweightAmount
Int Overweight amount applied to the purchase.
Shipping prices available.PriceDetails.Gross.CountrySurcharge
Int Surcharge applied based on customer delivery country.
Shipping prices available.PriceDetails.Gross.WeightSurcharge
Int Surcharged applied based on total order weight.
Shipping prices available.PriceDetails.Gross.OrderSurcharge
Int Surcharged applied based on total order amount.
Last updated
Was this helpful?