Notification variables

In this table you can find all CPu variables used in the notifications and their explanation.

Variable in notification

Explanation

Can be NULL if no information was provided

1

[...]_identification_code_apcs

APCS code (unique identifier on C-point) of the relevant party indicated by the […]. This can be:

  • Sender;

  • Carrier;

  • ReleaseFrom;

  • ReleaseTo.

 

2

[...]_identification_code_duns

DUNS number (https://www.dnb.com/duns-number.html ) of the relevant party indicated by the […]. This can be:

  • Sender;

  • Carrier;

  • ReleaseFrom;

  • ReleaseTo.

X

3

[...]_identification_code_eori

EORI number of the relevant party indicated by the […]. This can be:

  • Sender;

  • Carrier;

  • ReleaseFrom;

  • ReleaseTo.

X

4

[...]_identification_code_nxtentityid

NxtEntityId (or NxtPort ID) of the relevant party indicated by the […]. This can be:

  • Sender;

  • Carrier;

  • ReleaseFrom;

  • ReleaseTo.

 

5

[...]_identification_code_tin

TIN (Tax Identification Number) number of the relevant party indicated by the […]. This can be:

  • Sender;

  • Carrier;

  • ReleaseFrom;

  • ReleaseTo.

For EU countries this is the VAT number as validated through the EU VIES https://ec.europa.eu/taxation_customs/vies/ .

 

6

[...]_name

Registered company name of the relevant party indicated by the […]. This can be:

  • Sender;

  • Carrier;

  • ReleaseFrom;

  • ReleaseTo;

  • Shipping Agent;

  • Terminal.

 

7

alfapass_number_mask

Masked (for privacy & security reasons) Alfapass number of the driver assigned for pick up.

e.g. "**12"

X

8

bl_number

Transport document (B/L or SWB) number of the shipment(s) inside the container.

 

9

driver_alias

Alias of the driver assigned for pick up.

X

10

empty_return_reference

Empty return reference of the container. Not fully implemented in CPu yet. Be sure to ask Shipping Agent if they provide this info.

X

11

equipment_number

Container number.

 

12

equipment_operator

Container operator.

X

13

equipment_status

"Import", "Transhipment"

 

14

equipment_supplier

 Container owner.

X

15

equipment_type

ISO type of container (e.g. 45G1)

or "Container" or "CN"

 

16

full_empty_indicator

"Full" or "Empty"

 

17

greenlight_value

Value & color of the Green Light. See the Green Light table below for all possible combinations and their meaning.

18

greenlight_color

19

identification_type

"nxtentityid", "eori", "tin", "apcs" or "duns"

 

20

iso_timestamp

ISO 8601 timestamp (in UTC)

e.g. 2022-01-23T10:36:39.2040693Z

 

21

nxtport_public_reference_id

GUID generated by the NxtPort platform to identify the notification. Is equal to the publicReferenceId returned in the synchronous response of your original request.

 

22

port_locode

UN/Locode of the operational port. For now, this is always Antwerp BEANR.

 

23

provided_identification_code

Identification code you provided in the original request.

 

24

provided_nxtentityid

NxtEntityId (or NxtPort ID) you provided in the original request.

 

25

release_order_reference

Reference provided by the Shipping Agent to identify the Commercial Release

X

26

terminal_code

NxtPort standard terminal code (“0” + quay number e.g. "01700").

 

27

unique_release_identification

Identifier provided by the submitting Shipping Agent. Is used together with the equipment number and bl number(s) to uniquely identify a Release Right.

 

28

vessel_callsign

Self-explanatory.

X

29

vessel_name

Self-explanatory.

X

30

voyage_number

Self-explanatory.

X

31

your_external_reference_id

The External Reference Id submitted as request header in the original request.

X

32

your_nxtentityid

NxtEntityId (or NxtPort ID) of your company, i.e. the company which has received the notification.

 

33

your_reason_for_action

Free text provided by the party which triggered the event.

X

Green Light table

In this table you can find all combinations of the Green Light name, value & color and their meaning.

Green Light

“greenLightName”

“greenLightValue”

“greenLightColor”

Explanation

1

Commercial Release

CommercialRelease

OK

GREEN

Container has been commercially released.

2

Commercial Release

CommercialRelease

NOK

RED

Container has been commercially blocked.

3

Commercial Release

CommercialRelease

UNKNOWN

GRAY

No commercial release information received yet.

4

Commercial Release

CommercialRelease

BLOCKED

RED

Container has been commercially blocked.

5

Commercial Release

CommercialRelease

EXPIRED

RED

Commercial release has expired:

  • expiration date set by shipping agent

  • when no expiration date set: 60 calendar days after release date

6

Terminal Discharge

TerminalOperation

UNKNOWN

GRAY

No information on discharge status yet received.

7

Terminal Discharge

TerminalOperation

LOADED

RED

Container is still on board of vessel.

8

Terminal Discharge

TerminalOperation

DISCHARGED

GREEN

Container has been discharged from vessel (import).

9

Terminal Discharge

TerminalOperation

LOADCANCELED

GRAY

Terminal operator has canceled previous load message.

10

Terminal Discharge

TerminalOperation

DISCHARGECANCELED

GRAY

Terminal operator has canceled previous discharge message.

11

Terminal Discharge

TerminalOperation

GATEIN

GREEN

Container has arrived on terminal (transhipment).

12

Terminal Release

TerminalReady

UKNOWN

GRAY

No information on release status yet received.

13

Terminal Release

TerminalReady

SELECTEDFORSCAN

YELLOW

Container has been selected for scan by Terminal Operator. Scanning procedure must be followed.

14

Terminal Release

TerminalReady

BLOCKED

RED

Container has been blocked on terminal by Terminal Operator.

15

Terminal Release

TerminalReady

RELEASED

GREEN

Container has been released on terminal by Terminal Operator.

16

Terminal Release

TerminalReady

ARCHIVED

RED

Release Right has been archived, meaning:

  • Container has received a gate out

  • 10 calendar days have passed since commercial release has expired

17

Customs Light

Customs

NOTRELEASED

RED

No release information received yet.

18

Customs Light

Customs

SELECTEDFORSCAN

YELLOW

Container has been selected for scanning by competent customs authority. Scanning procedure must be followed.

19

Customs Light

Customs

RELEASED

GREEN

Container has been released by competent customs authority.

20

Customs Light

Customs

TRANSHIPMENT

YELLOW

Container can be released under transhipment

21

Customs Light

Customs

PORTEQUALISATION

YELLOW

Container can be released under port equalisation

22

Customs Light

Customs

DOCUMENTARYCONTROL

RED

Container is subject to documentary control

23

Customs Progress

CustomsProgress

UNKNOWN

GRAY

No information received from customs

24

Customs Progress

CustomsProgress

PARTIALLYCLEARED

GREEN/YELLOW

At least 1 item of at least 1 BL is fully cleared (LightColor under discussion)

25

Gate Operation

GateOperation

UNKNOWN

GRAY

Container has not left the terminal yet according to Terminal Operator.

26

Gate Operation

GateOperation

GATEOUTRECEIVED

GREEN

Container has left the terminal according to Terminal Operator.

27

Gate Operation

GateOperation

GATEOUTCANCELED

GRAY

Terminal operator has canceled previous gate out message.

28

Gate Operation

GateOperation

GATEINCANCELED

GRAY

Terminal operator has canceled previous gate in message.

29

Pick up

PickupLight

UNKNOWN

GRAY

No Pick up Right has been generated yet for the container.

30

Pick up

PickupLight

ASSIGNED

GREEN

Pick up Right has been generated, i.e. a driver has been assigned.

31

Pick up

PickupLight

REVOKED

RED

The assignment of a driver has been revoked, awaiting new assignment.

Related pages

Need any further assistance?

Raise a support ticket on the NxtPort Support Portal