Extended Parameters

• c_address_type

  The address type. The possible values are BUSINESS or RESIDENTIAL.

• c_l1

  The first line of the consumer's address.

• c_l2

  The second line of the consumer's address.

• c_l3

  The third line of the consumer's address.

• c_l4

  The fourth line of the consumer's address.

• wh_cc

  The ISO 3166 alpha-3 three-letter country code of the warehouse from which the consignment is to be despatched,

• wh_pc

  The postal code of the warehouse from which the consignment is to be despatched,

• wh_l1

  The first line of the address of the warehouse from which the consignment is to be despatched.

• wh_l2

  The second line of the address of the warehouse from which the consignment is to be despatched.

• wh_l3

  The third line of the address of the warehouse from which the consignment is to be despatched.

• wh_l4

  The fourth line of the address of the warehouse from which the consignment is to be despatched.

• 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. It is expressed as a double precision floating point number, and the default is 0.0, which indicates that the consignment is not cash on delivery.

• cod_currency

  The currency of any cash on delivery amounts, e.g. EUR.

• consignmentLevelDetailsFlag

  This is a flag that indicates whether or not information is held at the consignment level. In order to enter parcel values, it needs to be set to false (as opposed to the default true).

  This then allows you to specify the following parcel values to limit the returned options to those that can handle parcels of the specified depth, height and width (in centimetres or inches), and specified weight (in kilograms or pounds):

  • parcelDepth

  • parcelHeight

  • parcelWeight

  • parcelWidth

  Note

  You can also specify the values for multiple parcels, in conjunction with e_n.

  Notice

  Delivery Options supports imperial weights and measures in addition to the metric system.

• hazmat_codes

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

• e_n

  The estimated number of parcels. 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 so 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 using an 'average number of items per parcel'.

• e_w

  The estimated weight (in kg) of the entire consignment (i.e. the sum of all the parcel weights), expressed as a double precision floating point number. The default is 0.01.

  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.

  Tip

  By default, this parameter uses the metric system. If you want to use the imperial system for this parameter, you will need to include the query string parameter weight_unit=lb in your API request.

• e_maxdim

  The estimated length of the longest dimension of the largest parcel, expressed as an integer in cm. The default is '0' (i.e. the dimension is not taken into account when options are returned).

  Tip

  By default, this parameter uses the metric system. If you want to use the imperial system for this parameter, you will need to include the query string parameter dimensions_unit=in in your API request.

• e_maxweight

  The estimated weight (in kg) of the heaviest parcel, expressed as a double precision floating point number. The default is 0.00 (i.e. the weight is not taken into account when options are returned).

  Tip

  By default, this parameter uses the metric system. If you want to use the imperial system for this parameter, you will need to include the query string parameter weight_unit=lb in your API request.

• e_v

  The estimated consignment value, expressed as a 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, e.g. EUR.

• dimensions_unit

  Dimensions unit for parcel and consignment size. You can specify imperial or metric measures. Possible values: CM or cm, IN or in. Default value: CM.

• weight_unit

  Unit specification for parcel and consignment weight. You can specify imperial or metric measures. Possible values: KG or kg, LB or lb. Default value: KG.

These parameters serve to restrict the number of delivery options returned, If insufficient options are being returned, then consider increasing the radius (if returning options for delivery to PUDOs or your own stores), or specifying minown (if returning options just for delivery to your own stores).

• acceptableCollectionSlots

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

  Note

  For the construction of dates, times and overall timestamps, refer to Introduction to Booking Codes.

• acceptableDeliverySlots

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

• excgrp

  Comma-separated list of carrier 'service groups' to exclude - i.e. services in these groups are not considered, even if they can fulfil the needs demanded by the other parameters.

• incgrp

  Comma-separated list of carrier 'service groups' to include - i.e. only the services in these groups are considered (provided that they can fulfil the needs demanded by the other parameters).

  Note

  If a carrier service is in more than one carrier 'service group', then, each time that service is selected, it will cause the associated group to appear. So, it is possible that you will see 'service groups' that you have opted to include, appear more than once in the response.

• limit

  The maximum number of options to be returned.

  Caution

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

• minown

  The minimum number of your own stores to be returned as collection points. If the required minimum are not available within the radius, then the search will extend beyond it (up to 100kms).

• maxown

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

• radius

  For a PUDO or Ownstore search, this defines the search radius from the point specified by the c_lat/c_long or c_pc. It is specified in metres, and the default is 1000 (maximum search radius is 100km).

• multiCountry

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