Check coverage
Learn about the Single Address Check endpoint and how to check coverage of delivery options for a given address.
Overview
This endpoint can be used before booking a parcel to ensure that the delivery options for an address are available. This is useful to create a checkout that shows delivery options that the consumer can select with confidence.
Why and when to use Single Address Check
transportSolutionId:"1" is useful to get maximum coverage, but offers the least flexibility for consumer experience, it is the most simple way to book a parcel as Helthjem handles all of the fall-backs automatically. However, for a more tailored consumer experience a delivery method can be confirmed at checkout, before booking by using coverage checks with stand-alone transport solutions.
Check transport solutions at checkout
If you have several Helthjem transport solutions in your e-commerce checkout, you will need to check coverage for each of them.
Examples
Example 1: Confirm home delivery coverage
In this example, a shop wants to confirm at checkout that a consumer can get a home delivery for an item in their e-commerce basket.
After collecting the consumers address, the shop sends a request to the Single Address Check with the address and transportSolutionId:"2", which contains ONLY freightProductId: 1 - Home delivery.
Possible responses:
-
Alternative 1:
"productName": "HELTHJEM"- Standard home delivery -
Alternative 2:
"no.carrier.support”- No coverage
Request
{
"shopId": "1",
"transportSolutionId": "2",
"customerName":"Test customer",
"address": "Kongsberggata 18",
"zipCode": "0468",
"postalName": "Oslo",
"countryCode": "NO",
"weight": 1000
}Response
{
"productName": "HELTHJEM",
"routeName": "21507",
"companyId": 1,
"routing": "16-0-x21507x1466",
"routingCode": "1",
"routeAddress": "TÅSENVEIEN 26",
"routeDescription": "BUDSENTRAL TÅSEN",
"handoverId": 3223047,
"handoverCity": "OSLO",
"handoverZipCode": "484",
"handoverStreetName": "SANDAKERVEIEN",
"handoverStreetNumber": 121,
"handoverDescription": "MNO TRYKK NYDALEN",
"routingDescription": "TÅSEN",
"plannedDeparture": "2230"
}The response contains “productName”: “HELTHJEM” which confirms that transportSolutionId:"2" is available for this address and can be shown in checkout.
Example 2: Confirm Service point coverage
In this example, a shop wants to confirm at checkout that a consumer can get Service Point delivery for an item in their e-commerce basket.
After collecting the consumers address, the shop sends a request to the Single Address Check with the address and transportSolutionId:"62", which contains freightProductId: 55 and freightProductId: 3 - Helthjem and Postnord Service point delivery.
Possible responses:
-
Alternative 1:
"productName": "Helthjem_SHOP"- Helthjem Service point delivery -
Alternative 2:
"productName": "POSTNORD_MYPACK"- PostNord Service point delivery -
Alternative 3:
"no.carrier.support”- No coverage
Request
{
"shopId": "1",
"transportSolutionId": "62",
"customerName":"Test customer",
"address": "Å-veien 45",
"zipCode": "8392",
"postalName": "Sørvågen",
"countryCode": "NO",
"weight": 1000
}Response
{
"productName": "Helthjem_SHOP",
"routeName": "",
"companyId": null,
"routing": "476-26",
"routingCode": null,
"routeAddress": "MOSKENESVEIEN 865",
"routeDescription": null,
"handoverId": null,
"handoverCity": null,
"handoverZipCode": null,
"handoverStreetName": null,
"handoverStreetNumber": null,
"handoverDescription": null,
"routingDescription": "LOFOTEN",
"plannedDeparture": null
}The response contains “productName”: “helthjem_SHOP” which confirms that the parcel can be delivered with home delivery. transportSolutionId:"62" is available for this address and can be shown in checkout.
Requests and responses
When you send a request for coverage check, the API responds with productName which corresponds to a freightProductId. The table below shows the correlations.
|
Freight product |
Response |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|