Page Comparison

The purpose for the API is to show available pick-up or return retailers nearby a specified address.

Content

Table of Contents

minLevel	1
maxLevel	2
type	flat

Setup

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

...

	Example	Description
Username (see Authentication section)	wsfoobar	A valid username.
Password (see Authentication section)	a-very-very-long-password	A password matching given username.
shopId	1234	All

bookings

requests are made with respect to a given shop.
transportSolutionId	5	An identifier for a valid transport solution. The transport solution determines how the booked package will be distributed.

...

The user is a web service user
The user has access to the web service for coverage check
The user has access to the specified shop
The shop has access to the specified transport solution

Environments

Consider using the TEST-endpoint while developing your system. By doing this you ensure that your test-data will not pollute any potential external systems.

TEST	POST	https://staging-ws.di.no/ws/json/freightcoverage/v-1/servicepoints
PRODUCTION	POST	https://ws.di.no/ws/json/freightcoverage/v-1/servicepoints

...

key

...

value example

...

comment

...

Authorization

...

Bearer "SECRET_WS_TOKEN"

...

Authentication

This endpoint requires the user to be authenticated. Refer to the documentation here for more information on how to obtain a

...

Content-Type

...

application/json

...

Idempotency-Key

...

"defined by client"

...

Optional, up to 40 characters. see notes for description

...

Name

...

Type

valid token to use in your request.

Making a request

Info
Clients using this API should not fail if new optional fields are added to the API. If a new field is added to the request or response on a later stage, existing clients should handle this in a way such as they just ignore the field.

Request headers

Key	Value example	Comment
Authorization	Bearer "SECRET_WS_TOKEN"	See authentication on how to obtain a token
Content-Type	application/json

Request body

Name	Type	Example	Mandatory	Max Length	Description
shopId	whole number	95123	Image Modified	n/a	The shop this booking is made for.
transportSolutionId	whole number	1	Image Modified	n/a	A transport solution is a construct that contains multiple freight products. Its purpose is to group what freight products a customer has access to.
countryCode	string	NO	Image Modified	3	Country code, according to ISO 3166-1.
postalName	string	OSLO		35	Also known as postalName.
zipCode	string	0155	Image Modified	9	Also known as postal code.
streetAddress	string	Storgaten 11A H0202		105	Combined address information with the following format: Street name Street number (with leading space) Entrance Floor type (only relevant for countryCode=NO) H (main floor) U (basement) L (attic) K (cellar) Floor number Flat number
coAddress	String	Hansen		255	Care of address

...

Curl request example

Code Block

curl -X POST \
  https://staging-ws.di.no/ws/json/freightcoverage/v-1/servicepoints \
H 'Authorization: Bearer Token' \
H 'Content-Type: application/json' \
d '{
"shopId" : 1,
"transportSolutionId":1,
"streetAddress":"Nedre skøyen vei 18a",
"zipCode":"0276",
"postalName":"oslo",
“countryCode”:”NO”
}'

Eksempel response Postnord

...

Response

Name	Type
freightProducts	list of `freightProducts` objects

freightProducts

Name	Type	Example
transporterId	whole number	3
transporterName	String	Carrier AS
freightProductId	whole number	4
freightName	String	Express delivery
freightTitle	String	Express home delivery
freightDescription	String	Delivery on doormat before 07:00 a.m.
servicePoints	list of `servicePoints` objects

servicePoints

Name	Type	Example
servicePointExternalId	whole number	3345345
servicePointName	String	Pick up point store
openingHours	list of `openingHours` objects	There may be more than 1 time intervall for each day, this will be shown as two separate objects E.g. Monday 08:00-10:00 and Monday 14:00-18:00
visitingAddress	address object	see example below
deliveryAddress	address object	see example below
routingCode	String	ERT
eligibleParcelOutlet	boolean	see example below
servicePointCoordinates	List of `coordinate` objects	see example below

Examples

Expand

title	Example 1

