Response

This identifies a successful response.

Field Format Description
header JSON object Request and monitoring data.
results JSON Array The delivery options to present to the customer for selection.
Field Format Description Example value
inputParameters JSON object A map containing all input parameters. {"c_pc":["EC1R 4PF"],"r_t":["lsc"],"wh_l2":["London"], "r_t":["ggg"]}
requestDate date The date & time the request arrived. "requestDate":"2014-10-31T15:07:16.241Z"
requestId UUID A UUID which uniquely identifies the request. This can be used by MetaPack Support. "requestId":"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
responseDate date The date & time the response was ready and started being sent to the client. "responseDate":"2014-10-31T15:07:17.221Z"

Results

Eeach delivery option in the results array is defined by following properties.

Field Format Description Example value
bookingCode string The code to use to identify this specific delivery option, when integrating with MetaPack Options -
carrierCode string A code that identifies the carrier -
carrierServiceCode string A code representing the specific service offered by the specific carrier -
carrierServiceName string The name of the carrier service (as known by MetaPack) -
collection JSON object with two properties, "from" and "to" The period of time the collection will be made from the shipping location -
collection.from date The time the carrier arrives at the shipping location -
collection.to date The time the carrier departs the shipping location -
delivery JSON object with two properties, "from" and "to" The period of time during which the carrier might deliver the consignment -
delivery.from date The earliest possible delivery date -
delivery.to date The latest possible delivery date. If it’s a nominated day service, this will be the same as the “from” -
fullName string The full name of the service (which includes the carrier’s name). This might be useful for presenting on the screen -
groupCodes[] array of strings A list of all the service groups this service is a member of -
cutOffDateTime datetime The cutoff date and time for the carrier in UTC. "2019-08-16T09:30:59.999Z"
shippingCharge float The amount the customer needs to pay for this service -
lat double-precision float The latitude of the location -
long double-precision float The longitude of the location -
storeTimes JSON object with properties "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" The opening and closing times per weekday. If the result references a home delivery option, this value is an empty string -
storeTimes.monday array of time range formatted strings The opening and closing times for Monday. Time ranges are formatted as "hh:mm-hh:mm" "Monday":[ "06:30-18:30" ]
storeTimes.tuesday array of time range formatted strings The opening and closing times for Tuesday. Time ranges are formatted as "hh:mm-hh:mm" "Tuesday":[ "08:00-10:00", “12:00-22:00” ]
storeTimes.wednesday array of time range formatted strings The opening and closing times for Wednesday. Time ranges are formatted as "hh:mm-hh:mm" -
storeTimes.thursday array of time range formatted strings The opening and closing times for Thursday. Time ranges are formatted as "hh:mm-hh:mm" -
storeTimes.friday array of time range formatted strings The opening and closing times for Friday. Time ranges are formatted as "hh:mm-hh:mm" -
storeTimes.saturday array of time range formatted strings The opening and closing times for Saturday. Time ranges are formatted as "hh:mm-hh:mm" -
storeTimes.sunday array of time range formatted strings The opening and closing times for Sunday. Time ranges are formatted as "hh:mm-hh:mm" -
address string The pick up delivery location address (*1) -
postcode string The postcode of the pick up delivery location -
distance JSON object with properties "value", "unit" The approximate distance from customer address to the delivery location -
distance.value double The approximate distance value (*2) -
distance.unit string The unit of the distance provided in the response m
storeId string Id of store -
storeName string Store Name -
photoUrls array of url strings Urls for store photos -
logoUrl string Url for logo -
hasDisabledAccess boolean Boolean specifying whether store had disabled access or not false
telephoneNumber string Store telephone number -
locationProviderId string (UUID) Location Provider ID -
optionType string Type of option (PUDO,OWNSTORE,HOME) PUDO

Notes

  1. If the result references a home delivery option, this value is an empty string.
  2. For home deliveries the value will be 0.

Info

Additional information will be returned from system only if any of the verbose modes is togled.

Field Format Description Example value
geocoding.accuracy string(*1) Geocoding accuracy "ADDRESS"

Notes

  1. Geocoding accuracy is classified as "ADDRESS", "COUNTRY" and "NOT_FOUND". Accuracy "COUNTRY" is returned whenever geocoding can only match country, for all other matches accuracy "ADDRESS" is returned. If nothing matched then accuracy "NOT_FOUND" is returned.

results matching ""

    No results matching ""