Aller au contenu principal

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 terminaisonAuthentification
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ètreTypeObligatoireExemple
invoicingNumberStringOui0123456789
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

ChampTypeDescription
servicesArrayServices (produits principaux) disponibles pour le client
optionsArrayOptions (compléments) disponibles pour le client
services[].nameStringNom d'affichage du service
services[].codeStringCode de service, utilisé comme serviceCode lors de la création d'un envoi
options[].nameStringNom d'affichage de l'option
options[].codeStringCode d'option, utilisé lors de l'ajout d'options à un envoi

Codes de statut HTTP

CodeDescription
200 OKServices et options renvoyés
401 UnauthorizedJeton manquant ou invalide
403 ForbiddenLe client n'est pas accessible à l'utilisateur authentifié
404 Not FoundLe client (numéro de facturation) n'existe pas