The shipping method object and the allowed CRUD operations on the related resource endpoint
Shipping methods are used to provide customers with different delivery options.
- Set the
stock_locationrelationship 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
max_weightattributes (to do that also a
unit_of_weightmust 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.
Each shipping method can have a price and can be free over a specific order's total amount. Set the
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
schemeattribute (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
external— the shipping method price is fetched from an external service which handles the custom calculation, overriding the
price_amount_centsset at creation time (remember to specify the
external_prices_urlwhen creating or updating the shipping method).
free_over_amountwas specified, it applies regardless of the tier. If a
max_weightvalue for the shipping method's availability was specified, only the tiers between those values will be considered.