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
| Champ | Type | Longueur | Obligatoire | Description |
|---|---|---|---|---|
invoicingNumber | String | 1–20 | Oui | Numéro de facturation client |
numberOfParcels | Integer | — | Oui | Nombre total de colis (1–99) |
serviceCode | String | — | Oui | Code service DPD (PSD, PSI, PL, PBOX, RET) |
parcelShopId | String | — | Conditionnel | Requis pour les services de livraison en point relais |
shipmentNote | String | 0–255 | Non | Note sur l'expédition |
Champs d'adresse (expéditeur / destinataire / retour)
| Champ | Type | Longueur | Obligatoire | Remarques |
|---|---|---|---|---|
name | String | 1–35 | Oui | Nom de la société ou de la personne |
countryCode | String | 2 | Oui | ISO 3166-1 alpha-2 |
stateCode | String | 2 | Conditionnel | Requis pour US/CA |
zipCode | String | 1–9 | Oui | Code postal |
city | String | 1–35 | Oui | Ville |
street | String | 1–35 | Oui | Nom et numéro de rue |
houseNumber | String | 0–8 | Conditionnel | Requis pour NL |
phone | String | 0–30 | Conditionnel | Requis pour GB — format +CCNNNNNNN |
email | String | 0–50 | Conditionnel | Requis pour non-CH/LI (sauf GB) |
Options d'impression
| Champ | Type | Description |
|---|---|---|
labelFormat | String | A4 ou A6 (défaut : A4) |
labelStartPosition | Integer | Position 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": []
}
| Code | Description |
|---|---|
201 Created | Toutes les expéditions créées |
207 Multi-Status | Succès partiel |
400 Bad Request | Requête invalide |
401 Unauthorized | Jeton manquant ou invalide |