Single Address Check API

The Single Address Check API is designed to check coverage for delivery options for a given address and customer. It will take the address, contact info and delivery options in the request and give back the best delivery option and transport details for it.

Why use Single Address Check

Zip codes can be partially covered (e.g., “0484 Oslo” might be ~75% home-eligible).
Use standalone transport solutions with Single Address Check API when you must keep the promise (e.g., “Home only”).
Use fallback solutions when coverage is more important than the exact method.

Setup

Make sure you have the following information at hand before proceeding.

	Description
`shopID`	All bookings are made with respect to a given shop.
`transportSolutionID`	An identifier for a valid transport solution.

Environments / Endpoints

Environment	Method	URL
Production	POST	`https://api.helthjem.no/parcels/v1/addresses/find/single`
Pre-Production	POST	`https://api.pre.helthjem.no/parcels/v1/addresses/find/single`

Request-Header

Key	value example
Authorization	`Bearer <token>`
Content-Type	`application/json`

Request body

Field	Description	Data type	Example	Required
`shopID`	The identifier of the shop that makes the request.	string	1	✅
`transportSolutionID`	The transport solution that we want transport information from.	string	55	✅
`customer name`	Name of party/person.	string	Ola Nordmann
`address`	Combined address information:

Street name
Street number (with leading space)
Entrance
Apartment number | string | Storgaten 11A H0202 | ⚠️ Required for home delivery | | zipcode | Also known as postal code. | string | 0155 | ✅ | | postalName | Also known as city. | string | Oslo | ✅ | | countryCode | Two letter country code, according to ISO 3166-1. | string | NO | ✅ | | weight | The weight of the shipment | integer | 1000 | |

Depending on the transportSolutionId you send in the request and address coverage, you will get either:

🟢 200 HTTP status code and productName of available delivery method
🔴 400 HTTP status code and "no.carrier.support” message, which means that Helthjem can not deliver to a address with the chosen method, i.e. transportsolution

Read more about Transport Solutions here: Transport solution concept .