Parcel Event Log v1

The purpose of the API is to return last or all events registered for a parcel

Content

Setup

	Example
Username (see Authentication section)	wsfoobar
Password (see Authentication section)	a-very-very-long-password

The user is a web service user
The user has access to the web service for event log

Environments / endpoints

TEST GET	https://staging-ws.di.no/ws/json/parcel/tracking/v-1/fetch/{identifier}/{locale}/{onlyLastEvent}
PRODUCTION GET	https://ws.di.no/ws/json/parcel/tracking/v-1/fetch/{identifier}/{locale}/{onlyLastEvent}

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

Clients using this API should not fail if new fields are added to the response. If a new field is added to the response on a later stage, existing clients should handle this in a way such as they just ignore the field.
Fields not set in the response are not left out, that is fields in the response may have null values. E.g. "shipmentNumber": null. The client using the endpoint should handle this.
For shipments older than 6 months no events will be available

Request header

key	value example	comment
Authorization	Bearer $SECRET_WS_TOKEN	see Parcel Event Log v1#Authentication
Content-Type	application/json

Path parameters

parameter

example

description

identifier

370724760010119754

Shipment or item identifier

locale

NO

Language code. eventDescription will be translated to locale. Supported languagecodes are currently:

NO - Norwegian
EN - English

onlyLastEvent

false

If set to true only the last registered event is returned. Last registered is decided based on eventTime. If false, all available events are returned

Curl request example

curl --request GET --url https://staging-ws.di.no/ws/json/parcel/tracking/v-1/fetch/370724760120000898/NO/false  \
     --header "Authorization: Bearer $SECRET_WS_TOKEN"  \
     --header 'Content-Type: application/json' \

Response

Name	Type	Description
events	list of events	List of events

Events

Name	Type	Example	Max Length	Description
shipmentNumber	string	(401)70712190172720651	35	Globally unique identifier for the shipment. Typically a GINC code.
trackingReference	string	(00)370724760010119754	35	Tracking reference for the item, typically a SSCC gs1 code.
eventTime	string	2017-08-22 13:55:13	19	Time of the event registered in originating system. Datetime format yyyy-MM-dd HH:mm:ss
lat	double	59.911096	9	Latitude for the location of the event
lon	double	10.752457	9	Longitude for the location of the event
locationContext	string	Osloveien 14, 0288 Oslo	255	Address or description of the location/ context of the event
locationContextId	string	34567	10	Unique identification of the locationContext
Parcel Event Log v1#eventType	eventType	eventType object	n/a	Description of the event, will be translated to defined locale
Parcel Event Log v1#additionalInfo	additionalInfo	additionalInfo object	n/a	Additional description of the event, will be translated to defined locale
Parcel Event Log v1#eventGroup	eventGroup	eventGroup object	n/a	Groupage of event, e.g. transportation events, communication events etc.
communicationChannel	string	SMS	n/a	Communication channel only used for event types within event group "communication". ComChannelTypes in use: SMS EMAIL
changeUserId	whole number	112233	n/a	Internal user identification responsible for the event taking place. Only returned for callees having the highest access level
Parcel Event Log v1#regSystem	regSystem	regSystem object	n/a	System that registered the event
message	string		255	Optional message from the system registering the event

eventType

Name	Type	Example	Max length	Description
apiKey	string	001	n/a	Identifier for the event group
description	string	Package received	n/a	Static description of the event, will be translated to defined locale
i18nKey	string	event.type.pub.shipment.received	n/a	Key which can be used to add your own translations

additionalInfo

Name	Type	Example	Max length	Description
apiKey	string	001	n/a	Identifier for the additional info group
description	string	Package received	n/a	Static description of the event, will be translated to defined locale. Can be concatenated with the Parcel Event Log v1#eventType description for a more detailed description. The formatting is already taken care of
i18nKey	string	event.type.pub.shipment.received	n/a	Key which can be used to add your own translations

eventGroup

Name	Type	Example	Max length	Description
id	whole number	1	n/a	identifier for the event group
name	string	communcation	n/a	named classification of the group

Group id	Description
1	Information on shipments received/imported in DI
2	Information on transportation
3	Information on communication
4	Information on status updates
5	Information on scanning of shipments
6	Information for shipments transported by others
7	Information from/relating to external systems
8	Information on internal processing

regSystem

Name	Type	Example	Max length	Description
id	whole number	1	n/a	identifier for the originating system
name	string	Postnord	n/a	named classification of the originating system

List of possible events

Response from Pacel Event Log API (no/en).pdf

Examples

Example response

{
    "events": [
        {
            "shipmentNumber": "70724760120000880",
            "trackingNumber": "370724760120000898",
            "eventTime": "2017-11-09 07:00:39",
            "lat": null,
            "lon": null,
            "locationContext": null,
            "eventType": {
                "apiKey": "011",
                "description": "Pakke levert sendt til mottaker"
            },
			"additionalInfo": null,
            "eventGroup": {
                "id": 3,
                "name": "Communication"
            },
            "comChannelType": "SMS",
            "changeUserId": null,
            "regSystem": null,
            "message": null
        },
        {
            "shipmentNumber": "70724760120000880",
            "trackingNumber": "370724760120000898",
            "eventTime": "2017-11-09 04:13:23",
            "lat": null,
            "lon": null,
            "locationContext": "OSLO",
            "eventType": {
                "apiKey": "013",
                "description": "Pakken er levert til mottaker"
            },
            "additionalInfo": null,
			"eventGroup": {
                "id": 4,
                "name": "Status"
            },
            "comChannelType": null,
            "changeUserId": null,
            "regSystem": null,
            "message": null
        },
		{
            "shipmentNumber": "70724760120000880",
            "trackingNumber": "370724760120000898",
            "eventTime": "2017-11-08 23:00:39",
            "lat": null,
            "lon": null,
            "locationContext": "OSLO",
            "eventType": {
                "apiKey": "057",
                "description": "Pakken er ikke levert"
            },
            "additionalInfo": {
                "apiKey": "001",
                "description": ". Finner ikke mottakers leveringspunkt"
            },
            "eventGroup": {
                "id": 4,
                "name": "event.type.group.status"
            },
            "comChannelType": null,
            "changeUserId": null,
            "regSystem": {
                "id": 2,
                "name": "eBudbok"
            },
            "message": null
        },
        {
            "shipmentNumber": "70724760120000880",
            "trackingNumber": "370724760120000898",
            "eventTime": "2017-11-08 15:00:39",
            "lat": null,
            "lon": null,
            "locationContext": "Nettbutikk AS",
            "eventType": {
                "apiKey": "001",
                "description": "Informasjon om forsendelsen er mottatt"
            },
			"additionalInfo": null,
            "eventGroup": {
                "id": 1,
                "name": "Import"
            },
            "comChannelType": null,
            "changeUserId": null,
            "regSystem": null,
            "message": null
        }
    ]
}

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.

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.
500	Unexpected Server Error	Oops! This indicates an error on our side, and there is nothing more you can do. Please [email\|mailto:support@di.no] us a description of your problem and we will see what we can do.

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.