logo

Delivery time API

 
PROD: https://api.helthjem.no/delivery-time/v1/{countryCode}/{zipCode}/{freightProductId}{?scanTime=timestamp}
PRE-PROD: https://api.pre.helthjem.no/delivery-time/v1/{countryCode}/{zipCode}/{freightProductId}{?scanTime=timestamp}
PROD: https://api.helthjem.no/delivery-time/v1/{countryCode}/{zipCode}/{freightProductId}{?scanTime=timestamp} PRE-PROD: https://api.pre.helthjem.no/delivery-time/v1/{countryCode}/{zipCode}/{freightProductId}{?scanTime=timestamp}
The Delivery Time API provides an estimated delivery time for a shipment. A scan time must be provided. The returned value is the estimated number of delivery days (from scan time) to a delivery.
scanTime is a main parameter of request. You need to estimate when a parcel you are sending will be delivered to Helthjem’s sorting facility to get an arrival scan.
📘
Example: A booking is made on 25 Jan 2023 at 20:00 on your website. If you estimate that the package will reach Helthjem distribution center in 2 days. Then the scan time should be 2023-01-27T14:00:00. Exact hour depends on what is agreed pick-up time from your warehouse.
In response you will get deliveryDays. Can be only positive integer. The value already considers weekends, public holidays and peak seasons fluctuations. You can present it to a customer as number of days, e.g “2 working days” or you can transform it to an exact delivery date with text “estimated delivery date”
API currently supports freight products:
  • 1 (Standard home delivery)
  • 5 (Express home delivery)
  • 55 (Delivery to a service-point)

Try it yourself with Swagger UI

Request Path Parameters

Name
Type
Example
Description
countryCode
string(2)
NO
Two letter country code. For now only “NO” is supported.
zipCode
string(4)
0572
A destination zip code for query. For “NO” a 4-digit string.
freightProductId
number
1
Supported freight products. Currently 1, 5, 15.
scanTime
string
2022-11-30T14:55:19Z – or –20221130T145519Z
An estimation of when a parcel will be scanned at Helthjem’s sorting center. Add an extra day to scanTime if the parcel will be picked up the day after the booking is made.

Response

Name
Type
Example
Description
deliveryDays
number
2
Positive integer. Number of days from scan time to delivery.

Error Responses

statusCode
errorKey
errorMap
Description
400
invalid.zipCode
Returned if model does not know of this zip code
400
invalid.scanTime
Returned if scanTime is provided and in invalid format.
400
invalid.freightProductId
Returned if the product is not known.
400
invalid.countryCode
Returned if countryCode is not “NO”
401
Unauthorized
Returned if request done without authorization
429
rate.limit.exceeded
Requests limit is reached

Request limits

In case of rate limit exception 429 HTTP status code will be returned. The rate limit for incoming requests is 10000 requests per 5 minutes.

Request example

bash
curl -X 'GET' \ 'https://api.helthjem.no/delivery-time/v1/NO/0570/1?scanTime=2022-11-30T14%3A55%3A19Z' \ -H 'accept: application/json'

Response example

json
{ "deliveryDays": 2 }