For the complete documentation index, see llms.txt. This page is also available as Markdown.

Shipping price

The object below is returned directly or within a successful response from the following API request:

Retrieve shipping price

Shipping price object

Parameter
Type / Description

Shipping prices available

Array of objects

Details below

Name

String Name of the shipping method available for the cart configuration.

Code

String System-generated identified assigned to the shipping method.

TrackingURL

String Tracking URL defined at shipping method leve.

Currency

String Currency in which shipping prices are expressed.

PriceDetails

Object Details below.

Net

Object Shipping price for a NET price configuration.

Net.TotalAmount

Int Total shipping price charged from customers for a cart configuration.

Net.BasePrice

Int Shipping method base price amount.

Net.OverweightAmount

Int Overweight amount applied to the purchase.

Net.CountrySurcharge

Int Surcharge applied based on customer delivery country.

Net.WeightSurcharge

Int Surcharged applied based on total order weight.

Net.OrderSurcharge

Int Surcharged applied based on total order amount.

Gross

Object Shipping price for a GROSS price configuration.

Gross.TotalAmount

Int Total shipping price charged from customers for a cart configuration.

Gross.BasePrice

Int Shipping method base price amount.

Gross.OverweightAmount

Int Overweight amount applied to the purchase.

Gross.CountrySurcharge

Int Surcharge applied based on customer delivery country.

Gross.WeightSurcharge

Int Surcharged applied based on total order weight.

Gross.OrderSurcharge

Int Surcharged applied based on total order amount.

Last updated

Was this helpful?