Skip to main content

Products

Retrieve the services and options a customer is entitled to use. Call this before creating a shipment to discover which service codes (e.g. B2B, CR, PM2) and option codes (e.g. EXW, LQ, 2CRET) are available for the customer.

Endpoint: GET /api/v1/products/{invoicingNumber} Auth: Bearer JWT token required

The result is scoped to the authenticated user's access: only services and options assigned to the given customer configuration are returned.


Request

Path parameter:

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

Response

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

Both lists are sorted alphabetically by name. Either list may be empty if the customer has no services or options of that kind assigned.

Fields

FieldTypeDescription
servicesArrayServices (main products) available to the customer
optionsArrayOptions (add-ons) available to the customer
services[].nameStringDisplay name of the service
services[].codeStringService code, used as serviceCode when creating a shipment
options[].nameStringDisplay name of the option
options[].codeStringOption code, used when adding options to a shipment

HTTP status codes

CodeDescription
200 OKServices and options returned
401 UnauthorizedMissing or invalid token
403 ForbiddenCustomer is not accessible to the authenticated user
404 Not FoundCustomer (invoicing number) does not exist