Shipping method
The object below is returned directly or within a successful response from the following API request:
Shipping method object
Items
Array of objects Contains shipping methods objects.
Items.ShippingMethod
Shipping method object.
Details below.
Items.ShippingMethod.Name
String Shipping method name that you define when creating the method.
Items.ShippingMethod.Code
String System-generated identified for the shipping method.
Items.ShippingMethod.TrackingURL
String URL assigned to the shipping method. Provided to your customers that purchase physical products.
Items.ShippingMethod.BasePrice
String Base fee attached to the shipping method, that will be charged to customers when shipping method is available in cart, regardless of their country, product value or weight.
Items.ShippingMethod.Currency
String Currency in which the base fee is expressed. Example: 'USD'.
Items.ShippingMethod.Active
Boolean
Possible values:
TRUE - if shipping method is active.
FALSE - if shipping method is inactive.
Items.ShippingMethod.Availablity
String
Defined where the shipping method is active.
Possible values:
ALL - all delivery countries.
CUSTOM - selected delivery countries.
HOME - only your home country.
Items.ShippingMethod.Countries
Array of objects Countries where the shipping method applies.
Items.ShippingMethod.Countries.CountryCode
String Two-letters country code.
Items.ShippingMethod.Countries.Surcharge
String Surcharge defined for each country.
Items.ShippingMethod.Surcharge
Array of objects Additional fee assigned to the shipping method.
Items.ShippingMethod.Surcharge.Type
String
Order property based on which the surcharge is added.
Possible values:
PRICE - surcharge is based on total order amount.
WEIGHT - surcharged is based on total order weight.
Items.ShippingMethod.Surcharge.From
Float Lower interval limit.
Items.ShippingMethod.Surcharge.To
Int Higher interval limit.
Items.ShippingMethod.Surcharge.Amount
Int Surcharge defined based on order price/weight.
Items.ShippingMethod.Surcharge.ApplyTo
String
Possible values:
interval - surcharge is added for a given interval. Example: from 1 kg to 4kg.
unit - surcharge is added for each additional unit. Example: $5 for each unit over 4 kg.
Items.Pagination
Object Pagination filters.
Items.Pagination.Page
Int Number of pages used for displaying the results.
Items.Pagination.Limit
Int Number for limiting the results.
Items.Pagination.Count
Int Total number of results.
Last updated
Was this helpful?