Parcel Get All Servicepoints API

The API provides all service points registered for a specified transporter.

Content

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.
transporterId	123	Identifier to provide all servicepoint for a given transporter

The user is a web service user
The user has access to the web service for service points

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.

TEST GET	https://staging-ws.di.no/ws/json/parcel/servicePoint/v-1/X
PRODUCTION GET	https://ws.di.no/ws/json/parcel/servicePoint/v-1/X

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

Notes

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.
This API is to be used twice each day. Higher frequency over a period of time may be blocked to twice each day.

Request-Headers

key	value example	comment
Authorization	Bearer "SECRET_WS_TOKEN"	See authentication on how to obtain a token
Content-Type	application/json
transporterId	1234	Provided by your transport contractor

Curl request example

curl --location --request GET 'https://ws.di.no/ws/json/parcel/servicePoint/v-1/5' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer Token

Response

List of currently active servicePoint objects. Permanently closed (not closed based on opening hours) or not optional service points are not included in the results.

ServicePoint

Name	Type	Example	Description
servicePointExternalId	whole number	3452	ID for the location
servicePointName	String	My local store	Name of location
openingHours	List of opening hours		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
deliveryAddress	Address object
routingCode	String	WJE	Used on labels and sorting systems
eligibleParcelOutlet	boolean	true	May be used by some carriers to indicate whether a service point handles parcels.
servicePointCoordinates	List of `coordinate` objects

Examples

Example response 1

[
    {
        "servicePointExternalId": "11931",
        "servicePointName": "MENY OSLO CITY",
        "openingHours": [],
        "visitingAddress": {
            "postalCode": "50",
            "countryCode": "NO",
            "streetNumber": "1",
            "streetName": "STENERSGATA",
            "postalName": "OSLO"
        },
        "deliveryAddress": {
            "postalCode": "50",
            "countryCode": "NO",
            "streetNumber": "1",
            "streetName": "STENERSGATA",
            "postalName": "OSLO"
        },
        "routingCode": null,
        "eligibleParcelOutlet": true,
        "servicePointCoordinates": [
            {
                "northing": 10.75289535522461,
                "easting": 59.91301727294922
            }
        ]
    }
  ]

Example response 2

[
    {
        "servicePointExternalId": "3643871",
        "servicePointName": "BUNNPRIS HUNDHAMAREN",
        "openingHours": [
            {
                "to1": "08:00",
                "from1": "22:00",
                "day": "FRIDAY"
            },
            {
                "to1": "08:00",
                "from1": "22:00",
                "day": "MONDAY"
            },
            {
                "to1": "09:00",
                "from1": "22: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": "7562",
            "countryCode": "NO",
            "streetNumber": "12",
            "streetName": "SJÃ\u0098LYSTV",
            "postalName": "HUNDHAMAREN"
        },
        "deliveryAddress": {
            "postalCode": "7562",
            "countryCode": "NO",
            "streetNumber": "12",
            "streetName": "SJÃ\u0098LYSTV",
            "postalName": "HUNDHAMAREN"
        },
        "routingCode": "TRH",
        "eligibleParcelOutlet": true,
        "servicePointCoordinates": [
            {
                "northing": 10.598498043937115,
                "easting": 63.43640156200448
            }
        ]
    }
]

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

{
    "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.