Extended Parameters

The following table contains the parameters that can be passed by an Delivery Options API call, in addition to the Basic Parameters.

The more parameters you define, the greater the relevance to the consumer of the options returned.

When no estimates are possible

Some of the parameters require estimates, e.g. e_n - the estimated number of parcels. However, sometimes it is just not possible to estimate the number of parcels, and their weights, dimensions, etc. In this case, reverting to the defaults is all you can do. Your actual costs and carrier selection will not be accurate, but, provided that you supply the correct delivery postcode, the availability of the classes of service (that is to say, the service groups, such as 'Next day', 'Evening', and so on) will usually give an accurate idea of the carrier services available.

Table 2. Additional Parameters

Query parameter

Description

Format

Default (where applicable)

Notes

wh_pc

The postal code of the warehouse from which the consignment is to be despatched, if this is different from the one associated with wh_code.

string

The postal code of the warehouse associated with wh_code.

Even if you specify a different postal code, country code and/or warehouse address, the call will still use the carrier network associated with wh_code.

wh_cc

The ISO 3166 alpha-3 three-letter country code of the warehouse from which the consignment is to be despatched, if this is different from the one associated with wh_code.

code

The country code of the warehouse associated with wh_code.

wh_l1

The first, second, third and fourth lines of the address of the warehouse from which the consignment is to be despatched, if these are different from the ones associated with wh_code.

string

The first, second, third and fourth lines of the address of the warehouse associated with wh_code.

wh_l2

wh_l3

wh_l4

c_l1

The first, second, third and fourth lines of the consumer's address.

string

c_l2

c_13

c_l4

multiCountry

When set to 'true', this flag causes options to be returned from countries that border the one specified using the c_cc parameter.

boolean

false

e_n

The estimated number of parcels.

integer

1

The number of parcels can affect which carriers are selectable. For example, some carriers will not allow more than 30 parcels to be placed on a single order. The number of parcels can also have a direct retail cost, and, in this case, an estimate of the number of parcels required to ship a consignment is important. As a rough guide, if you know the approximate sizes of the items to be shipped, and the sizes of the parcels that are used, you can estimate the number of parcels. However, it is only ever an estimate at this stage. To keep things simple, it may be worthwhile using an 'average number of items per parcel' as a rough guide.

e_w

The estimated weight (in kg) of the whole consignment (i.e. the sum of all the parcel weights).

double precision floating point number

0.01

As with the estimated number of parcels specified above, the total weight can also affect your costs and the available carriers. If you know the actual weights of the items, you can work out the total weight. However, this is also just an estimate as packing materials (such as padding), and the boxes themselves), also affect the total shipping weight.

Where the weights are completely unknown, you can apply the 'average total consignment weight' to all orders. Where particularly large items (such as washing machines) are being shipped, you can increase this average as required.

e_maxdim

The estimated length (in cm) of the longest dimension of the largest parcel.

integer

0 (i.e. the dimension is not taken into account when options are returned).

e_maxweight

The estimated weight (in kg) of the heaviest parcel.

double precision floating point number

0.00 (i.e. the weight is not taken into account when options are returned).

e_v

The estimated consignment value.

double precision floating point number

Where provided, this value is split equally across all parcels.

For example, if e_v is 10.0 and e_n is 4, then a value of 2.5 is assigned to each parcel.

e_v_currency

The currency of the estimated consignment value.

string

parcelHeight

The height, width, depth and weight of each parcel, respectively. Use these parameters to limit the options to those that can handle parcels of the weights and dimensions specified.

string

The API checks that the number of parameters given for each of parcelHeight, parcelWidth, parcelDepth and parcelWeight, match the estimated number of parcels (e_n).

The parameters are used in conjunction with the consignmentLevelDetailsFlag (see below).

parcelWidth

parcelDepth

parcelWeight

consignmentLevelDetailsFlag

A flag that indicates whether or not information is held at the consignment level.

Set it to false if you wish any of the above parameters (parcelHeight, parcelWidth, parcelDepth and/or parcelWeight) to be parsed and used in the calculations used to return delivery options.

boolean

true

cod_amount

You can use this parameter to specify the amount of cash on delivery that the returned options need to be able to handle,

double precision floating point number

0.0 , which indicates that the consignment is not cash on delivery.

cod_currency

The currency of any cash on delivery amounts.

string

hazmat_codes

If the consignment contains any hazardous goods, supply a list of comma-separated hazardous goods codes.

string

radius

The radius in metres for the PUDO and 'Click and Collect' searches.

integer

1000

minown

The minimum number of 'Click and Collect' stores to be returned. If none are available within the radius, then the search will extend beyond it.

integer

maxown

The maximum number of 'Click and Collect' stores that can be returned within the radius.

integer

100

limit

The maximum number of options to be returned.

integer

This does not apply to own stores if the minown and/or maxown parameter is set,

incgrp

Comma-separated list of carrier 'service groups' to include - i.e. only the services in these groups are used in the response.

string

By default, all services are considered.

excgrp

Comma-separated list of carrier 'service groups' t to exclude - i.e. services in these groups are not used in the response.

string

By default, all services are considered.

acceptableCollectionSlots

Two timestamps to mark the acceptable collection window, separated by a comma.

string

acceptableDeliverySlots

Two timestamps to mark the acceptable delivery window, separated by a comma.

string