The purpose of the API is to return last or all events registered for a parcel
...
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.Â
...
Name | Type | Example | Max Length | Mandatory | 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 |
...
Name | Type | Example | Max length | Mandatory | 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 |
...
Name | Type | Example | Max length | Mandatory | 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 |
...
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. |
...