Aller au contenu principal

Expéditions

Créez une ou plusieurs expéditions en une seule requête. L'API valide tous les champs, génère les numéros de colis, enrichit les données de routage et retourne des étiquettes PDF.

Point de terminaison: POST /api/v1/shipments Authentification: Jeton JWT Bearer requis


Champs principaux de l'expédition

ChampTypeLongueurObligatoireDescription
invoicingNumberString1–20OuiNuméro de facturation client
numberOfParcelsIntegerOuiNombre total de colis (1–99)
serviceCodeStringOuiCode service DPD (PSD, PSI, PL, PBOX, RET)
parcelShopIdStringConditionnelRequis pour les services de livraison en point relais
shipmentNoteString0–255NonNote sur l'expédition

Champs d'adresse (expéditeur / destinataire / retour)

ChampTypeLongueurObligatoireRemarques
nameString1–35OuiNom de la société ou de la personne
countryCodeString2OuiISO 3166-1 alpha-2
stateCodeString2ConditionnelRequis pour US/CA
zipCodeString1–9OuiCode postal
cityString1–35OuiVille
streetString1–35OuiNom et numéro de rue
houseNumberString0–8ConditionnelRequis pour NL
phoneString0–30ConditionnelRequis pour GB — format +CCNNNNNNN
emailString0–50ConditionnelRequis pour non-CH/LI (sauf GB)

Options d'impression

ChampTypeDescription
labelFormatStringA4 ou A6 (défaut : A4)
labelStartPositionIntegerPosition de l'étiquette sur la feuille A4 (1–4)

Réponse

201 Created — toutes les expéditions créées :

{
"tracingId": "TRACE-123",
"success": [
{ "id": 1, "parcelNumber": "05305000123456", "label": "PDF-encodé-base64..." }
],
"failed": []
}
CodeDescription
201 CreatedToutes les expéditions créées
207 Multi-StatusSuccès partiel
400 Bad RequestRequête invalide
401 UnauthorizedJeton manquant ou invalide