Code Block
{ "freightProducts": [ {

"openingHours":

[

       "transporterId": 3,
            "transporterName": "Carrier AS",

{

"freightProductId": 3,

to1

freightName": "

08:00

Pickup point",
            "freightTitle": "Pickup point Collect",
            "

from1

freightDescription": "

22:00",

Parcel delivered at pick-up point, consumer wil receive a message when it is ready",
            "servicePoints": [

"day":

"FRIDAY"

},

         "servicePointExternalId": "717956",

{

      "servicePointName": "FOOD STORE",
                    "

to1

openingHours": [
                        {
                            "to1": "08:00",
                            "from1": "22:00",
                            "day": "

MONDAY

09

08:00",
                            "from1": "

20

22:00",
                            "day": "

SATURDAY

08

09:00",
                            "from1": "

22

20:00",
                            "day": "

THURSDAY

SATURDAY"
                        },
                        {
                            "to1": "08:00",
                            "from1": "22:00",
                            "day": "

TUESDAY

THURSDAY"
                        },
                        {
                            "to1": "08:00",
                            "from1": "22:00",
                            "day": "

WEDNESDAY

TUESDAY"
                        },

],

"visitingAddress":

{

          "to1": "08:00",

"postalCode":

"0870",

"countryCode

"from1": "

NO

22:00",

"streetNumber":

"57",

streetName

day": "

NILS LAURITSSØNSV

WEDNESDAY"

,

"postalName": "OSLO"

}

],
                    "

deliveryAddress

visitingAddress": {
                        "postalCode": "0870",
                        "countryCode": "NO",
                        "streetNumber": "

57

5",
                        "streetName": "

NILS

OSLO

LAURITSSØNSV

STREET",
                        "postalName": "OSLO"
                    },
                    "

routingCode

deliveryAddress":

"ALF",

 {
                        "

eligibleParcelOutlet

postalCode":

true

"0870",

"servicePointCoordinates":

[

  "countryCode": "NO",

{

   "streetNumber": "5",
                        "

northing

streetName":

59.949921741607525

 "OSLO STREET",

"easting": 10.74988750973147

"postalName": "OSLO"
                    },

}

               "routingCode": "OSL",

]

                "eligibleParcelOutlet":

}

true,

{

    "servicePointCoordinates": [

"servicePointExternalId":

"3918240",

"servicePointName":

"YX

7-ELEVEN

TÅSEN",

            "northing": 59.949921741607525,

"openingHours": [

                     "easting": 10.74988750973147
                        }

{

"to1": "07:00",

  },
                {

"from1":

"23:59",

       "servicePointExternalId": "391820",
                    "

day

servicePointName": "

FRIDAY

KIOSK A",
                    "openingHours": [

},

                      {
                            "to1": "07:00",
                            "from1": "23:59",
                            "day": "

MONDAY

FRIDAY"
                        },
                        {
                            "to1": "07:00",
                            "from1": "23:59",
                            "day": "

SATURDAY

MONDAY"
                        },
                        {
                            "to1": "07:00",
                            "from1": "23:59",
                            "day": "

SUNDAY

SATURDAY"
                        },
                        {
                            "to1": "07:00",
                            "from1": "23:59",
                            "day": "

THURSDAY

SUNDAY"
                        },
                        {
                            "to1": "07:00",
                            "from1": "23:59",
                            "day": "

TUESDAY

THURSDAY"
                        },
                        {
                            "to1": "07:00",
                            "from1": "23:59",
                            "day": "

WEDNESDAY

TUESDAY"
                        },

],

"visitingAddress":

{

"postalCode

"to1": "

0870

07:00",
                            "

countryCode

from1": "

NO

23:59",

"streetNumber":

"69",

"streetName

"day": "

TÅSENV

WEDNESDAY"

,

"postalName": "OSLO"

}

],
                    "

deliveryAddress

visitingAddress": {
                        "postalCode": "0870",
                        "countryCode": "NO",
                        "streetNumber": "

69

6",
                        "streetName": "TÅSENV",
                        "postalName": "OSLO"
                    },
                    "

routingCode

deliveryAddress":

"ALF",

 {
                        "

eligibleParcelOutlet

postalCode":

true

"0870",
                        "

servicePointCoordinates

countryCode":

[

"NO",

{

"streetNumber": "6",

northing

streetName":

59.949740319406075

"TÅSENV",

easting

postalName":

10.7506910849159

"OSLO"
                    },

]

"routingCode": "STV",

},

     "eligibleParcelOutlet": true,

{

          "servicePointCoordinates": [

"servicePointExternalId":

"3713161",

"servicePointName": "JOKER

NORDBERG",

openingHours

northing":

[

59.949740319406075,

{

    "easting": 10.7506910849159
                        }

"to1":

"08:00",

"from1": "23:00",

 },
                {
                    "

day

servicePointExternalId": "

FRIDAY"

371309161",
                    "servicePointName": "JOKER KIOSK",

},

"openingHours": [
                        {
                            "to1": "08:00",
                            "from1": "23:00",
                            "day": "

MONDAY

FRIDAY"
                        },
                        {
                            "to1": "08:00",
                            "from1": "23:00",
                            "day": "

SATURDAY

MONDAY"
                        },
                        {
                            "to1": "08:00",
                            "from1": "23:00",
                            "day": "

THURSDAY

SATURDAY"
                        },
                        {
                            "to1": "08:00",
                            "from1": "23:00",
                            "day": "

TUESDAY

THURSDAY"
                        },
                        {
                            "to1": "08:00",
                            "from1": "23:00",
                            "day": "

WEDNESDAY

TUESDAY"
                        },

],

"visitingAddress": {

postalCode

to1": "

0860

08:00",
                            "

countryCode

from1": "

NO

23:00",

"streetNumber":

"21",

"streetName

"day": "

CARL KJELSENS V

WEDNESDAY"

,

"postalName": "OSLO"

}

],
                    "

deliveryAddress

visitingAddress": {
                        "postalCode": "0860",
                        "countryCode": "NO",
                        "streetNumber": "21",
                        "streetName": "CARL KJELSENS V",
                        "postalName": "OSLO"
                    },
                    "

routingCode

deliveryAddress":

"ALF",

{
                        "

eligibleParcelOutlet

postalCode":

true

"0860",
                        "

servicePointCoordinates

countryCode":

[

"NO",

{

"streetNumber": "21",

northing

streetName":

59.961251315917366,

"CARL KJELSENS V",
                        "

easting

postalName":

10.744596727185353

"OSLO"
                    },

}

                 "routingCode": "OSL",

]

}

"eligibleParcelOutlet": true,

],

