skip to Main Content

BOEKUWZENDING WEBSERVICES V 2.0.1

TABLE OF CONTENTS

Version history2
Table of contents3
Environments4
Credentials4
Endpoints5
Shipment5
Examples6
Create shipment (POST)6
CURL examples7

VERSION HISTORY

DateVersionDescription
29-11-192.0.0First public release
09-01-202.0.1Improvements

ENVIRONMENTS

There are separate environments available for development/testing (staging) and production. The staging environment should be used to test the implementation. After successful implementation and acceptance access to the production environment will be granted.

Staging 
Endpoint:https://api.staging.mijn.boekuwzending.com
Documentation:https://api.staging.mijn.boekuwzending.com/docs
Production 
Endpointhttps://api.mijn.boekuwzending.com
Documentationhttps://api.mijn.boekuwzending.com/docs

CREDENTIALS

To make a connection tot he API credentials are required. Credentials can be requested by (info@boekuwzending.com). When granted, a clientId and clientSecret will be provided.
For both environments there are separate credentials. Credentials for the staging environment can’t be used in the production environment.

ENDPOINTS SHIPMENT

Through the shipment endpoint a shipment can be created and information about existing shipments can be retrieved.

FieldnameType (length)RequiredRemark
invoiceReferenceString (35 chars)NoThis field will be shown on the invoice
transportTyperoad_transport,YesType of transport, road_transport should be used in most cased.
sea_fright of air_freight
incoTermsDAP of DDPNoOnly for shipments outside the EU (import / export)
Delivery At Place (DAP) / Delivery Duty Paid (DDP)
shipFromYes
shipFrom.contactYes
shipFrom.contact.nameString (45 chars)Yes
shipFrom.contact.companyString (35 chars)No
shipFrom.contact.phoneNumberString (25 chars)YesTelephone number must be in internal format
shipFrom.contact.emailAddressString (50 chars)Yes
shipFrom.addressYes
shipFrom.address.streetString (35 chars)No
shipFrom.address.numberString (5 chars)No
shipFrom.address.numberAdditionString (10 chars)No
shipFrom.address.addressLine2String (35 chars)No
shipFrom.address.postcodeString (12 chars)YesMust be a valid postcode within the country
shipFrom.address.cityString (25 chars)Yes
shipFrom.address.countryString (2 chars)YesISO 3166-1 alpha-2 country code
shipFrom.address.privateAddressBooleanYes
shipFrom.address.ForkliftOrLoadingDockAvailableBooleanNo
shipFrom.address.accessibleWithTrailerBooleanYes
shipToYes
shipTo.contactYes
shipTo.contact.nameString (45 chars)Yes
shipTo.contact.companyString (35 chars)
shipTo.contact.phoneNumberString (25 chars)YesTelephone number must be in internal format
shipTo.contact.emailAddressString (50 chars)Yes
shipTo.addressYes
shipTo.address.streetString (35 chars)No
shipTo.address.numberString (5 chars)No
shipTo.address.numberAdditionString (10 chars)No
shipTo.address.addressLine2String (35 chars)No
shipTo.address.postcodeString (12 chars)YesMust be a valid postcode within the country
shipTo.address.cityString (25 chars)Yes
shipTo.address.countryString (2 chars)YesISO 3166-1 alpha-2 country code
shipTo.address.privateAddressBooleanYes
shipTo.address.forkliftOrLoadingDockAvailableBooleanNo
shipTo.address.accessibleWithTrailerBooleanYes
dpdNumberString (17 chars)NoDPD customer number (on request)
dpdDepotCodeString (4 chars)NoDPD Depot code (on request)
dispatchYes
dispatch.instructionsString (75 chars)NoPickup instruction
dispatch.referenceString (75 chars)NoPickup reference
dispatch.dateDateYesPickup date (must be greater than or equal to today
dispatch.timewindowNo
dispatch.timeWindow.beginTimeNo
dispatch.timeWindow.endTimeNo
deliveryNo
delivery.instructionsString (75 chars)NoDelivery instruction
delivery.referenceString (75 chars)NoDelivery reference
delivery.dateDateNoPreferred delivery date
delivery.timeWindowNo
delivery.timeWindow.beginTimeNo
delivery.timeWindow.endTimeNo
itemsYes
items.quantityIntegerYes
items.typestringYesItem type (see API for available types)
items.stackableBooleanNo
items.dimensionsYes
items.dimensions.lengthFloatYesLength of item (cm)
items.dimensions.widthFloatYesWidth of item (cm)
items.dimensions.heightFloatYesHeight of item (cm)
items.weightFloatYesWeight of item (KG)
items.descriptionString (70 chars)Yes
items.customerReferenceString (35 chars)No
items.valueFloatNoOnly for shipments outside the EU (import / export) or insurance
items.tariffNumberString (35 chars)NoHS-code, only for shipments outside the EU (import / export)
items.countryOfOriginString (2 chars)NoISO 3166-1 alpha-2 landcode, only for shipments outside the EU (import / export)

EXAMPLES

CREATE SHIPMENT (POST)

{

“invoiceReference”: “API TEST”,

“transportType”: “road_transport”,

“incoTerms”: “DAP”,

“shipFrom”: {

“contact”: {

“name”: “Rik Balder”,

“company”: “Boekuwzending”,

“phoneNumber”: “+31252245480”,

“emailAddress”: “info@boekuwzending.com”

},

“address”: {

“street”: “Bennebroekweg”,

“number”: “267”,

“numberAddition”: “”,

“addressLine2”: null,

“postcode”: “1435CJ”,

“city”: “Rijsenhout”,

“country”: “NL”,

“privateAddress”: false,

“forkliftOrLoadingDockAvailable”: false,

“accessibleWithTrailer”: false

}

},

“shipTo”: {

“contact”: {

“name”: “Rik Balder”,

“company”: “Boekuwzending”,

“phoneNumber”: “+31252245480”,

“emailAddress”: “info@boekuwzending.com”

},

“address”: {

“street”: “Bennebroekweg”,

“number”: “267”,

“numberAddition”: “”,

“addressLine2”: null,

“postcode”: “1435CJ”,

“city”: “Rijsenhout”,

“country”: “NL”,

“privateAddress”: false,

“forkliftOrLoadingDockAvailable”: false,

“accessibleWithTrailer”: false

}

},

“dpdNumber”: “”,

“dpdDepotCode”: “”,

“dispatch”: {

“instructions”: “Doorbell doesn’t work”,

“reference”: “My first API shipment”,

“date”: “2019-12-01”,

“timeWindow”: {

“begin”: “8:00”,

“end”: “16:00”

}

},

“delivery”: {

“instructions”: “Loading dock”,

“reference”: “API API”,

“date”: “2019-12-05”

},

“items”: [

{

“quantity”: 1,

“type”: “package”,

“stackable”: true,

“dimensions”: {

“length”: 120,

“width”: 80,

“height”: 100

},

“weight”: 106.5,

“description”: “General cargo”,

“customerReference”: “API TEST”,

“value”: 100,

“tariffNumber”: “1234”,

“countryOfOrigin”: “NL”

}

]

}

CURL EXAMPLES

REQUEST ACCESS TOKEN

curl -X POST -d “grant_type=client_credentials&client_id={{clientId}}&client_secret={{clientSecret}}” https://api.staging.boekuwzending.com/token

Replace  {{clientId}} and {{clientSecret}} with yourAPI credentials.

CREATE A SHIPMENT

curl -X POST -d “@shipment.json” -H “Content-Type: application/json” -H “Authorization: Bearer {{accessToken}}” https://api.staging.mijn.boekuwzending.com/shipments

Replace  {{accessToken}} with the accessToken retreived from the above request.