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

shipment
string
requis

L'ID de l'expédition comptabilisée à certifier, un UUID.

Corps

application/json

Un certificat de conformité à signer pour une expédition comptabilisée, ou une correction du dernier certificat.

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.

correction_reason
string | null

Pourquoi le dernier certificat était erroné. Requis lorsque l'expédition en a déjà un, et conservé avec la nouvelle révision.

Maximum string length: 500

Réponse

ShipmentCertificateResource

data
ShipmentCertificateResource · object
requis

Un certificat de conformité signé d'une expédition, tel qu'il a été signé.