An API (Application Programming Interface) allows external systems to integrate directly with the ParcelBroker services. Developers can use the various API's to obtain parcel quotes, book collections, check shipment statuses and retreive paperwork.
The ParcelBroker API's are all based on sending (POST) and receiving JSON or XML via HTTPS and allows developers to access your ParcelBroker account directly without disclosing your username and password. In order to use the API's you will need to be given access to the various API methods by applying for a key.
If your account has already been approved for API use, you can obtain a key by visiting your account area or by visiting this link directly: https://parcelbroker.co.uk/myaccount/api
Here you will find an "APIKey" and a "Shared Secret". It is these details that allow you secure access to the API's.
If you need to request access to the API, you can submit a ticket via our contact page.
In order to use our API you will require technical knowledge of your systems and know how to perform HTTP requests and how to send and receive JSON or XML formats.
There are various subjects that you will need to understand in order to successfully integrate.
The endpoint is the URL that you will send your API requests to. The requests should be sent over HTTPS using the POST method. Any data sent via any other methods will be rejected.
JSON endpoint https://parcelbroker.co.uk/api/v2/
XML endpoint https://parcelbroker.co.uk/api/v2/xml
You can include a test flag within your request to help validate your request structure and data. When testing the bookings endpoint, we will return successful mock data in the same format as though it was a standard request.