Skip to main content
POST
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

A box to save.

name
string
required

Such as Small mailer; unique in the organization.

Maximum string length: 80
length
string
required
Pattern: ^\d{1,8}(\.\d{1,4})?$
width
string
required
Pattern: ^\d{1,8}(\.\d{1,4})?$
height
string
required
Pattern: ^\d{1,8}(\.\d{1,4})?$
dimension_unit
enum<string>
required

mm, cm or in.

Available options:
mm,
cm,
in
tare_weight
string
required

What the empty box weighs.

Pattern: ^\d{1,8}(\.\d{1,4})?$
weight_unit
enum<string>
required

g, kg, oz or lb.

Available options:
g,
kg,
oz,
lb
is_default
boolean

Whether the ship dialog starts with this box.

Response

PackagePresetResource

data
PackagePresetResource · object
required