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

Les colis pour lesquels acheter des étiquettes et le tarif choisi à partir d'une soumission. Une étiquette est achetée par colis. Lorsque address est omis, l'adresse de livraison de la commande, ou pour une étiquette de retour l'adresse d'où part le retour, est lue telle qu'elle est écrite dans l'adresse.

order_id
string<uuid>
requis

L'ID de la commande client qui est expédiée, un UUID.

packages
object[]
requis

Les colis, de 1 à 20. Chaque étiquette couvre un colis.

Required array length: 1 - 20 elements
connection_id
string<uuid>
requis

L'ID de la connexion d'expédition qui a soumis le tarif, tiré du connection_id de la soumission. L'étiquette est achetée par son intermédiaire.

carrier
string
requis

Le transporteur du tarif choisi, tiré du carrier de la soumission.

Maximum string length: 60
service_code
string
requis

Le code de service du tarif choisi, tiré du service_code de la soumission.

Maximum string length: 120
shipment_id
string<uuid> | null

L'ID d'une expédition comptabilisée de la commande. Seules ses lignes sont tarifées, et une étiquette d'expédition y consigne son transporteur et son numéro de suivi. Lorsqu'il est omis, chaque ligne de la commande est tarifée.

return_id
string<uuid> | null

L'ID du retour autorisé auquel sert une étiquette de retour. Obligatoire pour une étiquette de retour et refusé pour une étiquette d'expédition.

address
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.

insured_value
string | null

La valeur pour laquelle assurer l'expédition, sous forme de chaîne décimale dans la devise de la commande. Si elle est omise, aucune assurance n'est demandée.

Pattern: ^\d{1,8}(\.\d{1,4})?$
signature
boolean

Indique si le transporteur doit obtenir une signature à la livraison. false par défaut.

Réponse

BoughtLabelsResource

data
BoughtLabelsResource · object
requis

Les étiquettes qu'un achat a acquises, une par colis, avec le transporteur et le premier numéro de suivi.