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.

Paramètres de chemin

order
string
requis

L'ID de la commande client, un UUID.

Corps

application/json

Une expédition et le certificat de conformité signé avec elle : les champs d'une expédition, plus ceux d'un certificat.

lines
object[]
requis

Ce qui a été expédié, de 1 à 50 lignes. Une ligne ne peut pas expédier plus que ce qui reste sur sa ligne de commande.

Required array length: 1 - 50 elements
id
string<uuid> | null

Un UUIDv7 que le client a choisi pour l'expédition, afin de pouvoir la nommer avant d'avoir une réponse.

shipped_on
string<date> | null

La date d'expédition des marchandises, sous forme YYYY-MM-DD. Aujourd'hui si elle est omise.

carrier
string | null

Le transporteur qui a pris les marchandises, par exemple UPS, jusqu'à 64 caractères.

Maximum string length: 64
tracking_number
string | null

Le numéro de suivi du transporteur, jusqu'à 128 caractères. Il peut aussi être défini après la comptabilisation.

Maximum string length: 128
note
string | null

Une note imprimée sur le bordereau d'expédition, d'au plus 1,000 caractères.

Maximum string length: 1000
packages
object[] | null

Les colis dans lesquels la marchandise est partie, tels qu'emballés, jusqu'à 20.

Maximum array length: 20
customer_reference
string | null

Le numéro de bon de commande du client, imprimé sur le certificat.

Maximum string length: 64
contract_number
string | null

Le contrat sous lequel les marchandises ont été achetées, imprimé sur le certificat.

Maximum string length: 64
contact_id
string<uuid> | null

Le contact client à qui envoyer le PDF signé par courriel. Aucun courriel n'est envoyé s'il est omis.

Réponse

ShipmentResource

data
ShipmentResource · object
requis

Les marchandises expédiées pour une commande client, avec les lots, les numéros de série et le coût de chaque ligne.