https://di.no/doc

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

This enables external systems to add events and information to parcels flowing through the distribution networks powered by DI technology.

Authorization and access

In order to send information you need to initiate this with you transport carrier og partner.
Any external part adding information will be limited to the selection of parcels they are entitled to.

Production and test environments are available


Preparation

In order to start sending events the following values needs to be set up, this is done with you transport carrier or partner.

Value

Purpose

URL

URL where events should be posted

Origin

Defines you as a sender in our system

event- eventTypeID

ID which identifies the type of action or information.

event - originOrderEventSystemId

Defines your ID in our system

Who can access the information you send?

Information and events added will be used according to agreement between DI and costumer (your transport carrier or partner). A common purpose is to provide accurate tracking, e.g. available through Parcel Event Log V2.

Do not share personal or sensitive information.

Message

One message contains one event. Events can only be added to known shipments, identified by tracking reference (see shipment structure here)


The default message format is expected to be JSON with the following base structure.

Name

Type

Example

Mandatory

Max length

Comment

namespace

string

external

(tick)

8

Static value

system

string

n/a

origin

string

MyCompany

(tick)

20

Static value agreed on

timestamp

string

1516278802

(tick)

Time in seconds since epoch on the origin host. Dependent on time synchronization, but even with inconsistencies it can be used to detect processing slowness and age.

version

string

1

(tick)

5

event

list

-

Se table below

Event

Name

Type

Example

Mandatory

Max length

Comment

identifier

string

370724760010119754

(tick)

n/a

Tracking reference or item identifier as previously registered. Do not include prefix.

message

string


255

Message describing the event.

eventTime

string

2017-08-22 13:55:13

(tick)

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

locationName

string

Oslo

(tick)

255

Address or description of the location of the event

eventTypeId

whole number

1

(tick)

n/a

Identification for the type of the event. This ID defines which message is shown to different users . Agreed on before start

comChannelType

string

SMS

no

n/a

Communication channel only used for event types within event group "communication".

ComChannelTypes  in use:

  • SMS

  • EMAIL

originOrderEventSystemId

whole number

1

(tick)

n/a

Identification of the external system this event originates from. Agreed on before start

Example

"namespace": "external",
"system": "",
"origin": "MyCompany",
"timestamp": epochtid in secounds
"version": "1",
"event":{
      "parcelNumber":"370724761643133330",
      "message":"Parcel delivered",
      "eventTime":"2019-10-29 14:11:00",
      "lat":null,
      "lon":null,
      "locationName":Oslo,
      "locationContextId":null,
      "eventTypeApiKey":"13",
      "additionalInfoApiKey":null,
      "comChannelType":null,
      "originOrderEventSystemId":11
  }
  • No labels