Shipping defaults are the fallback values applied to your shipments. Whenever a shipment does not specify a value itself, your default is used instead — so you can set a default weight, shipping method, insurance, customs options, and label options once rather than repeating them on every shipment.
Endpoints
How updates work
Updates are partial: only the fields you send are changed, and anything you omit keeps its current value. To remove a default, send null for ship_with or insurance. To print no extra information on your labels, send an empty label_notes array.
Your default weight and default shipping method are validated together. If the shipping method you select does not support your default weight, the request is rejected with a 400 error.
Applying defaults to a shipment
Shipping defaults are applied when you create a shipment through the shipping rules endpoints. See Shipping rules & shipping defaults for the full flow.
Development status
The Shipping Defaults v3 API is currently in beta, meaning that it is still under development.
During this phase, we continually monitor and test the API to improve its performance, review the requested and the returned data, and uncover any potential bugs that could have a future impact on our users.
Please note that there is a possibility of experiencing breaking changes while the API is still in beta.
