The API provides endpoints which allow to programmatically create and edit shops.
[ Setup ] [ Environments / endpoints ] [ Authentication ] [ Making a request ] [ Path Parameters ] [ Query Parameters ] [ Response ] [ Examples ] [ Error handling ] [ Error response ]
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. |
(for edit) Shop ID | 123 | Unique identifier for a shop in DI database |
| Info |
|---|
|
Environments / endpoints
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.
Create shop
TEST
| |||||||
PRODUCTION
|
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
| Info |
|---|
Notes
|
Request-Headers
key | value example | comment |
Authorization | Bearer "SECRET_WS_TOKEN" | See authentication on how to obtain a token |
Request Body
Name | Mandatory | Example | Description |
|---|---|---|---|
ownerPartyKey |
| owner-party-name | Unique owner party identifier in DI database |
| Shop object which will be persisted | ||
customerSystem |
| ||
transportSolutionIds |
|
Shop
Name | Mandatory | Example | Description |
|---|---|---|---|
id | ⚠️ | Must be empty when creating a new shop | |
organizationNumber | 123 456 789 | Applicable based on the regional regulations | |
| email@test.com | ||
| Warehouse’s address | ||
legalName | Company AS | Shop’s legal name | |
delivererEDI | EDI software used | ||
vatLiable | true | Whether shop is vat liable; will be set to false if not sent | |
webShopPlatform | Egen | Ecommerce platform | |
ceo | John Doe | Shop’s CEO | |
customerManager | John Doe | Shop’s customer manager | |
contactPersonPhone | 58692698 | Phone number of a contact person | |
externalCustomerIds | [{“freightProductId”: 1, “customerNumber”: 1}] | Unique combination of customer number and freight product id |
Address
Name | Mandatory | Example | Description |
|---|---|---|---|
street | Normannsgata | Warehouse’s street name | |
streetNumber | 5 | Warehouse’s street number | |
entrance | A | Warehouse’s entrance name, up to 5 characters | |
zipCode | 1265 | Warehouse’s zip code; 4 digits in Norway, 5 digits in Sweden | |
city | Oslo | Warehouse’s city | |
countryCode | NO | Warehouse’s country code; valid values: NO, SE, DE, EN, FI, SV |
Customer system
Name | Mandatory | Example | Description |
|---|---|---|---|
name |
| ||
shortName |
| ||
customerFacingName | |||
addressCollector |
Curl request example
| Code Block |
|---|
Response
Examples
| Expand | ||
|---|---|---|
| ||
|
Update shop
TEST
| |||||||
PRODUCTION
|
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
| Info |
|---|
Notes
|
Request-Headers
key | value example | comment |
Authorization | Bearer "SECRET_WS_TOKEN" | See authentication on how to obtain a token |
Curl request example
| Code Block |
|---|
Response
Examples
| Expand | ||
|---|---|---|
| ||
|
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 owner party you provided in your request. If you believe this is a mistake, please reach out to your contact so it can be rectified. |
404 | Not found | The resource (i.e. shop) for provided {identifier} does not exist. |
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 |
|---|
{
"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. |