Response

Specification

The Success response status returns a list of services. Each service is comprised of the following:

Element

Description

<service>

Holder for service element.

<id>

This is the ID of this service.

<hash>

Hash identifying this service.

<name>

This is the name of the service.

<cutoff>

This is the cutoff time for the collection postcode.

<printer>

Flag to indicate whether a printer is required.

<business_only>

Flag to indicate that this service can only be delivered to a business premises.

<type>

Indicates how the service operates. Possible values are ROAD, AIR, OTHER.

<messages>

Any service messages for this carrier, can contain 0 or more message elements.

<customs>

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.

<price>

The users base net price.

<vatrate>

The VAT rate for this service.

<surcharge>

A list of surcharges for this service, there can be multiple of these elements.