Shipping methods
The shipping method object and the allowed CRUD operations on the related resource endpoint
Last updated
API reference
The shipping method object and the allowed CRUD operations on the related resource endpoint
Last updated
Shipping methods are used to provide customers with different delivery options.
Shipping methods are defined by currency and can be restricted to an active (in the latter case the currency is inherited by the market's price list).
Set the shipping_category relationship if you want the shipping method to be available only if the items to be shipped belong to a specified .
Set the shipping_zone relationship if you want the shipping method to be available only if the shipping address belongs to a specified .
Set the stock_location relationship if you want the shipping method to be available only if the items are shipped from a specific stock location.
Specify a value for the tax_code attribute if you want to use a custom tax code for your shipments tax calculation (currently supported by only).
Specify a value for the min_weight and/or max_weight attributes (to do that also a unit_of_weight must be defined) if you want the shipping method to be available only if the total weight of the items to be shipped falls within those values.
A shipping method that is not already associated with any market, stock location, shipping category, or shipping zone can be set as the for one or more markets. To do that:
a new shipping method and keep it as more generic as possible by setting the required parameters only:
name
currency_code
price_amount_cents
Now you can set that shipping method as the default for one or more markets as long as they are associated with a price list in the same currency.
In this case, (if any) will be ignored.
Each shipping method can have a price and can be free over a specific order's total amount. Set the use_subtotal attribute to true (default is false) if you want to compare the free over amount with the order's subtotal and exclude other discount calculations (if any).
Set the proper value for the scheme attribute (default is flat) to define how you want to manage the shipping method cost:
flat — the shipping method has a fixed price (equal to the value of the price_amount_cents attribute).
weight_tiered — the shipping method price is based on the total weight of the items included in the shipment (a maximum of 5 tiers for each shipping method is currently supported). See to learn more.
external — the shipping method price is fetched which handles the custom calculation, overriding the price_amount_cents set at creation time (remember to specify the external_prices_url when creating or updating the shipping method).
If you want to apply a (e.g. charging your customers with one single shipping cost for the whole order) you can set to 0 the unit amount of some of the line items of type shipments that are created when a shipping method is associated with an order's shipments. To do that, leverage the dedicated attribute at the market level.
Check the related and explore the flowchart that illustrates how the shipping method resource relates to the other API entities.
Check the related to learn how to let a user choose one of the available shipping methods during the checkout. Learn how to manage the shipping methods cost .