Passer au contenu principal
POST
cURL

Autorisations

Authorization
string
header
requis

Pour vos propres scripts et vos intégrations de serveur à serveur. Créez une clé dans l'application sous Paramètres > Accès > Clés d'API et copiez-la à ce moment-là, car elle n'est affichée qu'une fois. Envoyez-la sous la forme Authorization: Bearer <key>. La clé agit en tant que le membre qui l'a créée, dans l'organisation où elle a été créée. Un appel exige l'autorisation du membre et l'une des portées de la clé, comme inventory:read ou sales:write. Une clé avec * a toutes les portées.

Corps

application/json

Une boîte à enregistrer comme préréglage d'emballage.

name
string
requis

Le nom de la boîte, par exemple Petite enveloppe. Unique dans l'organisation.

Maximum string length: 80
length
string
requis

La longueur de la boîte en dimension_unit, sous forme de chaîne décimale d'au plus quatre décimales.

Pattern: ^\d{1,8}(\.\d{1,4})?$
width
string
requis

La largeur de la boîte en dimension_unit, sous forme de chaîne décimale d'au plus quatre décimales.

Pattern: ^\d{1,8}(\.\d{1,4})?$
height
string
requis

La hauteur de la boîte en dimension_unit, sous forme de chaîne décimale d'au plus quatre décimales.

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

L'unité de length, width et height : mm, cm ou in.

Options disponibles:
mm,
cm,
in
tare_weight
string
requis

Ce que pèse la boîte vide en weight_unit, sous forme de chaîne décimale. Il est ajouté au poids des articles lorsqu'un colis n'est pas pesé.

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

L'unité de tare_weight : g, kg, oz ou lb.

Options disponibles:
g,
kg,
oz,
lb
is_default
boolean

Indique si la boîte de dialogue d'expédition démarre avec cette case. La définir efface l'indicateur sur tout autre préréglage. false par défaut.

Réponse

PackagePresetResource

data
PackagePresetResource · object
requis

Un préréglage d'emballage : une boîte dans laquelle l'organisation emballe, avec ses dimensions et son poids à vide.