Passa al contenuto principale

Prodotti

Recupera i servizi e le opzioni che un cliente è autorizzato a utilizzare. Richiama questo endpoint prima di creare una spedizione per individuare quali codici di servizio (ad es. B2B, CR, PM2) e codici di opzione (ad es. EXW, LQ, 2CRET) sono disponibili per il cliente.

EndpointAutenticazione
GET /api/v1/products/{invoicingNumber}token JWT Bearer richiesto

Il risultato è limitato ai diritti di accesso dell'utente autenticato: vengono restituiti solo i servizi e le opzioni associati alla configurazione cliente indicata.


Richiesta

Parametro di percorso:

ParametroTipoObbligatorioEsempio
invoicingNumberString0123456789
curl -X GET "https://label-print-shipments.dpd.ch/api/v1/products/0123456789" \
-H "Authorization: Bearer <jwt_token>"

Risposta

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"
}
]
}

Entrambe le liste sono ordinate alfabeticamente per name. Ciascuna lista può essere vuota se al cliente non è associato alcun servizio o opzione di quel tipo.

Campi

CampoTipoDescrizione
servicesArrayServizi (prodotti principali) disponibili per il cliente
optionsArrayOpzioni (componenti aggiuntivi) disponibili per il cliente
services[].nameStringNome visualizzato del servizio
services[].codeStringCodice del servizio, utilizzato come serviceCode durante la creazione di una spedizione
options[].nameStringNome visualizzato dell'opzione
options[].codeStringCodice dell'opzione, utilizzato durante l'aggiunta di opzioni a una spedizione

Codici di stato HTTP

CodiceDescrizione
200 OKServizi e opzioni restituiti
401 UnauthorizedToken mancante o non valido
403 ForbiddenIl cliente non è accessibile all'utente autenticato
404 Not FoundIl cliente (numero di fatturazione) non esiste