Versions Compared

Version Old Version 4 New Version 5
Changes made by

Michal Matovcik

Ingrid Oliversen

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The purpose of this API is to registrere an event to a parcel. An event is information about something happening to the specific parcel, it can be a status update or information about consumer communications.

Content

Table of Contents
maxLevel3

...

Info

  • Clients using this API should not fail if new optional fields are added to the API. If a new field is added to the request or response on a later stage, existing clients should handle this in a way such as they just ignore the field.

  • The trackingReference must be already known to the system (created by e.g. the Parcel Booking API)

  • The event is added to an item, not an order.to a parcel (also referred to as kolli or item in Parcel Booking API), not the entire order/booking.

  • The added event is shared with all clients entitled to information about the specific parcel (through Parcel Event Log API v1, Parcel Event Log API v2 or Event Log push service), and used by them as they see fit. If you are uncertain of which fields to populate and how the data will be used consult your carrier.

  • (error) Do not share personal or sensitive information in this API.

Request header

Key

Value

Content-Type

application/json

...

Name

Type

Example

Max Length

Mandatory

Description

trackingReference

string

(00)370724760010119754

35

(tick)

Tracking reference for the item, typically a SSCC gs1 code.

eventTime

string

2020-01-31T00:01:00.000+01:00

n/a

(tick)

Time of the event registered in originating system. Datetime format ISO-8601 :

yyyy-MM-ddTHH:mm:ss+HH:mm

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. This is typically show to the consumer directly so we recommend sharing a general location, e.g. postal name.

locationContextId

string

34567

10

 

Unique identification of the locationContext

eventType

string

001

n/a

(tick)

Identifier for what has happened to the event groupparcel, see list of possible event here (Same as the list of possible events returned in the Event log API and push service).

communicationChannel

string

SMS

n/a

 

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

ComChannelTypes  in use:

  • SMS

  • EMAIL

message

string

255

 

Optional message from the system registering the event

...

HTTP Status code

Description

200

Event was successfully registered

Examples

Code Block
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. og search online with the HTTP status code. The HTTP error keys used are based on the standard, and therefore available online (Tips to search “HTTP code XXX”)
...