This API is used to lookup a list of shipping rates for parcels and pallets. The results are ordered from the cheapest delivery option to other specialist delivery services tht are available.
The Schema for this API can be downloaded from here.
Element Req Description
Yes Holder for header element.
Yes This is the APIKey as provided by ParcelBroker.
Yes This is your Public Key that use use to create the <token> value.
Yes SHA1 hash of "SharedSecret_PublicKey".
Yes A unique ID for every successful request. Duplicate requests with the same ID will be rejected.
Yes Holder for shipment element.
Yes Possible values are DOCUMENT, PARCEL, PALLET.
Yes Holder for collection address.
Yes The collection town.
Yes The collection postcode.
Yes The collection country code. Please see here for possible values.
Yes Holder for destination address.
Yes The destination town.
Yes The destination postcode.
Yes The destination country code. Please see here for possible values.
Yes Holder for parcels.
Yes Holder for a parcel (Can have more than 1).
Yes The weight in KG.
Yes The length in CM.
Yes The width in CM.
Yes The height in CM.
The Success response status returns a list of services. Each service is comprised of the following:
Holder for service element.
This is the ID of this service.
Hash identifying this service.
This is the name of the service.
This is the cutoff time for the collection postcode.
Flag to indicate whether a printer is required.
Flag to indicate that this service can only be delivered to a business premises.
Indicates how the service operates. Possible values are ROAD, AIR, OTHER.
Any service messages for this carrier, can contain 0 or more
Indicates whether this carrier/country requires any customs paperwork. Valid values are "required", "optional", "false". Required indicates that the carrier requires paperwork when calling the booking API, optional means that the country requires paperwork but does not need to be sent with the booking API.
The users base net price.
The VAT rate for this service.
A list of surcharges for this service, there can be multiple of these elements.
The users net price including surcharges.
The VAT charged.
The total price to the user including all charges and VAT.
Along with the common response codes this API has the following:
Code Reason 155 Missing address data information. 160 Incorrect or missing parcel data. 180 No services returned.
This section gives you some data that you can use for testing purposes.
Remote Area Surcharges
Some carriers have a surcharge for remote areas. You can use the following data to return services that have remote areas applied:
Delivery Address: UK - Scottish Highlands & Islands (UK_SH), Town: KIRKWALL, Postcde: KW151NF
Delivery Address: Italy (IT), Town: Badia al Pino, Postcode: 52041
Customs Clearance Surcharge
Some carriers have a surcharge for customs clearance.
Delivery Address: Andorra (AD), Town: Principat d'Andorra, Postcde: AD-500
Delivery Address: Switzerland (CH), Town: Zürich, Postcde: 8003