Versions Compared

Key

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

The purpose of the API is to return last or all events registered for a parcel

...

Name

Type

Example

Max length

Mandatory

Description

id

whole number

1

n/a

(tick)

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

...

Expand
titleList of additionalinfoAPIkeys

An additionalinfoAPIkey must always be considered in the context of a main event.

Access level determines start of translation key. Can be either one of:

  • event.type.ai.pub

  • event.type.ai.shopadmin

  • event.type.ai.distr.

For example: event.type.ai.distr.cannot.deliver.customer.absent

main event (trigger)

additionalinfoAPIkey

i18nkey - translation key

Description

(015) Return

001

.cannot.deliver.missing.deliverypoint

carrier can't find customer

(057) Not delivered / (015) Return

002

.cannot.deliver.missing.key

Key missing

(057) Not delivered / (015) Return

003

.cannot.deliver.parcel.damaged

shipment damaged

(057) Not delivered / (015) Return

004

.cannot.deliver.customer.changed.address

The recipient has changed address

(015) Return

005

.cannot.deliver.customer.absent

The recipient is absent, on vacation or does not collect the shipment

006(030) Lost

006

.cannot.deliver.shipment.lost.internal

in our value chain

(030) Lost

007

.cannot.deliver.shipment.lost.external

before our value chain

Address collector form

008

.consignee.notification.response.updated

with new details

Address collector form

009

.consignee.notification.response.same.address

and confirmed existing delivery address

Address collector form

010

.consignee.notification.response.wrong.address

with a new delivery address

(013) Delivered

011

.shipment.delivered.door

on the doormat

(013) Delivered

012

.shipment.delivered.mailbox

in the mailbox

(013) Delivered

013

.shipment.delivered.bag

Mailbox (Bag and hook)

(015) Return

014

.cannot.deliver.unfit.deliverypoint

Unsuited delivery point

(031) Unable to pick-up

015

.unable.to.pickup.not.found

The parcel was not found

(031) Unable to pick-up

016

.unable.to.pickup.not.marked

The parcel was not clearly marked

(031) Unable to pick-up

017

.unable.to.pickup.not.wrapped

Not packed according to instructions

(031) Unable to pick-up

018

.unable.to.pickup.too.big

The parcel was too heavy/big

(031) Unable to pick-up

019

.unable.to.pickup.no.customer.contact

Unable to reach costumer

(031) Unable to pick-up

020

.unable.to.pickup.missing.key

Key missing

(031) Unable to pick-up

021

.unable.to.pickup.return.lost

Return-parcel lost

(032) Picked-up

022

.shipment.retrieved.at.route.branch

Received at route branch

(032) Picked-up

023

.shipment.retrieved.not.at.rout.branch

Not received at route branch

(057) Not delivered

024

.cannot.deliver.not.received

carrier did not receive the shipment

(057) Not delivered

025

.cannot.deliver.missing.deliverypoint.mailbox

carrier can't find customer. Mailbox delivery

(057) Not delivered

026

.cannot.deliver.missing.deliverypoint.house.door

carrier can't find customer. Delivery at house

(057) Not delivered

027

.cannot.deliver.missing.deliverypoint.apartment.door

carrier can't find customer. Delivery in apartment

(057) Not delivered

028

.cannot.deliver.shipment.lost.stolen

Stolen

...