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

La commande et les colis à tarifer. Lorsque address est omis, l'adresse de livraison de la commande, ou pour un retour l'adresse d'où il est expédié, est lue à partir de l'adresse telle qu'elle est écrite.

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

RateShopResource

data
RateShopResource · object
requis

Tous les tarifs cotés par les connexions d'expédition, classés selon la règle de l'organisation, et le tarif que la règle retient.