Request

This section describes the query string parameters that the find service makes use of. If an error occurs, an error response is returned instead. See the “Error Responses” section.

MetaPack Options uses one of two option repository systems, designated by Blue and Green. The following tables also identify which parameters are available in which distribution. Please make sure you use the right parameters which are available for the distribution you are using.

Identification

Query parameter Format Required? Description Blue Green
key string yes Security key (UUID) as provided by MetaPack Support during registration.

Shipping location (sender)

Query parameter Format Required? Description Default value Blue Green
wh_code string yes Code DEFAULT (*1)
wh_pc string no Postcode EC1R 4PF
wh_cc string no ISO 3166 alpha-3 3 letter country code GBR
wh_l1 string no First line of the address DEFAULT -
wh_l2 string no Second line of the address DEFAULT -
wh_l3 string no Third line of the address DEFAULT -
wh_l4 string no Fourth line of the address DEFAULT -
wh_street string no Street name - -
wh_house_nr string no House number - -
wh_city string no City - -

Notes

  1. It is important to identify the shipping location (using the wh_code parameter). The default value is only valid if there is effectively a location with code DEFAULT.

Customer (receiver)

Query parameter Format Required? Description Default value Blue Green
c_lat double conditional Latitude - (*1) (*1)(*3)
c_long double conditional Longitude - (*1) (*1)(*3)
c_pc string conditional Postcode - (*1) (*1)(*3)
c_cc string yes ISO 3166 alpha-3 3 letter country code GBR
c_l1 string no First line of the address DEFAULT -
c_l2 string no Second line of the address DEFAULT -
c_l3 string no Third line of the address DEFAULT -
c_l4 string no Fourth line of the address DEFAULT -
c_street string no Street name - -
c_house_nr string no House number - -
c_city string no City - -
c_district string no District - -
c_province string no Province - -
c_po_box_set boolean no Indicates whether address is PO Box or not FALSE -
c_mobile string no Mobile phone number - -
c_email string no Email address - -
c_name string no Name - -

Notes

  1. The values of c_lat and c_long, if provided, will take precedence over c_pc and other address fields. This behaviour is superseded by (*2) in UAT and the new behaviour will be rolled out into production in Sept. 2019.
  2. When both c_lat/c_long and c_pc provided then c_lat/c_long will be used for PUDO/OWNSTORE lookup and c_pc will be used for HOME delivery.
  3. In order to guarantee a consistent PUDO/OWNSTORE lookup when both c_lat/c_long and c_pc provided then c_lat/l_long must represent the coordinates of c_pc.

Parcel / Consignment / Product

Query parameter Format Required? Description Default value Blue Green
e_maxdim integer no Length (in cm) of the longest dimension of the biggest parcel (*1) 0
e_maxweight float no Weight (in kg) of the heaviest parcel (*1) 0
e_n integer no Estimated number of parcels 1
e_w float no Estimated weight (in kg) of the whole consignment (*2) 0.01
e_v float(*3) no Consignment value -
e_v_currency string no Consignment value currency -
parcelHeight string (*4) no Height of each parcel -
parcelWidth string (*4) no Width of each parcel -
parcelDepth string (*4) no Depth of each parcel -
parcelWeight string (*4) no Weight of each parcel -
consignmentLevelDetailsFlag boolean no Consignment level details flag (*5) true
cod_amount double no Cash on delivery amount (*6) 0.0
cod_currency string no Cash on delivery currency -
hazmat_codes string no Hazardous codes (*7) -
skus string (*8) no SKU list (*9) - -

Notes

  1. If the value is set to 0, it's not considered in retrieving options.
  2. Sum of all the parcel weights.
  3. When provided the value will be split equally across all parcels. Example: if value provided is 10.0 and number of parcels is 4 then a value of 2.5 will be assigned to each parcel.
  4. Comma separated list of single precision floating point numbers. The number of elements in the list should be equal to parcelCount. Example: 2.0,3,9.2
  5. False means that the parcel details are included in the call and the parcelHeight, parcelWidth, parcelDepth and parcelWeight parameters are parsed and used in the calculation.
  6. Applicable if the consignment is for cash on delivery. Default value of 0.0 means the consignment is not cash on delivery.
  7. Comma-separated list of codes. Applicable if consignment contains any hazardous goods.
  8. List of SKUs. Parcel groups are separated by semicolon, products in the same parcel are separated by comma. Ex.: x,y;z Products x and y are part of the same parcel, product z is in a parcel of its own.
  9. Mutually exclusive with e_maxdim, e_maxweight, e_n, e_w, parcelHeight, parcelWidth, parcelDepth, parcelWeight and consignmentLevelDetailsFlag.

Filtering

Delivery

Query parameter Format Required? Description Default value Blue Green
r_t string yes Return type (*1) - -
incgrp string no Include groups (*2) - -
excgrp string no Exclude groups (*3) - -
acceptableCollectionSlots string no Acceptable collection slots (*4) - -
acceptableDeliverySlots string no Acceptable delivery slots (*4) - -
limit int no Limit to this many options (*5) -
optionType string no Option type (*6) ALL
multiCountry boolean no Include locations from multiple countries (*7) false

Notes

  1. 3-letter string, values are from: ggg, gss, gsc, lgg, lss, lsc or lsd. The return type which indicates what kind of options search you want to perform. See return types for more information.
  2. Comma-separated list of service groups to include. Only services in these groups will be considered. By default, all services are considered.
  3. Comma-separated list of service groups to exclude. Services in these groups will not be considered. By default, all services are considered.
  4. Two timestamps to mark the respective window, separated by a comma.
  5. Not applicable to own stores, if minown or maxown parameters are provided.
  6. Comma-separated list of types of the options required. Avaliable option types: HOME, PUDO, OWNSTORE. Example: PUDO,OWNSTORE
  7. Different to the one specified via the c_cc parameter.

Locations

Query parameter Format Required? Description Default value Blue Green
radius int no Radius in metres 1000
minown int no Include at least these many own stores -
maxown int no Limit to these many own stores (*1) 100
minpudo int no Include at least these many PUDOs (*2) - -
maxpudo int no Limit to these many PUDOs (*1) 100 -
language string Lowercase ISO 639-1 two-letter code Preferred language for locations (*3) - - -

Notes

  1. Setting high value for max* parameters may increase response time, therefore it is advised to set those to some reasonable values.
  2. The number of PUDOs for which options are returned is dependent upon the carrier-configuration of the back-end system.
  3. This parameter will take effect only for locations that have data in given language, all the other locations will be returned in the default language they are available.For more information, see

Verbose mode

Verbose mode provides additional information on request processing. For example togling verbose mode GEOCODING(verbose=GEOCODING) for requests that require geocoding will provide additional information on the accuracy of geocoding.

Query parameter Format Required? Description Default value Blue Green
verbose string no Toggles verbose modes - -

Available modes

Name Description
GEOCODING Provide additional information on geocoding, like geocoding accuracy
ALLOCATION Provide additional information on response, like if response contains allocation options for all requested PUDOs

Click here for more information on verbose mode.

Other

Query parameter Format Required? Description Default value Blue Green
user_timezone string no User time zone - -
custom1 ... custom10 string no 10 custom fields - -

results matching ""

    No results matching ""