Inventory API
Shippings
Update Shipping
This API endpoint (POST) updates an existing shipping method. If the request succeeds it returns a Shipping Object.
Permissions: shippings.edit
Webhook event: shipping-updated
id * The id of the shipping.
label string * The label of the shipping method.
currency string Currency code * The currency of the shipping method.
destination array of strings Country Codes * The countries served by this shipping method.
price integer * The cost of shipments per unit.
active boolean * This attribute shows whether the shipping method is enabled.
postcodes array of strings An array of postcodes to use for filtering when customers attempt to make an order.
states array of strings An array of states to use for filtering when customers attempt to make an order.
bundling_rules array of objects An array of objects, each corresponding to a bundling rule.
- cost integer The base shipping cost to apply for this bundling rule.
- cost_rule string This attribute shows how the shipping cost for this bundling rule will be charged. The possible values are unit (cost * quantity) and fixed.
- type string The possible values are range and max. If set to max, the bundling rule will be activated on orders whose total quantity is more than the maximum (max). For range, the rule will be activated if the order quantity is between the configured range values (from and to).
- max integer Orders with quantity larger than this value will activate the bundling rule. Provided if the type is set to max.
- from integer The starting value of the bundling range. Provided if the rule type is set to range.
- to integer The end value of the bundling range. Provided if the rule type is set to range.