Returning Home Delivery Options for a specific day
You would first set up the relevant carrier 'service group(s)' in Delivery Manager. For example, you might create a group and include in it all those services that offer 'Nominated Day' delivery (refer to Setup).
You would then:
-
Specify the latitude/longitude or postal code for the search point.
-
Include only the
NOMINATE
group that you created, by using the incgrp parameter. -
Use return type ggg to return the cheapest delivery option provided by the 'service group' for the next 20 days.
-
Limit the number of nominated day selections to be offered, by setting the limit parameter as required.
-
Specify
HOME
as your optionType.
For example:
GET https://dmo.metapack.com/dmoptions/find?key=<API-Key>&wh_code=SL123&r_t=ggg&optionType=HOME&c_pc=WC1X 8HN&incgrp=NOMINATE&limit=3
The following is an example of the server response (assuming a 200 OK
status):
{ "header": { "requestId": "aa580ccb-5a5f-40ae-8c32-ecd5cd55e7f0", "requestDate": "2020-04-07T16:13:26.453Z", "inputParameters": { "optionType": [ "HOME" ], "c_pc": [ "WC1X 8HN" ], "r_t": [ "ggg" ], "limit": [ "3" ], "wh_code": [ "SL123" ], "key": [ "<API-Key>" ], "incgrp": [ "NOMINATE" ] }, "responseDate": "2020-04-07T16:13:26.556Z" }, "results": [ { "groupCodes": [ "NOMINATE" ], "photoUrls": [], "telephoneNumber": null, "distance": { "unit": "m", "value": 0 }, "description": null, "carrierServiceCode": "PLDTDSATB412", "long": null, "optionType": "HOME", "countryCode": null, "storeName": "", "shippingCharge": 0, "lat": null, "delivery": { "from": "2020-04-08T07:00:00.000Z", "to": "2020-04-08T11:00:59.999Z" }, "address": "", "carrierServiceName": "Desk To Desk SATB412", "postcode": "", "fullName": "DPD Desk To Desk SATB412", "collection": { "from": "2020-04-07T17:00:00.000Z", "to": "2020-04-07T17:30:59.999Z" }, "storeId": null, "logoUrl": null, "storeTimes": {}, "carrierCode": "DPD", "hasDisabledAccess": false, "bookingCode": "PLDTDSATB412/2020-04-07/*-*/*/*-*", "cutOffDateTime": "2020-04-07T16:30:00.000Z" }, { "groupCodes": [ "NOMINATE" ], "photoUrls": [], "telephoneNumber": null, "distance": { "unit": "m", "value": 0 }, "description": null, "carrierServiceCode": "PLDTDSATB412", "long": null, "optionType": "HOME", "countryCode": null, "storeName": "", "shippingCharge": 0, "lat": null, "delivery": { "from": "2020-04-09T07:00:00.000Z", "to": "2020-04-09T11:00:59.999Z" }, "address": "", "carrierServiceName": "Desk To Desk SATB412", "postcode": "", "fullName": "DPD Desk To Desk SATB412", "collection": { "from": "2020-04-08T17:00:00.000Z", "to": "2020-04-08T17:30:59.999Z" }, "storeId": null, "logoUrl": null, "storeTimes": {}, "carrierCode": "DPD", "hasDisabledAccess": false, "bookingCode": "PLDTDSATB412/2020-04-08/*-*/*/*-*", "cutOffDateTime": "2020-04-08T16:30:00.000Z" }, { "groupCodes": [ "NOMINATE" ], "photoUrls": [], "telephoneNumber": null, "distance": { "unit": "m", "value": 0 }, "description": null, "carrierServiceCode": "PLDTDSATB412", "long": null, "optionType": "HOME", "countryCode": null, "storeName": "", "shippingCharge": 0, "lat": null, "delivery": { "from": "2020-04-10T07:00:00.000Z", "to": "2020-04-10T11:00:59.999Z" }, "address": "", "carrierServiceName": "Desk To Desk SATB412", "postcode": "", "fullName": "DPD Desk To Desk SATB412", "collection": { "from": "2020-04-09T17:00:00.000Z", "to": "2020-04-09T17:30:59.999Z" }, "storeId": null, "logoUrl": null, "storeTimes": {}, "carrierCode": "DPD", "hasDisabledAccess": false, "bookingCode": "PLDTDSATB412/2020-04-09/*-*/*/*-*", "cutOffDateTime": "2020-04-09T16:30:00.000Z" } ] }