List events from the event log.
This document is laid out as follows
Setup
Access to API | Example |
|---|---|
Username (see Authentication section) | wsfoobar |
Password (see Authentication section) | a-very-very-long-password |
Making a request
Notes
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.
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}
|
Request header
key | value example | comment |
|---|---|---|
Authorization | Bearer $SECRET_WS_TOKEN | |
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:
|
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 |
Authentication
The endpoint require authentication, as described here: LoginV2
Response body
Name | Type | Description |
|---|---|---|
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 |
eventType | eventType object | n/a | Description of the event, will be translated to defined locale | |
additionalInfo | additionalInfo object | n/a | Additional description of the event, will be translated to defined locale | |
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:
|
changeUserId | whole number | 112233 | n/a | Internal user identification responsible for the event taking place. Only returned for callees having the highest access level |
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 |
Example Request/response
Curl request
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
{
"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
}
]
}
List of possible events
Response from Pacel Event Log API (no/en).pdf