List events from the event log.
...
| Name | Type | Example | Max length | Description |
|---|---|---|---|---|
| shipmentNumber | whole number | 70724760120000880 | 35 | Globally unique identifier for the shipment, typically a GINC code. Typically named MessageNumber, DocumentNumber or ConsignorsReference in EDI. |
| shopName | string | Testbutikken | 50 | Name of the shop/owner party of the shipment |
| shopId | whole number | 1 | 5 | ID of the of the shop/owner party of the shipment |
| consigneeReference | string | o123 | 35 | Usually an orderId or some other reference chosen by the shop/owner party. |
| consignorReference | string | o123 | 35 | Usually an orderId or some other reference chosen by the shop/owner party. |
| properties | properties object | - | n/a | Not in use |
| items | list of items | n/a |
| Anchor | ||||
|---|---|---|---|---|
|
| Name | Type | Example | Max length | Description |
|---|---|---|---|---|
| trackingNumber | whole number | 370724760120000898 | 35 | Unique identifier for an item/kolli in the shipment. This can be a SSCC code according to gs1, or a UPU S10 identifier. Typically named TransporterInstructionMark in EDI. |
| returnCode | string | R-1234 | 10 | Optional additional unique identifier, used for pick up parcels |
| freightProductId | whole number | 1 | 10 | The freight product describes a way of delivery, and is defined by a delivery method and the coverage of the given method. |
| freightProductName | string | ekspress levering hjem | 50 | The freight product describes a way of delivery, and is defined by a delivery method and the coverage of the given method. |
| parcelStatus | string | Levert | 25 | Tracking status for the item/kolli |
| linkedParcelNumbers | list of linkedParcelNumbers | n/a | List of trackingNumber(s) for the same physical object, used when several different ways of delivery have been used. | |
| events | list of events | n/a |
| Anchor | ||||
|---|---|---|---|---|
|
Name | Type | Example | Max Length | Description |
|---|---|---|---|---|
| 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 |
| 93356202 | eventType | eventType object | n/a | Description of the event, will be translated to defined locale |
| 93356202 | additionalInfo | additionalInfo object | n/a | Additional description of the event, will be translated to defined locale |
| 93356202 | 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 |
| 93356202 | 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 | 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 |
| Anchor | ||||
|---|---|---|---|---|
|
...