Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

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

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.

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.

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

Example response (helthjem)

[
    {
        "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 (postnord)

[
    {
        "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
            }
        ]
    }
]
  • No labels