Versions Compared

Old Version 2

changes.mady.by.user Ingrid Oliversen

Saved on

compared with

New Version Current

changes.mady.by.user Ingrid Oliversen

Saved on

Key

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

Template som utgangspunkt for API dokumentasjon som lages. Kun synlig for DI brukere

  • Enda ikke synlig for andre en DI brukere, endre synlighet når APiet legges i produksjon eller dokumentasjonen er klar

This API will provide details from last mile delivery

...

Table of Contents
3
maxLevel2
minLevel1
typeflat

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.

  • The user is a web service user

  • The user has access to the web service for event log

  • The user has access to the shop where registering the parcel is booked for

Environments / endpoints

TEST

Status
colourBlue
title

POST

get

http://staging-ws.di.no/ws/json/parcel/tracking/v-2/deliveryinfo/{identifier}

PRODUCTION

Status
colourBlue
title

POST

get

https://ws.di.no/ws/json/parcel/tracking/v-2/deliveryinfo/{identifier}

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

  • 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.

  • Only parcels marked with Eventlog API Key 124 will possibly provide results. Do not use this API for parcels who do not have that mark. Use Parcel Event Log V2 , Parcel Event Log v1 or Parcel events push notification to recieve this information.

  • Client should handle empty images URLs, the URL may point to an empty site at any point and will always be empty after 30 days

Request header

Key

Value

Authorization

Code Block
Bearer $SECRET_WS_TOKEN

see Setup

Content-Type

application/json

...

Path parameters

...

Name

...

Type

...

Example

...

Mandatory

...

Description

...

Name

parameter

Type

Example

Example

Description

Mandatory

IdentifierType

Max Length

Description

Response

shipmentid

supported identifyerTypes are shipmentId, trackingReference and pickupCode

Identifier

70724760120000880

Globally unique identifier for the specified identifierType.

Curl request example

Code Block
curl -X GET \
  https://dev-ws.di.no/ws/json/parcel/tracking/v-2/deliveryinfo/trackingreference/370724760120000898 \
  -H 'Authorization: Bearer $SECRET_WS_TOKEN' \
  -H 'Content-Type: application/json' \

Response

Note

Guidelines for use of image URLs

  • Clients should always link to URLs provided in this API when displaying the images.

  • Clients should NOT store a copy of the images provided though URL on their side. It is a violation of GDPR to store the image on client side.

  • Do not use the image provided directly on other sites, such as e-mail and SMS communication. Always provide a link to a site where the information is loaded directly from this API. If used directly the image may not be altered or removed by owner.

  • Do not send the URL we provide directly to a consumer, link consumers to a site where the client use the image URLs.

  • We do not take responsibility for image quality or content.

Body:

Name

Type

Example

Mandatory

Description

parcelDeliveryProof

Object

URL

(tick)

object with trackingreferences

parcelDeliveryProof Body:

Name

Type

Example

Mandatory

Description

trackingReference

list

URL

(tick)

details for trackingreferences

trackingReferenceBody:

Name

Type

Example

Mandatory

Description

distrDat

date

(tick)

distribution date

images

list of image URL’s

url to images of parcel delivery point

labelImageUrl

string

url to image of parcel label

scanned

boolean

indicates if parcel was scanned on delivery

timestamp

timestamp

date and time for delivery

Examples

Expand
titleExample 1 - Parcel with delivery info
Code Block
{
    "parcelDeliveryProof": {
        "370724761842123456": [
            {
                "distrDate": "2021-04-29",
                "images": [
                    {
                        "imageUrl": "https://img-budbuddy.aws.di.no/original/b4637de2-1e9c-40d9-b86f-be3123456abcdef.jpg",
                        "note": null
                    },
                    {
                        "imageUrl": "https://img-budbuddy.aws.di.no/original/0966a1f4-ec11-49d2-a429-123456abcdef.jpg",
                        "note": null
                    }
                ],
                "labelImageUrl": "https://img-budbuddy.aws.di.no/original/ec3bb3c0-f208-4080-9cf0-f759ac123456abcdef.jpg",
                "scanned": false,
                "timestamp": "2021-04-29T14:14:04.067746Z"
            }
        ]
    },
    "errors": {}
}

Expand
titleExample 2 - Parcel with no Last Mile delivery information
Code Block
{
    "parcelDeliveryProof": {},
    "errors": {}
}

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.

...

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.