properties

servicePointCoordinates":

{

"productCode":

"19",

"missionCode":

"4215780873\u001d9013000355691719",

issuerNumber

northing":

"13"

59.961251315917366,

"customerNumber": "3556917"

            "easting": 10.744596727185353

}

]

}

...

Code Block

{

"freightProducts":

[

{

"transporterId": 62,

"transporterName":

"Helthjem

AS",

"freightProductId":

55

],
            "

freightName

properties": {

"Helthjem

utlevering

butikk",

freightTitle

productCode": "

Helthjem butikk

19",
                "

freightDescription

missionCode": "

Helthjem butikk. Utlevering av pakke i Helthjem butikk..",

4215780873\u001d90(1)9K3000355691719",
                "

servicePoints

issuerNumber":

[

"13",

{

"customerNumber": "317"
            }

"servicePointExternalId":

"26584",

 }
    ]
}

Expand

title	Example 2

Code Block
{

"servicePointName

"freightProducts":

"SNAP

SHOP",

        {
            "

openingHours

transporterId":

[]

234,
            "transporterName": "Carrier AS",

"visitingAddress":

{

      "freightProductId": 1,

postalCode

freightName": "

470

Pickup at shop",
            "freightTitle": "Collect parcel",
            "

countryCode

freightDescription": "

NO

Pickup at shop",
            "servicePoints": [

"streetNumber": "3",

      {
                    "

streetName

servicePointExternalId": "

GJØVIKGATA

264",

postalName

servicePointName": "

OSLO

SNAP SHOP",

}

"openingHours": [],
                    "

deliveryAddress

visitingAddress": {
                        "postalCode": "

470

1234",
                        "countryCode": "NO",
                        "streetNumber": "3",
                        "streetName": "

GJØVIKGATA

GJØVGATA",
                        "postalName": "OSLO"
                    },
                    "

routingCode

deliveryAddress":

null,

{
                        "

eligibleParcelOutlet

postalCode":

true

"1234",

"servicePointCoordinates":

[

   "countryCode": "NO",

{

    "streetNumber": "3",
                        "

northing

streetName":

59.939205169677734,

"GJØVGATA",
                        "

easting

postalName":

10.760777473449707

"OSLO"

},

]

"routingCode": null,

},

     "eligibleParcelOutlet": true,

{

          "servicePointCoordinates": [

"servicePointExternalId": "58495",

"servicePointName":

"Helthjem

Netthandel

testbutikk

4",

openingHours

northing":

[]

59.939205169677734,

"visitingAddress":

{

       "easting": 10.760777473449707

"postalCode": "460",

        }
                    ]

"countryCode":

"NO",

},

"streetNumber":

"86",

    {
                    "

streetName

servicePointExternalId": "

COLLETTS GATE

54095",
                    "servicePointName": "Helthjem Netthandel testbutikk 4"

postalName": "OSLO"

}

"openingHours": [],
                    "

deliveryAddress

visitingAddress": {
                        "postalCode": "

460

9460",
                        "countryCode": "NO",
                        "streetNumber": "

86

8",
                        "streetName": "COLLETTS

GATE

VEI",
                        "postalName": "OSLO"
                    },
                    "

routingCode

deliveryAddress":

null,

 {
                        "

eligibleParcelOutlet

postalCode":

true

"9460",

"servicePointCoordinates":

[

   "countryCode": "NO",

{

    "streetNumber": "826",
                        "

northing

streetName":

59.93356704711914

 "COLLETTS VEI",

"easting": 10.751607894897461

"postalName": "OSLO"
                    },

}

                "routingCode": null,

]

                "eligibleParcelOutlet":

}

true,

{

    "servicePointCoordinates": [

"servicePointExternalId":

"50373",

"servicePointName":

"DIRIKSGATEN

KOLONIAL",

             "northing": 59.93356704711914,

"openingHours":

[],

visitingAddress

easting":

{

10.751607894897461

"postalCode": "457",

}
                    ]

"countryCode":

"NO",

},

"streetNumber":

"7",

    {
                    "

streetName

servicePointExternalId": "

DIRIKS' GATE

5033",

postalName

servicePointName": "

OSLO

KIOSK KOLONIAL",

}

 "openingHours": [],
                    "

deliveryAddress

visitingAddress": {
                        "postalCode": "457",
                        "countryCode": "NO",
                        "streetNumber": "

7

72",
                        "streetName": "

DIRIKS

DIR' GATE",
                        "postalName": "OSLO"
                    },
                    "

