Zum Hauptinhalt springen

Produkte

Rufen Sie die Services und Optionen ab, zu deren Nutzung ein Kunde berechtigt ist. Rufen Sie diesen Endpunkt vor dem Erstellen einer Sendung auf, um zu ermitteln, welche Servicecodes (z. B. B2B, CR, PM2) und Optionscodes (z. B. EXW, LQ, 2CRET) für den Kunden verfügbar sind.

EndpunktAuthentifizierung
GET /api/v1/products/{invoicingNumber}Bearer JWT-Token erforderlich

Das Ergebnis ist auf die Zugriffsrechte des authentifizierten Benutzers beschränkt: Es werden nur Services und Optionen zurückgegeben, die der angegebenen Kundenkonfiguration zugeordnet sind.


Anfrage

Pfadparameter:

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

Antwort

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

Beide Listen sind alphabetisch nach name sortiert. Jede Liste kann leer sein, wenn dem Kunden keine Services oder Optionen dieser Art zugeordnet sind.

Felder

FeldTypBeschreibung
servicesArrayFür den Kunden verfügbare Services (Hauptprodukte)
optionsArrayFür den Kunden verfügbare Optionen (Zusatzleistungen)
services[].nameStringAnzeigename des Service
services[].codeStringServicecode, wird beim Erstellen einer Sendung als serviceCode verwendet
options[].nameStringAnzeigename der Option
options[].codeStringOptionscode, wird beim Hinzufügen von Optionen zu einer Sendung verwendet

HTTP-Statuscodes

CodeBeschreibung
200 OKServices und Optionen zurückgegeben
401 UnauthorizedFehlendes oder ungültiges Token
403 ForbiddenKunde ist für den authentifizierten Benutzer nicht zugänglich
404 Not FoundKunde (Rechnungsnummer) existiert nicht