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 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. |
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.
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 |
Request-Headers
key | value example | comment |
Authorization | Bearer "SECRET_WS_TOKEN" | See authentication on how to obtain a token |
Content-Type | application/json | |
Idempotency-Key | "defined by client" | Optional, up to 40 characters. see notes for description |
Request body
Name | Type | Example | Mandatory | Max Length | Description |
shopId | whole number | 95123 | n/a | The shop this booking is made for. | |
transportSolutionId | whole number | 1 | 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 | 3 | Country code, according to ISO 3166-1. | |
postalName | string | OSLO | 35 | Also known as postalName. | |
zipCode | string | 0155 | 9 | Also known as postal code. | |
streetAddress | string | Storgaten 11A H0202 | 105 | Combined address information with the following format:
| |
coAddress | String | Hansen | 255 | Care of address |
Eksempel request
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
{
"freightProducts": [
{
"transporterId": 3,
"transporterName": "Postnord AS",
"freightProductId": 3,
"freightName": "Hent i butikk",
"freightTitle": "MyPack Collect",
"freightDescription": "Pakker sendes til butikk med utleveringssted nær mottaker i løpet av 1-3 dager. Pakkene kan spores, og mottaker varsles når pakken kan hentes.",
"servicePoints": [
{
"servicePointExternalId": "3717956",
"servicePointName": "MATKROKEN TÅSEN",
"openingHours": [
{
"to1": "08:00",
"from1": "22:00",
"day": "FRIDAY"
},
{
"to1": "08:00",
"from1": "22:00",
"day": "MONDAY"
},
{
"to1": "09:00",
"from1": "20:00",
"day": "SATURDAY"
},
{
"to1": "08:00",
"from1": "22:00",
"day": "THURSDAY"
},
{
"to1": "08:00",
"from1": "22:00",
"day": "TUESDAY"
},
{
"to1": "08:00",
"from1": "22:00",
"day": "WEDNESDAY"
}
],
"visitingAddress": {
"postalCode": "0870",
"countryCode": "NO",
"streetNumber": "57",
"streetName": "NILS LAURITSSØNSV",
"postalName": "OSLO"
},
"deliveryAddress": {
"postalCode": "0870",
"countryCode": "NO",
"streetNumber": "57",
"streetName": "NILS LAURITSSØNSV",
"postalName": "OSLO"
},
"routingCode": "ALF",
"eligibleParcelOutlet": true,
"servicePointCoordinates": [
{
"northing": 59.949921741607525,
"easting": 10.74988750973147
}
]
},
{
"servicePointExternalId": "3918240",
"servicePointName": "YX 7-ELEVEN TÅSEN",
"openingHours": [
{
"to1": "07:00",
"from1": "23:59",
"day": "FRIDAY"
},
{
"to1": "07:00",
"from1": "23:59",
"day": "MONDAY"
},
{
"to1": "07:00",
"from1": "23:59",
"day": "SATURDAY"
},
{
"to1": "07:00",
"from1": "23:59",
"day": "SUNDAY"
},
{
"to1": "07:00",
"from1": "23:59",
"day": "THURSDAY"
},
{
"to1": "07:00",
"from1": "23:59",
"day": "TUESDAY"
},
{
"to1": "07:00",
"from1": "23:59",
"day": "WEDNESDAY"
}
],
"visitingAddress": {
"postalCode": "0870",
"countryCode": "NO",
"streetNumber": "69",
"streetName": "TÅSENV",
"postalName": "OSLO"
},
"deliveryAddress": {
"postalCode": "0870",
"countryCode": "NO",
"streetNumber": "69",
"streetName": "TÅSENV",
"postalName": "OSLO"
},
"routingCode": "ALF",
"eligibleParcelOutlet": true,
"servicePointCoordinates": [
{
"northing": 59.949740319406075,
"easting": 10.7506910849159
}
]
},
{
"servicePointExternalId": "3713161",
"servicePointName": "JOKER NORDBERG",
"openingHours": [
{
"to1": "08:00",
"from1": "23:00",
"day": "FRIDAY"
},
{
"to1": "08:00",
"from1": "23:00",
"day": "MONDAY"
},
{
"to1": "08:00",
"from1": "23:00",
"day": "SATURDAY"
},
{
"to1": "08:00",
"from1": "23:00",
"day": "THURSDAY"
},
{
"to1": "08:00",
"from1": "23:00",
"day": "TUESDAY"
},
{
"to1": "08:00",
"from1": "23:00",
"day": "WEDNESDAY"
}
],
"visitingAddress": {
"postalCode": "0860",
"countryCode": "NO",
"streetNumber": "21",
"streetName": "CARL KJELSENS V",
"postalName": "OSLO"
},
"deliveryAddress": {
"postalCode": "0860",
"countryCode": "NO",
"streetNumber": "21",
"streetName": "CARL KJELSENS V",
"postalName": "OSLO"
},
"routingCode": "ALF",
"eligibleParcelOutlet": true,
"servicePointCoordinates": [
{
"northing": 59.961251315917366,
"easting": 10.744596727185353
}
]
}
],
"properties": {
"productCode": "19",
"missionCode": "4215780873\u001d9013000355691719",
"issuerNumber": "13",
"customerNumber": "3556917"
}
}
]
}
Eksempel response helthjem
{
"freightProducts": [
{
"transporterId": 62,
"transporterName": "Helthjem AS",
"freightProductId": 55,
"freightName": "Helthjem utlevering butikk",
"freightTitle": "Helthjem butikk",
"freightDescription": "Helthjem butikk. Utlevering av pakke i Helthjem butikk..",
"servicePoints": [
{
"servicePointExternalId": "26584",
"servicePointName": "SNAP SHOP",
"openingHours": [],
"visitingAddress": {
"postalCode": "470",
"countryCode": "NO",
"streetNumber": "3",
"streetName": "GJØVIKGATA",
"postalName": "OSLO"
},
"deliveryAddress": {
"postalCode": "470",
"countryCode": "NO",
"streetNumber": "3",
"streetName": "GJØVIKGATA",
"postalName": "OSLO"
},
"routingCode": null,
"eligibleParcelOutlet": true,
"servicePointCoordinates": [
{
"northing": 59.939205169677734,
"easting": 10.760777473449707
}
]
},
{
"servicePointExternalId": "58495",
"servicePointName": "Helthjem Netthandel testbutikk 4",
"openingHours": [],
"visitingAddress": {
"postalCode": "460",
"countryCode": "NO",
"streetNumber": "86",
"streetName": "COLLETTS GATE",
"postalName": "OSLO"
},
"deliveryAddress": {
"postalCode": "460",
"countryCode": "NO",
"streetNumber": "86",
"streetName": "COLLETTS GATE",
"postalName": "OSLO"
},
"routingCode": null,
"eligibleParcelOutlet": true,
"servicePointCoordinates": [
{
"northing": 59.93356704711914,
"easting": 10.751607894897461
}
]
},
{
"servicePointExternalId": "50373",
"servicePointName": "DIRIKSGATEN KOLONIAL",
"openingHours": [],
"visitingAddress": {
"postalCode": "457",
"countryCode": "NO",
"streetNumber": "7",
"streetName": "DIRIKS' GATE",
"postalName": "OSLO"
},
"deliveryAddress": {
"postalCode": "457",
"countryCode": "NO",
"streetNumber": "7",
"streetName": "DIRIKS' GATE",
"postalName": "OSLO"
},
"routingCode": null,
"eligibleParcelOutlet": true,
"servicePointCoordinates": [
{
"northing": 59.930694580078125,
"easting": 10.747030258178711
}
]
}
],
"properties": {
"routeSeq": "",
"routeZipAndCity": null,
"routingDescription": "",
"distributionDate": "20200212",
"retailerId": "26584",
"routeName": "",
"mainCarNumber": "510",
"routing": "510-90",
"pickupZipString": "",
"routingDetailed": null,
"routeAddress": "GJØVIKG 3",
"routeDescription": null,
"routingCode": ""
}
}
]
}