Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The purpose for the API is to show available pick-up of or return retailers nearby a specified address.

Content

Table of Contents
minLevel1
maxLevel2
typeflat

Setup

Make sure you have the following information at hand before proceeding.

...

Expand
titleExample 1
Code Block
{
    "freightProducts": [
        {
            "transporterId": 3,
            "transporterName": "Carrier AS",
            "freightProductId": 3,
            "freightName": "Pickup point",
            "freightTitle": "Pickup point Collect",
            "freightDescription": "PakkerParcel sendesdelivered til butikk med utleveringssted nær mottaker i løpet av 1-3 dager. Pakkene kan spores, og mottaker varsles når pakken kan hentes.at pick-up point, consumer wil receive a message when it is ready",
            "servicePoints": [
                {
                    "servicePointExternalId": "3717956717956",
                    "servicePointName": "MATKROKENFOOD TÅSENSTORE",
                    "openingHours": [
                        {
                            "to1": "08:00",
                            "from1": "22:00",
                            "day": "FRIDAY"
                        },
                        {
                            "to1": "08:00",
                            "from1": "22:00",
                            "day": "MONDAY"
                        },
                        {
                            "to1": "09:00",
                            "from1": "20: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": "0870",
                        "countryCode": "NO",
                        "streetNumber": "575",
                        "streetName": "NILSOSLO LAURITSSØNSVSTREET",
                        "postalName": "OSLO"
                    },
                    "deliveryAddress": {
                        "postalCode": "0870",
                        "countryCode": "NO",
                        "streetNumber": "575",
                        "streetName": "NILSOSLO LAURITSSØNSVSTREET",
                        "postalName": "OSLO"
                    },
                    "routingCode": "ALFOSL",
                    "eligibleParcelOutlet": true,
                    "servicePointCoordinates": [
                        {
                            "northing": 59.949921741607525,
                            "easting": 10.74988750973147
                        }
                    ]
                },
                {
                    "servicePointExternalId": "3918240391820",
                    "servicePointName": "YX 7-ELEVEN TÅSENKIOSK A",
                    "openingHours": [
                        {
                            "to1": "07:00",
                            "from1": "23:59",
                            "day": "FRIDAY"
                        },
                        {
                            "to1": "07:00",
                            "from1": "23:59",
                            "day": "MONDAY"
                        },
                        {
                            "to1": "07:00",
                            "from1": "23:59",
                            "day": "SATURDAY"
                        },
                        {
                            "to1": "07:00",
                            "from1": "23:59",
                            "day": "SUNDAY"
                        },
                        {
                            "to1": "07:00",
                            "from1": "23:59",
                            "day": "THURSDAY"
                        },
                        {
                            "to1": "07:00",
                            "from1": "23:59",
                            "day": "TUESDAY"
                        },
                        {
                            "to1": "07:00",
                            "from1": "23:59",
                            "day": "WEDNESDAY"
                        }
                    ],
                    "visitingAddress": {
                        "postalCode": "0870",
                        "countryCode": "NO",
                        "streetNumber": "696",
                        "streetName": "TÅSENV",
                        "postalName": "OSLO"
                    },
                    "deliveryAddress": {
                        "postalCode": "0870",
                        "countryCode": "NO",
                        "streetNumber": "696",
                        "streetName": "TÅSENV",
                        "postalName": "OSLO"
                    },
                    "routingCode": "ALFSTV",
                    "eligibleParcelOutlet": true,
                    "servicePointCoordinates": [
                        {
                            "northing": 59.949740319406075,
                            "easting": 10.7506910849159
                        }
                    ]
                },
                {
                    "servicePointExternalId": "3713161371309161",
                    "servicePointName": "JOKER NORDBERGKIOSK",
                    "openingHours": [
                        {
                            "to1": "08:00",
                            "from1": "23:00",
                            "day": "FRIDAY"
                        },
                        {
                            "to1": "08:00",
                            "from1": "23:00",
                            "day": "MONDAY"
                        },
                        {
                            "to1": "08:00",
                            "from1": "23:00",
                            "day": "SATURDAY"
                        },
                        {
                            "to1": "08:00",
                            "from1": "23:00",
                            "day": "THURSDAY"
                        },
                        {
                            "to1": "08:00",
                            "from1": "23:00",
                            "day": "TUESDAY"
                        },
                        {
                            "to1": "08:00",
                            "from1": "23:00",
                            "day": "WEDNESDAY"
                        }
                    ],
                    "visitingAddress": {
                        "postalCode": "0860",
                        "countryCode": "NO",
                        "streetNumber": "21",
                        "streetName": "CARL KJELSENS V",
                        "postalName": "OSLO"
                    },
                    "deliveryAddress": {
                        "postalCode": "0860",
                        "countryCode": "NO",
                        "streetNumber": "21",
                        "streetName": "CARL KJELSENS V",
                        "postalName": "OSLO"
                    },
                    "routingCode": "ALFOSL",
                    "eligibleParcelOutlet": true,
                    "servicePointCoordinates": [
                        {
                            "northing": 59.961251315917366,
                            "easting": 10.744596727185353
                        }
                    ]
                }
            ],
            "properties": {
                "productCode": "19",
                "missionCode": "4215780873\u001d9013000355691719u001d90(1)9K3000355691719",
                "issuerNumber": "13",
                "customerNumber": "317"
            }
        }
    ]
}
Expand
titleExample 2
Code Block
{
    "freightProducts": [
        {
            "transporterId": 868234,
            "transporterName": "HelthjemCarrier AS",
            "freightProductId": 51,
            "freightName": "HelthjemPickup utleveringat butikkshop",
            "freightTitle": "HelthjemCollect butikkparcel",
            "freightDescription": "HelthjemPickup butikk. Utlevering av pakke i Helthjem butikk.at shop",
            "servicePoints": [
                {
                    "servicePointExternalId": "264",
                    "servicePointName": "SNAP SHOP",
                    "openingHours": [],
                    "visitingAddress": {
                        "postalCode": "74701234",
                        "countryCode": "NO",
                        "streetNumber": "133",
                        "streetName": "GJØVGATA",
                        "postalName": "OSLO"
                    },
                    "deliveryAddress": {
                        "postalCode": "74701234",
                        "countryCode": "NO",
                        "streetNumber": "133",
                        "streetName": "GJØVGATA",
                        "postalName": "OSLO"
                    },
                    "routingCode": null,
                    "eligibleParcelOutlet": true,
                    "servicePointCoordinates": [
                        {
                            "northing": 59.939205169677734,
                            "easting": 10.760777473449707
                        }
                    ]
                },
                {
                    "servicePointExternalId": "549554095",
                    "servicePointName": "Helthjem Netthandel testbutikk 4",
                    "openingHours": [],
                    "visitingAddress": {
                        "postalCode": "9460",
                        "countryCode": "NO",
                        "streetNumber": "8268",
                        "streetName": "COLLETTS VEI",
                        "postalName": "OSLO"
                    },
                    "deliveryAddress": {
                        "postalCode": "9460",
                        "countryCode": "NO",
                        "streetNumber": "826",
                        "streetName": "COLLETTS VEI",
                        "postalName": "OSLO"
                    },
                    "routingCode": null,
                    "eligibleParcelOutlet": true,
                    "servicePointCoordinates": [
                        {
                            "northing": 59.93356704711914,
                            "easting": 10.751607894897461
                        }
                    ]
                },
                {
                    "servicePointExternalId": "503235033",
                    "servicePointName": "DIRIKSGATENKIOSK KOLONIAL",
                    "openingHours": [],
                    "visitingAddress": {
                        "postalCode": "457",
                        "countryCode": "NO",
                        "streetNumber": "72",
                        "streetName": "DIR' GATE",
                        "postalName": "OSLO"
                    },
                    "deliveryAddress": {
                        "postalCode": "457",
                        "countryCode": "NO",
                        "streetNumber": "72",
                        "streetName": "DIR' GATE",
                        "postalName": "OSLO"
                    },
                    "routingCode": null,
                    "eligibleParcelOutlet": true,
                    "servicePointCoordinates": [
                        {
                            "northing": 59.930694580078125,
                            "easting": 10.747030258178711
                        }
                    ]
                }
            ],
            "properties": {
                "routeSeq": "",
                "routeZipAndCity": null,
                "routingDescription": "",
                "distributionDate": "20200212",
                "retailerId": "26584",
                "routeName": "",
                "mainCarNumber": "510",
                "routing": "510-90",
                "pickupZipString": "",
                "routingDetailed": null,
                "routeAddress": "GJØVIKGadr 3",
                "routeDescription": null,
                "routingCode": ""
            }
        }
    ]
}

...

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

...

Field

Description

statusCode

The HTTP code associated with this error.

errorKey

A machine parseable error code.

errorMap

Additional details pertaining to the error.

...

Other notes

DI receive Norwegian postal numbers and coordinates from GEODATA (🔗 LINK) - based on this our algorithm calculates closest ServicePoint