Produits
Récupérez les services et options qu'un client est autorisé à utiliser. Appelez ce point de terminaison avant de créer un envoi afin de déterminer quels codes de service (par ex. B2B, CR, PM2) et codes d'option (par ex. EXW, LQ, 2CRET) sont disponibles pour le client.
| Point de terminaison | Authentification |
|---|---|
GET /api/v1/products/{invoicingNumber} | jeton JWT Bearer requis |
Le résultat est limité aux droits d'accès de l'utilisateur authentifié : seuls les services et options associés à la configuration client indiquée sont renvoyés.
Requête
Paramètre de chemin :
| Paramètre | Type | Obligatoire | Exemple |
|---|---|---|---|
invoicingNumber | String | Oui | 0123456789 |
curl -X GET "https://label-print-shipments.dpd.ch/api/v1/products/0123456789" \
-H "Authorization: Bearer <jwt_token>"
Réponse
200 OK :
{
"services": [
{
"name": "Collection Request",
"code": "CR"
},
{
"name": "DPD CLASSIC",
"code": "B2B"
},
{
"name": "DPD CLASSIC Guarantee",
"code": "PM2"
}
],
"options": [
{
"name": "Exworks",
"code": "EXW"
},
{
"name": "Limited Quantities",
"code": "LQ"
},
{
"name": "Return",
"code": "2CRET"
}
]
}
Les deux listes sont triées par ordre alphabétique selon name. Chaque liste peut être vide si aucun service ou option de ce type n'est associé au client.
Champs
| Champ | Type | Description |
|---|---|---|
services | Array | Services (produits principaux) disponibles pour le client |
options | Array | Options (compléments) disponibles pour le client |
services[].name | String | Nom d'affichage du service |
services[].code | String | Code de service, utilisé comme serviceCode lors de la création d'un envoi |
options[].name | String | Nom d'affichage de l'option |
options[].code | String | Code d'option, utilisé lors de l'ajout d'options à un envoi |
Codes de statut HTTP
| Code | Description |
|---|---|
200 OK | Services et options renvoyés |
401 Unauthorized | Jeton manquant ou invalide |
403 Forbidden | Le client n'est pas accessible à l'utilisateur authentifié |
404 Not Found | Le client (numéro de facturation) n'existe pas |