Skip to main content
PATCH

Authorizations

Authorization
string
header
required

Basic Authentication using API key and secrets is currently the main authentication mechanism.

Body

application/json

The shipping defaults to change. Every field is optional; anything you omit keeps its current value.

weight
Weight · object

The default weight of a parcel. Only kg is supported, with up to three decimal places.

ship_with
ShipWithShippingMethodId · object | null

The shipping method to apply by default. Send null to remove the default.

insurance
PercentageInsurance · object

The insurance to apply by default. Send null to remove the default.

customs_options
CustomsOptionsUpdate · object

The customs defaults to change. Every field is optional.

label_options
LabelOptionsUpdate · object

The label defaults to change. Every field is optional.

Response

OK

The shipping defaults configured for your account.

data
ShippingDefaults · object
required

The default values that are applied to your shipments.