You will need to decide how the delivery options returned by the API calls are to be presented in your website's front end, and at what stage(s) of the consumer journey.
For examples of the calls and what might be returned, refer to Best Practice and Use Case Examples. Typically, the options that are returned will be presented at the end of the checkout process in some sort of clickable grid (depending on what is selected as the Return Type). However, the options can be presented at different stages of the consumer journey, and in varying formats.
Note
Your Metapack implementation consultant may be able to advise you on ways in which you can lay out the different options.
You should consult your front end developers to ensure that the JSON responses containing the options are parsed appropriately so that they are rendered as required for presentation at each required stage of the consumer journey:
For each carrier service returned as a delivery option, the following are included:
-
The carrier 'service group' (under
groupCodes). -
The
carrierServiceCode(a code representing the specific service offered by the carrier). -
The
carrierServiceName(as referenced by Metapack). -
The
fullNameof the carrier service (this includes the carrier’s name and it might be useful to present this on the front end). -
The
carrierCode. -
The shippingCharge.
-
The delivery window (delivery from/to times).
-
The collection window (collection from/to times).
-
The storeName (for PUDO/own store collections).
-
The storeTimes (for PUDO/own store collections).
-
The bookingCode.
Note
This can be used directly in the Shipping API - refer, for example, to despatchConsignmentWithBookingCode, createAndAllocateConsignmentsWithBookingCode, and allocateConsignmentsWithBookingCode
-
The cutOffDateTime.
Note
Remember that the options will need localising from English (UK) into the appropriate languages, date formats, etc. for your overseas consumers.