Skip to main content
PUT
cURL

Authorizations

Authorization
string
header
required

For your own scripts and server-to-server integrations. Create a key in the app under Settings > Access > API keys and copy it then, because it is shown once. Send it as Authorization: Bearer <key>. The key acts as the member who made it, in the organization it was made in. A call needs the member's permission and one of the key's scopes, such as inventory:read or sales:write. A key with * has every scope.

Body

application/json

How the organization ships.

rate_rule
enum<string>
required

cheapest, fastest or preferred.

Available options:
cheapest,
fastest,
preferred
label_format
enum<string>
required

pdf, zpl or png.

Available options:
pdf,
zpl,
png
preferred_carrier
string | null

The carrier the preferred rule picks first; required for it.

Maximum string length: 60
preferred_service
string | null
Maximum string length: 120
max_transit_days
integer | null

Rates slower than this many days are left out.

Required range: 1 <= x <= 60
notify_customer
boolean

Whether customers are emailed as their parcel moves.

ship_from
object | null

Response

ShippingSettingsResource

data
ShippingSettingsResource · object
required