Address formats for specific carriers
This section provides carrier-specific details for the consumer address and options.
Service options
Some carriers offer additional service options that can be requested with shipping labels, such as signature requirements, insurance, or cash on delivery. These services are specified in the preferredCarriersWithProduct element of the Order.deliveryPreferences.
"deliveryPreferences": {
"shipping": {
"preferredCarriersWithProduct": [
{
"carrierKey": "BPOST",
"carrierServices": [
"SIGNATURE"
]
}
],
"serviceLevel": "DELIVERY"
}
}The list of supported options and services depends on the chosen carrier. Please get in touch with us if you find an option missing that you would like to use for your labels.
Home delivery
To request home delivery for most carriers and countries, set the Order.consumer.addresses[].addressType to POSTAL_ADDRESS.
Non-home delivery
Non-home delivery refers to deliveries made to packing stations or service points of different carriers.
DHL Packstation or Postfiliale/Paketshop (Germany)
For delivery to a DHL Packstation, the consumer address must contain the customer's DHL Postnummer. The Postnummer must be set in the additionalAddressInfo field. The street field must be Packstation and the houseNumber must be the number of the selected DHL Packstation.
For delivery to a DHL Postfiliale or Paketshop, the street must be Postfiliale and the houseNumber must be the number of the selected Filiale. The postalCode and city fields must point to the Filiale, not the customer's home address. The customer's DHL Postnummer can optionally be set in the additionalAddressInfo field.
The following is an example for Order.consumer using the carrier DHL_V2.
"addresses": [
{
"addressType": "POSTAL_ADDRESS",
"firstName": "Karl",
"lastName": "Kunde",
"additionalAddressInfo": "<Postnummer>", // for 'DHL Postfiliale/Paketshop'
"street": "Packstation", // or 'Postfiliale'
"houseNumber": "171",
"postalCode": "50667",
"city": "Köln",
"country": "DE"
}
]DHL Service Point or Parcel Locker (Netherlands, Belgium, Luxembourg)
In the Netherlands, customers can pick up their parcels at a DHL service point or parcel locker. To use this option, the order must include two consumer addresses: one of type INVOICE_ADDRESS and one of type PARCEL_LOCKER. The PARCEL_LOCKER address must include the ServicePoint ID in the additionalAddressInfo field. The INVOICE_ADDRESS must contain the customer's name, which is printed on the label for identification at the service point. For details, refer to the DHL BeNeLux API documentation.
The following is an example for Order.consumer using the carrier DHL_BENELUX:
"addresses": [
{
"addressType": "INVOICE_ADDRESS",
"firstName": "Mieke",
"lastName": "Janssen",
"street": "Kudelstaartseweg",
"houseNumber": "22",
"postalCode": "1431 GA",
"city": "Aalsmeer",
"country": "NL"
},
{
"addressType": "PARCEL_LOCKER",
"additionalAddressInfo": "8004-NL-201117",
"firstName": "Mieke",
"lastName": "Janssen",
"street": "Kudelstaartseweg",
"houseNumber": "22",
"postalCode": "1431 GA",
"city": "Aalsmeer",
"country": "NL"
}
]PostNL Service Point or Parcel Locker (Netherlands)
In the Netherlands, customers can pick up their parcels at a PostNL service point (PostNL-punt) or parcel locker. To enable this, the order must have two consumer addresses: one of type INVOICE_ADDRESS and one of type PARCEL_LOCKER. The INVOICE_ADDRESS must contain the customer's name for identification purposes at the service point. For details, refer to the PostNL API documentation. The PARCEL_LOCKER address must be the address of the pickup point and must include a companyName. It also requires the additionalAddressInfo field to contain the customer's PostNL ID number.
The following is an example for Order.consumer using the carrier POSTNL. The additionalAddressInfo field is only required for parcel locker delivery.
"addresses": [
{
"addressType": "INVOICE_ADDRESS",
"firstName": "Mieke",
"lastName": "Janssen",
"street": "Kudelstaartseweg",
"houseNumber": "22",
"postalCode": "1431 GA",
"city": "Aalsmeer",
"country": "NL"
},
{
"addressType": "PARCEL_LOCKER",
"additionalAddressInfo":"<POSTNL_ID>",
"companyName": "ACME",
"firstName": "Mieke",
"lastName": "Janssen",
"street": "Zijdstraat",
"houseNumber": "38",
"postalCode": "1431 ED",
"city": "Aalsmeer",
"country": "NL"
}
]bpost Pick-up Point or Parcel Locker (Belgium)
In Belgium, bpost offers customers the option to pick up their parcel at a Pick-up point or a Parcel locker. The order must contain an address of type PARCEL_LOCKER where the additionalAddressInfo field contains the service point ID from the bpost GeoLocator API. fulfillmenttools supports bpost service points of type 1 (PostOffice), 2 (Post Point & Parcel Point), 4 (Pack Station/Parcel Locker), and 16 (Kariboo/Parcel Point).
If the additionalAddressInfo field is omitted, the nearest service point is automatically chosen when the shipping label is requested. An INVOICE_ADDRESS can also be provided.
The following is an example for Order.consumer using the carrier BPOST:
"addresses": [
{
"addressType": "PARCEL_LOCKER",
"additionalAddressInfo": "100472",
"firstName": "Jean",
"lastName": "Peeters",
"street": "Carrefour de l'Europe",
"houseNumber": "2",
"postalCode": "1000",
"city": "Bruxelles",
"country": "BE"
}
]postnord Service Point or Parcel Locker
In the Nordics, for example in Denmark, Finland, or Sweden, the customer can choose to pick up a parcel at a postnord Service Point or Parcel locker (Pakkeboks or Nærboks). To use this option, the PARCEL_LOCKER address must include the Service Point ID (e.g., 105926) in the additionalAddressInfo field. An INVOICE_ADDRESS can also be provided. For more information, refer to the postnord API documentation.
The following is an example for Order.consumer using the carrier POST_NORD:
"addresses": [
{
"addressType": "PARCEL_LOCKER",
"additionalAddressInfo": "105926",
"firstName": "Peter",
"lastName": "Nielsen",
"street": "Gymnasievej",
"houseNumber": "29",
"postalCode": "4600",
"city": "Køge",
"country": "DK"
}
]GLS ParcelShop delivery
In Denmark and many other countries, the customer can pick up a parcel at a GLS depot or ParcelShop. For this delivery type, the PARCEL_LOCKER address must be the address of the parcel shop and it must include the ParcelShopID (e.g., 2080099016) in the additionalAddressInfo field. The first and last name must be the customer's for identification during pickup. An INVOICE_ADDRESS can also be provided. For more information on parcel shops, refer to the GLS ShipIT documentation.
The following is an example for Order.consumer using the carrier GLS:
"addresses": [
{
"addressType": "PARCEL_LOCKER",
"additionalAddressInfo": "2080095282",
"firstName": "Jens",
"lastName": "Jensen",
"street": "Gymnasievej",
"houseNumber": "29",
"postalCode": "4600",
"city": "Køge",
"country": "DK"
}
]Last updated