Fin de vie
Vous consultez la documentation de v1.x, qui a atteint sa fin de vie et ne recevra plus aucune modification. Aller à v3.x
Cette page n’est pas encore disponible dans votre langue
Vous la lisez en English (UK).
Book a shipment
POST /shipments
post
/shipmentscreateShipment
Autorisation
apiKeyapiKey · X-Api-Key · En-têteA key from the account page.
Corps de la requête Obligatoire
application/json
objectShipmentShipmentOne shipment, as the first API saw it.
idstringLecture seulelabel*Obligatoirestringlongueur min 1longueur max 120Renamed to `reference` in 2.x.state*Obligatoirestringbooked | sailing | landedRenamed to `status` in 2.x, and gained `cancelled`.createdAtstringLecture seule
json
{
"label": "string",
"state": "booked"
}Réponses
201
Booked.application/json
objectShipmentShipmentOne shipment, as the first API saw it.
id*ObligatoirestringLecture seulelabel*Obligatoirestringlongueur min 1longueur max 120Renamed to `reference` in 2.x.state*Obligatoirestringbooked | sailing | landedRenamed to `status` in 2.x, and gained `cancelled`.createdAtstringLecture seule
json
{
"id": "00000000-0000-4000-8000-000000000000",
"label": "string",
"state": "booked",
"createdAt": "2026-01-01T09:00:00Z"
}Envoyer une requête
curl 'https://api.example.org/v2/consignments?limit=20&cursor=string'