The purpose for the API is to show available pick-up of return retailers nearby a specified address
Content
| Table of Contents |
|---|
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. |
| 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. |
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 |
...
key
...
value example
...
Authentication
This endpoint requires the user to be authenticated. Refer to the documentation here for more information on how to obtain a valid token to use in your request.
Making a request
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 |
...
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”
}' |
...
:”NO”
}' |
Response
Name | Type |
|---|---|
freightProducts | list of |
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 | |
properties | map of |
Examples
| Expand | |||||||
|---|---|---|---|---|---|---|---|
| |||||||
|
...
| Expand | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
|