...
The API provides a list of future distribution dates that have delivery or pickup coverage for of a product on the specified address. The product are determined from the freight product (freightProductId
). The remaining fields along with the customer name field will be used to lookup the address in the carrier system.
...
Tip |
---|
Integration tips
|
Setup
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 | 12345 | The coverage check is made with respect to a given shop. |
freightProductId | 55 | An identifier for a valid freight product. |
...
Field | Value |
---|---|
Content-Type | application/json |
Authorization | $SECRET_WS_TOKEN - jwt token from authentication |
Request query parameter
Field | Description | Example | Data type | Mandatory |
---|---|---|---|---|
limit | Defines how many days ahead it should look for coverage. Any value from 1-30, where 14 are the default limit if none is specified | 23 | Integer |
Request body
Field | Description | Example | Data type | Mandatory |
---|---|---|---|---|
shopId | The identifier of the shop that makes the request | 23 | Integer | |
freightProductId | The freight product that we want check the coverage of | 12 | Integer | |
customerName | Customer name | Ola Norrman | String | |
countryCode | Two letter country code of the address | NO | String | |
postalName | City name of the address | Oslo | String | |
zipCode | Zip code of the address | 0155 | String | |
address | Street name of the address | Akersgata 55A H0212 | String | |
co | Care of address of the address | Kari Norrman | String |
Field
Value
Content-Type
application/json
Authorization
Curl request example
Expand | ||
---|---|---|
| ||
|
Response
The endpoint replies with a response object in JSON format, containing the following data
...
Expand | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
|
...