Pickup point data examples

Pickup points work differently for each shipping provider, but we tried to make it as generic as possible. But still, every shipping provider needs different information. Therefor we provide some examples.

The pickup_point_data in the order will be filled automatically for supported webshops, and will be used by supported shipping providers. We have support for Magento 1 and Lightspeed, with PostNL and B2C Europe for example. But more will be added over time.

We provide this information in a generic way in our API, so you can support this in your custom webshop or in your custom shipping provider.

Defaults

These are the default attributes in pickup_point_data:

{ "pickup_point_data": { "carrier": "dhl", "id": "901892834", "name": "Albert Heijn Presikhaaf", "street": "Dorpsstraat", "house_number": "32", "zipcode": "2938 DM", "city": "Arnhem", "country": "NL", "options": { "parcel_machine": true, "pickup_moment": "early_morning" } } }

Most shipping providers work either with an 'id' of the pickup location, or with a full address. Extra options can be given in the 'options' array.

B2C Europe

B2C Europe is pretty easy. You just provide the CYP ID as the pickup point ID.

{ "pickup_point_data": { "carrier": "b2ceurope", "id": "901892834" } }

PostNL PakjeGemak

With PakjeGemak we always need the full address of the point point location.

In the 'options' you need to set 'pakjegemak' to true and if the phone number in the order is not a mobile phone, you need to provide a mobile phone number in the options array.

{ "pickup_point_data": { "carrier":"postnl", "name":"Gamma", "street":"Locht", "house_number":"44", "zipcode":"6466GW", "city":"Kerkrade", "country":"NL", "options": { "pakjegemak":true, "mailbox":false, "parcel_machine":false, "pickup_moment":null, "delivery_date":null, "mobile_phone_number":"0612345678" }, } }

PostNL PakjeGemak Early Morning

If the customer wants to pickup the shipment early, you can set `pickup_moment` to 'PGE' for 'PakjeGemakEarly'.

{ "pickup_point_data": { "carrier":"postnl", "name":"Gamma", "street":"Locht", "house_number":"44", "zipcode":"6466GW", "city":"Kerkrade", "country":"NL", "options": { "pakjegemak":true, "mailbox":false, "parcel_machine":false, "pickup_moment":"PGE", "delivery_date":null, "mobile_phone_number":"0612345678" }, } }

PostNL PakjeGemak Parcel Machine

If the pickup location is a Parcel Machine, you need to set `pakjegemak` to false, and `parcel_machine` to true.

{ "pickup_point_data": { "carrier":"postnl", "name":"Gamma", "street":"Locht", "house_number":"44", "zipcode":"6466GW", "city":"Kerkrade", "country":"NL", "options": { "pakjegemak":false, "mailbox":false, "parcel_machine":true, "pickup_moment":null, "delivery_date":null, "mobile_phone_number":"0612345678" }, } }