Passer au contenu principal
PUT
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

Comment l'organisation expédie : comment un tarif est choisi, le format d'étiquette, les courriels aux clients et l'adresse de retour dans ship_from. Si ship_from est omis, les étiquettes sont expédiées depuis l'adresse de l'emplacement de la commande.

rate_rule
enum<string>
requis

Comment un tarif est choisi parmi les cotations : cheapest, fastest ou preferred.

Options disponibles:
cheapest,
fastest,
preferred
label_format
enum<string>
requis

Le format de fichier dans lequel les étiquettes sont achetées : pdf, zpl ou png.

Options disponibles:
pdf,
zpl,
png
preferred_carrier
string | null

Le transporteur que la règle preferred classe en premier, apparié au carrier d'une soumission sans tenir compte de la casse. Obligatoire lorsque rate_rule est preferred.

Maximum string length: 60
preferred_service
string | null

Le service du transporteur préféré à classer en premier, comparé au service ou au service_code d'une soumission sans tenir compte de la casse. S'il est omis, tous les services de ce transporteur sont classés au même rang.

Maximum string length: 120
max_transit_days
integer | null

Les tarifs plus lents que ce nombre de jours sont exclus, de même que les tarifs sans délai de transit. Si omis, aucun tarif n'est exclu en raison de son délai de transit.

Plage requise: 1 <= x <= 60
notify_customer
boolean

Indique si les clients reçoivent un courriel à mesure que leur colis avance. false par défaut.

ship_from
object | null

Une adresse postale en champs, telle qu'un membre l'a vérifiée. Lorsqu'elle est envoyée, line1, city, postal_code et country sont obligatoires.

Réponse

ShippingSettingsResource

data
ShippingSettingsResource · object
requis

Comment l'organisation expédie : comment un tarif est choisi, le format d'étiquette, les courriels aux clients et l'adresse de retour.