routingCode

deliveryAddress": {

null,

eligibleParcelOutlet

postalCode":

true

"457",
                        "

servicePointCoordinates

countryCode":

[

"NO",

{

"streetNumber": "72",

northing

streetName":

59.930694580078125

"DIR' GATE",

easting

postalName":

10.747030258178711

"OSLO"
                    },

}

                 "routingCode": null,

]

}

"eligibleParcelOutlet": true,

],

properties

servicePointCoordinates": [

{

"routeSeq":

"",

"routeZipAndCity":

null,

routingDescription

northing":

""

59.930694580078125,

"distributionDate":

"20200212",

          "easting": 10.747030258178711

"retailerId":

"26584",

"routeName": "",

mainCarNumber

properties":

"510",

{
                "

routing

routeSeq": "

510-90

",
                "

pickupZipString

routeZipAndCity":

""

null,
                "

routingDetailed

routingDescription":

null

"",
                "

routeAddress

distributionDate": "

GJØVIKG 3

20200212",
                "

routeDescription

retailerId":

null

"26584",
                "

routingCode

routeName": "",
                "mainCarNumber": "510",
                "routing": "510-90",
                "pickupZipString": "",
                "routingDetailed": null,
                "routeAddress": "adr 3",
                "routeDescription": null,
                "routingCode": ""
            }
        }
    ]
}

Error handling

API requests that result in errors will return an appropriate HTTP status code to help you identify the type of error. You can use the table below to understand what each code means. og search online with the HTTP status code. The HTTP error keys used are based on the standard, and therefore available online (Tips to search “HTTP code XXX”)

In addition to HTTP status there may be more details in the errorKey field. Error Keys can be added at a later stage, clients should handle this as well as an empty value for errorKey.

HTTP Status code	Text	Description
400	Client or Validation Error	The request body/query string is not in the correct format.
401	Authentication Failure	Indicates that the Authorization header is either missing or incorrect. You can learn more about the Authorization header here.
403	Access denied	This indicates that the agent whose credentials were used in making this request was not authorized to perform this API call. It could be that you do not have access to the shop or transportsolution you provided in your request. If you believe this is a mistake, please reach out to your contact so it can be rectified.
405	Method not allowed	This API request used the wrong HTTP verb/method. For example a PUT request will result in this error.
4xx	Client error	Generally receiving an error code that starts with 4 indicates that the client needs to change something.
500	Unexpected Server Error	Oops! This may indicates an error on our side. Please try again, if the error continues notify your contact person

Error response

In addition to the HTTP status code, most errors will also return a response body that contains more information to help you debug the error. A sample error response is shown below. The format of the error response body is explained after the example.

Sample error

Code Block

language	xml

{
    }
"statusCode": 401,
    "errorKey": "authentication.missing",
 }     ]"errorMap": {}
}

...

Field	Description
statusCode	The HTTP code associated with this error.
errorKey	A machine parseable error code.
errorMap	Additional details pertaining to the error.

...

Other notes

DI receive Norwegian postal numbers and coordinates from GEODATA (🔗 LINK) - based on this our algorithm calculates closest ServicePoint

Versions Compared

Old Version 6

New Version Current

Key

Setup

Environments

Authentication

Making a request

Eksempel response Postnord

Response

Examples

Error handling

Error response

Sample error