Skip to main content
Skip table of contents

Notifications for Terminal Operators

This page will guide you through the notifications you - as a Terminal Operator - might receive in Certified Pick up (CPu). We will guide you through the different types of notifications and what to do with them.

For Terminal Operators, there are two types of CPu notifications:

  1. Validation responses: asynchronous responses sent to your notification channel after you have sent a validation request to the CPu API.

  2. Release Light events: events which relate to the Release Lights of the container (Terminal release, Customs release, Commercial release - released, blocked etc.).

For each type there is an example for display purposes. Click the expand to see the full notification.

The notification schemes also contain CPu variables (between double curly braces {{}}) which are different for each notification you will receive. An overview & explanation of these CPu variables can be found on this page CPu variables overview .

Implementation of the notifications also requires you to have read Getting Started with the API integration !

Important: you need to have set up a notification channel for your company in order to receive and process these notifications. See Setting up notification channels if you have not done so already.

Notifications - generic fields

Every notification that is sent by NxtPort will be built up with a generic part, allowing integrators to identify the asset, sender, error or warning messages and a Use case or type specific body.

Field Name

Type

Allowed values

Field Description

assetId

string

Contains the name or ID of the asset

For CPu, the assetId (NxtPort identification number) is used and contains the value 
00000000-0000-0001-0000-000000000037

id

string

The unique ID linked to the notification

For CPu, the container number is included in this field.

PublicReferenceId

guid

 

Automatically generated GUID from NxtPort. This is a unique ID throughout our platform. In case of questions, please provide this ID, allowing us to clearly retrieve the corresponding information. 

externalReferenceId

string

 

Your own reference, as provided in the request header (optional). Will be null in case the notification was triggered by another party.

senderId

string

NxtPort ID

The NxtPort ID of the owner that generated the notification. If a 3rd party triggered the event, this information will still be the owner of the original source that will be listed here.

receiverId

string

NxtPort ID

This should always be your NxtPort ID as you are the receiver of this message.

type

enumeration

  • releaseRight

  • releaseLight

  • pickUp

  • terminalEvent

Depending on the notification, one of these values will be used.

Within the NxtPort Console, you can use these type to filter out notifications to multiple channels. 

event

enumeration

Multiple values allowed 

Values will define the body of the notification and is explained further on in this document. 

body

N/A

N/A

Contains the event specific body related to this notification. This body is included in the details of the notifications and described later on in this document. 

timestamp

DateTime

UTC datetime

The timestamp when the notification was created by the Certified Pick-up platform. This will always be in UTC ISO 8601 format.

errors

Array

free text

These arrays are not used in CPu notifications. The error message can be found in the body of the notification.

warnings

Array

free text

These arrays are not used in CPu notifications. The warning message can be found in the body of the notification.

Notifications list

Responses

As stated previously, CPu is an asynchronous process (with some exceptions), meaning that when data is sent to the API, NxtPort will first receive and ‘store’ the data and then in a separate process will process the action in a CPu context. This means however, that not all errors or issues can be reported in a synchronous API response and that you will need to integrate the notifications you receive to make sure all data you provide is processed correctly.

Response notifications are asynchronous responses sent to your notification channel after you have sent a request tot the CPu API. These notifications indicate an error and are characterized by the "event": "NotValidated" field in the JSON body.

There is a problem with the action you performed for a Commercial Release. The error message is included in the "body" field, all possible messages are listed below, including the mitigation steps.

Notification

Explanation

How to mitigate?

Notification Body

Multiple releases

If multiple identical ACTIVE release rights are detected in CPu when processing a message (for example Terminal Discharge), these messages will not be linked and feedback will be sent via notifications to the relevant entity sending the message. Identifiers used for detecting a “double” release right depend on the message that is being processed. In case of Terminal Discharge this is Equipment Number, Terminal Code and Stay Number.

Check with Ship Agent that should delete the double releases.

CODE 
{
  "assetId": "00000000-0000-0001-0000-000000000037",
  "body": "Could not apply to single release right. Please provide keys that uniquely match the correct release right.",
  "errors": [],
  "event": "NotValidated",
  "externalReferenceId": "{{external_reference_id}}",
  "id": "{{equipment_number}}",
  "publicReferenceId": "{{nxtport_public_reference_id}}",
  "receiverId": "{{your_nxtport_id}}",
  "senderId": {{sender_nxtport_id}},
  "timestamp": "{{ISO_timestamp}}",
  "type": "ReleaseRight",
  "warnings": []
}

Release Light events

Event notifications are notifications sent to your notification channel when an event occurs on a Release Right for which you are a stakeholder.

Example of a notification

Commercial release created
JSON 
{
    "assetId": "00000000-0000-0001-0000-000000000037",
    "body": {
        "carrier": {
            "nxtEntityId": "NXT210000274362",
            "name": "Shipping Agent",
            "eori": "btw53698888",
            "tin": "BE1234567898",
            "apcs": "ZA0000",
            "duns": null,
            "externalId": null
        },
        "terminalCode": "0100",
        "portLoCode": "BEANR",
        "equipmentNumber": "HBMU2699709",
        "billOfLadingNumbers": [
            "BOL2022112885212"
        ],
        "releaseIdentification": "SARI2022112885212",
        "greenLightName": "CommercialRelease",
        "originalValue": null,
        "newValue": "OK",
        "meansOfTransport": null,
        "releaseId": "64b0bc69-c4e3-435d-8f30-b074350d87bc"
    },
    "errors": [],
    "event": "ReleaseLightChanged",
    "externalReferenceId": "ERI+CommercialRelease+772",
    "id": "HBMU2699709",
    "publicReferenceId": "65daa575-966a-4619-8c55-0bf51ba3032b",
    "receiverId": "NXT22125864695",
    "senderId": null,
    "timestamp": "2022-11-22T08:22:09.6647756Z",
    "type": "ReleaseLight",
    "warnings": []
}

Event

Explanation

Notification Body

Commercial Release created

A new Commercial Release was created within CPu by the Shipping Agent (via API call, COREOR message or CPu UI). Your terminal was indicated as discharge terminal.

The Commercial Release Light switches to GREEN.

JSON 
{
    "assetId": "00000000-0000-0001-0000-000000000037",
    "body": {
        "carrier": {
            "nxtEntityId": "NXT210000274362",
            "name": "Shipping Agent",
            "eori": "btw53698888",
            "tin": "BE1234567898",
            "apcs": "ZA0000",
            "duns": null,
            "externalId": null
        },
        "terminalCode": "0100",
        "portLoCode": "BEANR",
        "equipmentNumber": "HBMU2699709",
        "billOfLadingNumbers": [
            "BOL2022112885212"
        ],
        "releaseIdentification": "SARI2022112885212",
        "greenLightName": "CommercialRelease",
        "originalValue": "UNKNOWN",
        "newValue": "OK",
        "meansOfTransport": null,
        "releaseId": "64b0bc69-c4e3-435d-8f30-b074350d87bc"
    },
    "errors": [],
    "event": "ReleaseLightChanged",
    "externalReferenceId": "ERI+CommercialRelease+772",
    "id": "HBMU2699709",
    "publicReferenceId": "65daa575-966a-4619-8c55-0bf51ba3032b",
    "receiverId": "NXT22125864695",
    "senderId": null,
    "timestamp": "2022-11-22T08:22:09.6647756Z",
    "type": "ReleaseLight",
    "warnings": []
}

Commercial Release updated

An existing Commercial Release was updated (e.g. terminal, release date) by the submitting Shipping Agent.

You will need to make a Get Release Detail call to retrieve the updated details for the Release Right.

JSON 
{
    "assetId": "00000000-0000-0001-0000-000000000037",
    "body": {
        "sender": {
            "nxtEntityId": "{{sender_identification_code_nxtentityid}}",
            "name": "{{sender_name}}",
            "eori": "{{sender_identification_code_eori}}",
            "tin": "{{sender_identification_code_tin}}",
            "apcs": null,
            "duns": "{{sender_identification_code_duns}}"
            "externalId": "{{sender_identification_code_externalId}}"
        },
        "carrier": {
            "nxtEntityId": "{{carrier_identification_code_nxtentityid}}",
            "name": "{{carrier_name}}",
            "eori": "{{carrier_identification_code_eori}}",
            "tin": "{{carrier_identification_code_tin}}",
            "apcs": null,
            "duns": "{{carrier_identification_code_duns}}",
            "externalId": "{{carrier_identification_code_externalId}}"
        },
        "releaseIdentification": "{{unique_release_identification}}",
        "releaseOrderReference": "SAupdate454upd",
        "equipmentNumber": "{{equipment_number}}",
        "billOfLadingNumbers": [
            "BOL2022128101749"
        ],
        "releaseId": "{{release_uuid}}"
        "portLoCode": "BEANR",
        "terminalCode": "{{terminal_code}}",
        "reason": "{{reason_provided_by_carrier}}"
        "actionType": "Update",
        "releaseDatetimeUtc": "{{ISO_timestamp}}",
        "expirationDatetimeUtc": "{{ISO_timestamp}}"
    },
    "errors": [],
    "event": "Update",
    "externalReferenceId": "{{external_reference_id}}",
    "id": "{{equipment_number}}",
    "publicReferenceId": "{{nxtport_public_reference_id}}",
    "receiverId": "{{your_nxtport_id}}",
    "senderId": null,
    "timestamp": "{{ISO_timestamp}}",
    "type": "ReleaseLight",
    "warnings": []
}

Commercial Release deleted

An existing Commercial Release was deleted by the submitting Shipping Agent.

CODE 
{
    "assetId": "00000000-0000-0001-0000-000000000037",
    "body": {
        "sender": {
            "nxtEntityId": "{{sender_identification_code_nxtentityid}}",
            "name": "{{sender_name}}",
            "eori": "{{sender_identification_code_eori}}",
            "tin": "{{sender_identification_code_tin}}",
            "apcs": null,
            "duns": "{{sender_identification_code_duns}}"
            "externalId": "{{sender_identification_code_externalId}}"
        },
        "carrier": {
            "nxtEntityId": "{{carrier_identification_code_nxtentityid}}",
            "name": "{{carrier_name}}",
            "eori": "{{carrier_identification_code_eori}}",
            "tin": "{{carrier_identification_code_tin}}",
            "apcs": null,
            "duns": "{{carrier_identification_code_duns}}",
            "externalId": "{{carrier_identification_code_externalId}}"
        },
        "releaseIdentification": "{{unique_release_identification}}",
        "releaseOrderReference": "SAupdate454upd",
        "equipmentNumber": "{{equipment_number}}",
        "billOfLadingNumbers": [
            "BOL2022128101749"
        ],
        "releaseId": "{{release_uuid}}"
        "portLoCode": "BEANR",
        "terminalCode": "{{terminal_code}}",
        "reason": {{reason_provided_by_carrier}}
        "actionType": "Delete",
        "releaseDatetimeUtc": "{{ISO_timestamp}}",
        "expirationDatetimeUtc": "{{ISO_timestamp}}"
    },
    "errors": [],
    "event": "Delete",
    "externalReferenceId": "{{external_reference_id}}",
    "id": "{{equipment_number}}",
    "publicReferenceId": "{{nxtport_public_reference_id}}",
    "receiverId": "{{your_nxtport_id}}",
    "senderId": null,
    "timestamp": "{{ISO_timestamp}}",
    "type": "ReleaseLight",
    "warnings": []
}

Commercial Release blocked

A Commercial Release was blocked by the submitting Shipping Agent. Your terminal was indicated as discharge terminal.

The Commercial Release Light switches to RED.

JSON 
{
    "assetId": "00000000-0000-0001-0000-000000000037",
    "body": {
        "carrier": {
            "nxtEntityId": "{{carrier_identification_code_nxtentityid}}",
            "name": "{{carrier_name}}",
            "eori": "{{carrier_identification_code_eori}}",
            "tin": "{{carrier_identification_code_tin}}",
            "apcs": "{{carrier_identification_code_apcs}}",
            "duns": "{{carrier_identification_code_duns}}",
            "externalId": "{{carrier_identification_code_externalId}}"
        },
        "terminalCode": "{{terminal_code}}",
        "equipmentNumber": "{{equipment_number}}",
        "billOfLadingNumbers": [
            "{{bl_number}}",
            "{{bl_number}}"
        ],
        "releaseIdentification": "{{unique_release_identification}}",
        "greenLightName": "CommercialRelease",
        "originalValue": "OK",
        "newValue": "BLOCKED",
        "meansOfTransport": null,
        "releaseId": "64b0bc69-c4e3-435d-8f30-b074350d87bc"
    },
    "errors": [],
    "event": "ReleaseLightChanged",
    "externalReferenceId": "{{your_external_reference_id}}",
    "id": "{{equipment_number}}",
    "publicReferenceId": "{{nxtport_public_reference_id}}",
    "receiverId": "{{your_nxtport_id}}",
    "senderId": null,
    "timestamp": "{{ISO_Timestamp}}",
    "type": "ReleaseLight",
    "warnings": []
}

Commercial Release unblocked

A Commercial Release was unblocked by the submitting Shipping Agent. Your terminal was indicated as discharge terminal.

The Commercial Release Light switches to GREEN.

JSON 
{
    "assetId": "00000000-0000-0001-0000-000000000037",
    "body": {
        "carrier": {
            "nxtEntityId": "{{carrier_identification_code_nxtentityid}}",
            "name": "{{carrier_name}}",
            "eori": "{{carrier_identification_code_eori}}",
            "tin": "{{carrier_identification_code_tin}}",
            "apcs": "{{carrier_identification_code_apcs}}",
            "duns": "{{carrier_identification_code_duns}}",
            "externalId": "{{carrier_identification_code_externalId}}"
        },
        "terminalCode": "{{terminal_code}}",
        "equipmentNumber": "{{equipment_number}}",
        "billOfLadingNumbers": [
            "{{bl_number}}",
            "{{bl_number}}"
        ],
        "releaseIdentification": "{{unique_release_identification}}",
        "greenLightName": "CommercialRelease",
        "originalValue": "BLOCKED",
        "newValue": "OK",
        "meansOfTransport": null,
        "releaseId": "64b0bc69-c4e3-435d-8f30-b074350d87bc"
    },
    "errors": [],
    "event": "ReleaseLightChanged",
    "externalReferenceId": "{{your_external_reference_id}}",
    "id": "{{equipment_number}}",
    "publicReferenceId": "{{nxtport_public_reference_id}}",
    "receiverId": "{{your_nxtport_id}}",
    "senderId": null,
    "timestamp": "{{ISO_Timestamp}}",
    "type": "ReleaseLight",
    "warnings": []
}

Terminal Release submitted

You have successfully released a container on your terminal.

The Terminal Release Light switches to GREEN.

JSON 
{
    "assetId": "00000000-0000-0001-0000-000000000037",
    "body": {
        "carrier": {
            "nxtEntityId": "{{carrier_identification_code_nxtentityid}}",
            "name": "{{carrier_name}}",
            "eori": "{{carrier_identification_code_eori}}",
            "tin": "{{carrier_identification_code_tin}}",
            "apcs": "{{carrier_identification_code_apcs}}",
            "duns": "{{carrier_identification_code_duns}}",
            "externalId": "{{carrier_identification_code_externalId}}"
        },
        "terminalCode": "{{terminal_code}}",
        "equipmentNumber": "{{equipment_number}}",
        "billOfLadingNumbers": [
            "{{bl_number}}",
            "{{bl_number}}"
        ],
        "releaseIdentification": "updateEquipment",
        "greenLightName": "TerminalReady",
        "originalValue": "UNKNOWN", // can be "BLOCKED" as well
        "newValue": "RELEASED",
        "meansOfTransport": null,
        "releaseId": "64b0bc69-c4e3-435d-8f30-b074350d87bc"
    },
    "errors": [],
    "event": "ReleaseLightChanged",
    "externalReferenceId": null,
    "id": "{{equipment_number}}",
    "publicReferenceId": "{{nxtport_public_reference_id}}",
    "receiverId": "{{your_nxtport_id}}",
    "senderId": null,
    "timestamp": "{{ISO_Timestamp}}",
    "type": "ReleaseLight",
    "warnings": []
}

Terminal Release blocked

You have successfully blocked a container on your terminal.

The Terminal Release Light switches to RED.

JSON 
{
    "assetId": "00000000-0000-0001-0000-000000000037",
    "body": {
        "carrier": {
            "nxtEntityId": "{{carrier_identification_code_nxtentityid}}",
            "name": "{{carrier_name}}",
            "eori": "{{carrier_identification_code_eori}}",
            "tin": "{{carrier_identification_code_tin}}",
            "apcs": "{{carrier_identification_code_apcs}}",
            "duns": "{{carrier_identification_code_duns}}",
            "externalId": "{{carrier_identification_code_externalId}}"
        },
        "terminalCode": "{{terminal_code}}",
        "equipmentNumber": "{{equipment_number}}",
        "billOfLadingNumbers": [
            "{{bl_number}}",
            "{{bl_number}}"
        ],
        "releaseIdentification": "updateEquipment",
        "greenLightName": "TerminalReady",
        "originalValue": "RELEASED",
        "newValue": "BLOCKED",
        "meansOfTransport": null,
        "releaseId": "64b0bc69-c4e3-435d-8f30-b074350d87bc"
    },
    "errors": [],
    "event": "ReleaseLightChanged",
    "externalReferenceId": null,
    "id": "{{equipment_number}}",
    "publicReferenceId": "{{nxtport_public_reference_id}}",
    "receiverId": "{{your_nxtport_id}}",
    "senderId": null,
    "timestamp": "{{ISO_Timestamp}}",
    "type": "ReleaseLight",
    "warnings": []
}

Terminal Operation Discharge submitted

You have submitted a container discharge on your terminal (API call or COARRI DISCHARGE).

The Terminal Discharge Light switches to GREEN.

JSON 
{
    "assetId": "00000000-0000-0001-0000-000000000037",
    "body": {
        "carrier": {
            "nxtEntityId": "{{carrier_identification_code_nxtentityid}}",
            "name": "{{carrier_name}}",
            "eori": "{{carrier_identification_code_eori}}",
            "tin": "{{carrier_identification_code_tin}}",
            "apcs": "{{carrier_identification_code_apcs}}",
            "duns": "{{carrier_identification_code_duns}}",
            "externalId": "{{carrier_identification_code_externalId}}"
        },
        "terminalCode": "{{terminal_code}}",
        "equipmentNumber": "{{equipment_number}}",
        "billOfLadingNumbers": [
            "{{bl_number}}",
            "{{bl_number}}"
        ],
        "releaseIdentification": "{{unique_release_identification}}",
        "greenLightName": "TerminalOperation",
        "originalValue": "UNKNOWN",
        "newValue": "DISCHARGED",
        "meansOfTransport": null,
        "releaseId": "64b0bc69-c4e3-435d-8f30-b074350d87bc"
    },
    "errors": [],
    "event": "ReleaseLightChanged",
    "externalReferenceId": null,
    "id": "{{equipment_number}}",
    "publicReferenceId": "{{nxtport_public_reference_id}}",
    "receiverId": "{{your_nxtport_id}}",
    "senderId": null,
    "timestamp": "{{ISO_Timestamp}}",
    "type": "ReleaseLight",
    "warnings": []
}

Terminal Gate Out submitted

The container has left the terminal, this event is triggered by the Terminal Gate Out (API call, CODECO OUT or CODECO STRIP) message.

JSON 
{
    "assetId": "00000000-0000-0001-0000-000000000037",
    "body": {
        "carrier": {
            "nxtEntityId": "{{carrier_identification_code_nxtentityid}}",
            "name": "{{carrier_name}}",
            "eori": "{{carrier_identification_code_eori}}",
            "tin": "{{carrier_identification_code_tin}}",
            "apcs": "{{carrier_identification_code_apcs}}",
            "duns": "{{carrier_identification_code_duns}}",
            "externalId": "{{carrier_identification_code_externalId}}"
        },
        "terminalCode": "{{terminal_code}}",
        "equipmentNumber": "{{equipment_number}}",
        "billOfLadingNumbers": [
            "{{bl_number}}",
            "{{bl_number}}"
        ],
        "releaseIdentification": "{{unique_release_identification}}",
        "greenLightName": "GateOperation",
        "originalValue": "UNKNOWN",
        "newValue": "GATEOUTRECEIVED",
        "meansOfTransport": null,
        "releaseId": "64b0bc69-c4e3-435d-8f30-b074350d87bc"
    },
    "errors": [],
    "event": "ReleaseLightChanged",
    "externalReferenceId": null,
    "id": "{{equipment_number}}",
    "publicReferenceId": "{{nxtport_public_reference_id}}",
    "receiverId": "{{your_nxtport_id}}",
    "senderId": null,
    "timestamp": "{{ISO_Timestamp}}",
    "type": "ReleaseLight",
    "warnings": []
}

Customs Release submitted

The container has been released by the competent customs authority (CCRM message).

The Customs Release Light switches to GREEN.

JSON 
{
    "assetId": "00000000-0000-0001-0000-000000000037",
    "body": {
        "carrier": {
            "nxtEntityId": "{{carrier_identification_code_nxtentityid}}",
            "name": "{{carrier_name}}",
            "eori": "{{carrier_identification_code_eori}}",
            "tin": "{{carrier_identification_code_tin}}",
            "apcs": "{{carrier_identification_code_apcs}}",
            "duns": "{{carrier_identification_code_duns}}",
            "externalId": "{{carrier_identification_code_externalId}}"
        },
        "terminalCode": "{{terminal_code}}",
        "equipmentNumber": "{{equipment_number}}",
        "billOfLadingNumbers": [
            "{{bl_number}}",
            "{{bl_number}}"
        ],
        "releaseIdentification": "{{unique_release_identification}}",
        "greenLightName": "Customs",
        "originalValue": "NOTRELEASED", // can be "SELECTEDFORSCAN" as well
        "newValue": "RELEASED",
        "meansOfTransport": null,
        "releaseId": "64b0bc69-c4e3-435d-8f30-b074350d87bc"
    },
    "errors": [],
    "event": "ReleaseLightChanged",
    "externalReferenceId": null,
    "id": "{{equipment_number}}",
    "publicReferenceId": "{{nxtport_public_reference_id}}",
    "receiverId": "{{your_nxtport_id}}",
    "senderId": null,
    "timestamp": "{{ISO_Timestamp}}",
    "type": "ReleaseLight",
    "warnings": []
}

Customs Selected for Scan

The container has been selected for scanning by the competent customs authority (CCRM/NGPS message).

The Customs Release Light switches to YELLOW.

JSON 
{
    "assetId": "00000000-0000-0001-0000-000000000037",
    "body": {
        "carrier": {
            "nxtEntityId": "{{carrier_identification_code_nxtentityid}}",
            "name": "{{carrier_name}}",
            "eori": "{{carrier_identification_code_eori}}",
            "tin": "{{carrier_identification_code_tin}}",
            "apcs": "{{carrier_identification_code_apcs}}",
            "duns": "{{carrier_identification_code_duns}}",
            "externalId": "{{carrier_identification_code_externalId}}"
        },
        "terminalCode": "{{terminal_code}}",
        "equipmentNumber": "{{equipment_number}}",
        "billOfLadingNumbers": [
            "{{bl_number}}",
            "{{bl_number}}"
        ],
        "releaseIdentification": "{{unique_release_identification}}",
        "greenLightName": "Customs",
        "originalValue": "NOTRELEASED",
        "newValue": "SELECTEDFORSCAN",
        "meansOfTransport": null,
        "releaseId": "64b0bc69-c4e3-435d-8f30-b074350d87bc"
    },
    "errors": [],
    "event": "ReleaseLightChanged",
    "externalReferenceId": null,
    "id": "{{equipment_number}}",
    "publicReferenceId": "{{nxtport_public_reference_id}}",
    "receiverId": "{{your_nxtport_id}}",
    "senderId": null,
    "timestamp": "{{ISO_Timestamp}}",
    "type": "ReleaseLight",
    "warnings": []
}

Customs Transhipment

The container has been identified by the competent customs authority (CCRM message) as a Transhipment container.

The Customs Release Light switches to YELLOW.

CODE 
{
    "assetId": "00000000-0000-0001-0000-000000000037",
    "body": {
        "carrier": {
            "nxtEntityId": "{{carrier_identification_code_nxtentityid}}",
            "name": "{{carrier_name}}",
            "eori": "{{carrier_identification_code_eori}}",
            "tin": "{{carrier_identification_code_tin}}",
            "apcs": "{{carrier_identification_code_apcs}}",
            "duns": "{{carrier_identification_code_duns}}",
            "externalId": "{{carrier_identification_code_externalId}}"
        },
        "terminalCode": "{{terminal_code}}",
        "equipmentNumber": "{{equipment_number}}",
        "billOfLadingNumbers": [
            "{{bl_number}}",
            "{{bl_number}}"
        ],
        "releaseIdentification": "{{unique_release_identification}}",
        "greenLightName": "Customs",
        "originalValue": "NOTRELEASED",
        "newValue": "TRANSHIPMENT",
        "meansOfTransport": null,
        "releaseId": "64b0bc69-c4e3-435d-8f30-b074350d87bc"
    },
    "errors": [],
    "event": "ReleaseLightChanged",
    "externalReferenceId": null,
    "id": "{{equipment_number}}",
    "publicReferenceId": "{{nxtport_public_reference_id}}",
    "receiverId": "{{your_nxtport_id}}",
    "senderId": null,
    "timestamp": "{{ISO_Timestamp}}",
    "type": "ReleaseLight",
    "warnings": []
}

Customs Port Equalisation

There’s a gate-in message for this import container.

The Customs Release Light switches to YELLOW.

CODE 
{
    "assetId": "00000000-0000-0001-0000-000000000037",
    "body": {
        "carrier": {
            "nxtEntityId": "{{carrier_identification_code_nxtentityid}}",
            "name": "{{carrier_name}}",
            "eori": "{{carrier_identification_code_eori}}",
            "tin": "{{carrier_identification_code_tin}}",
            "apcs": "{{carrier_identification_code_apcs}}",
            "duns": "{{carrier_identification_code_duns}}",
            "externalId": "{{carrier_identification_code_externalId}}"
        },
        "terminalCode": "{{terminal_code}}",
        "equipmentNumber": "{{equipment_number}}",
        "billOfLadingNumbers": [
            "{{bl_number}}",
            "{{bl_number}}"
        ],
        "releaseIdentification": "{{unique_release_identification}}",
        "greenLightName": "Customs",
        "originalValue": "NOTRELEASED",
        "newValue": "PORTEQUALISATION",
        "meansOfTransport": null,
        "releaseId": "64b0bc69-c4e3-435d-8f30-b074350d87bc"
    },
    "errors": [],
    "event": "ReleaseLightChanged",
    "externalReferenceId": null,
    "id": "{{equipment_number}}",
    "publicReferenceId": "{{nxtport_public_reference_id}}",
    "receiverId": "{{your_nxtport_id}}",
    "senderId": null,
    "timestamp": "{{ISO_Timestamp}}",
    "type": "ReleaseLight",
    "warnings": []
}

Customs FAVV

The container has been identified by the competent customs authority as a FAVV container.

The Customs Release Light switches to YELLOW.

This information is subject to 1 day delay.

CODE 
{
    "assetId": "00000000-0000-0001-0000-000000000037",
    "body": {
        "carrier": {
            "nxtEntityId": "{{carrier_identification_code_nxtentityid}}",
            "name": "{{carrier_name}}",
            "eori": "{{carrier_identification_code_eori}}",
            "tin": "{{carrier_identification_code_tin}}",
            "apcs": "{{carrier_identification_code_apcs}}",
            "duns": "{{carrier_identification_code_duns}}",
            "externalId": "{{carrier_identification_code_externalId}}"
        },
        "terminalCode": "{{terminal_code}}",
        "equipmentNumber": "{{equipment_number}}",
        "billOfLadingNumbers": [
            "{{bl_number}}",
            "{{bl_number}}"
        ],
        "releaseIdentification": "{{unique_release_identification}}",
        "greenLightName": "Customs",
        "originalValue": "NOTRELEASED",
        "newValue": "FAVV",
        "meansOfTransport": null,
        "releaseId": "64b0bc69-c4e3-435d-8f30-b074350d87bc"
    },
    "errors": [],
    "event": "ReleaseLightChanged",
    "externalReferenceId": null,
    "id": "{{equipment_number}}",
    "publicReferenceId": "{{nxtport_public_reference_id}}",
    "receiverId": "{{your_nxtport_id}}",
    "senderId": null,
    "timestamp": "{{ISO_Timestamp}}",
    "type": "ReleaseLight",
    "warnings": []
}

Customs Documentary Control

The container’s documents are being investigated by the customs authority (PLDA message).

The Customs Release Light switches to RED.

This information is subject to 1 day delay.

CODE 
{
    "assetId": "00000000-0000-0001-0000-000000000037",
    "body": {
        "carrier": {
            "nxtEntityId": "{{carrier_identification_code_nxtentityid}}",
            "name": "{{carrier_name}}",
            "eori": "{{carrier_identification_code_eori}}",
            "tin": "{{carrier_identification_code_tin}}",
            "apcs": "{{carrier_identification_code_apcs}}",
            "duns": "{{carrier_identification_code_duns}}",
            "externalId": "{{carrier_identification_code_externalId}}"
        },
        "terminalCode": "{{terminal_code}}",
        "equipmentNumber": "{{equipment_number}}",
        "billOfLadingNumbers": [
            "{{bl_number}}",
            "{{bl_number}}"
        ],
        "releaseIdentification": "{{unique_release_identification}}",
        "greenLightName": "Customs",
        "originalValue": "NOTRELEASED",
        "newValue": "DOCUMENTARYCONTROL",
        "meansOfTransport": null,
        "releaseId": "64b0bc69-c4e3-435d-8f30-b074350d87bc"
    },
    "errors": [],
    "event": "ReleaseLightChanged",
    "externalReferenceId": null,
    "id": "{{equipment_number}}",
    "publicReferenceId": "{{nxtport_public_reference_id}}",
    "receiverId": "{{your_nxtport_id}}",
    "senderId": null,
    "timestamp": "{{ISO_Timestamp}}",
    "type": "ReleaseLight",
    "warnings": []
}

Customs Progress Partially Cleared

The container is partially cleared by the customs authority. At least 1 item for a bill of lading has been cleared by the customs authority.

The Customs Progress Light switches to YELLOW.

This information is subject to 1 day delay.

CODE 
{
    "assetId": "00000000-0000-0001-0000-000000000037",
    "body": {
        "carrier": {
            "nxtEntityId": "{{carrier_identification_code_nxtentityid}}",
            "name": "{{carrier_name}}",
            "eori": "{{carrier_identification_code_eori}}",
            "tin": "{{carrier_identification_code_tin}}",
            "apcs": "{{carrier_identification_code_apcs}}",
            "duns": "{{carrier_identification_code_duns}}",
            "externalId": "{{carrier_identification_code_externalId}}"
        },
        "terminalCode": "{{terminal_code}}",
        "equipmentNumber": "{{equipment_number}}",
        "billOfLadingNumbers": [
            "{{bl_number}}",
            "{{bl_number}}"
        ],
        "releaseIdentification": "{{unique_release_identification}}",
        "greenLightName": "CustomsProgress",
        "originalValue": "UNKNOWN",
        "newValue": "PARTIALLYCLEARED",
        "meansOfTransport": null,
        "releaseId": "64b0bc69-c4e3-435d-8f30-b074350d87bc"
    },
    "errors": [],
    "event": "ReleaseLightChanged",
    "externalReferenceId": null,
    "id": "{{equipment_number}}",
    "publicReferenceId": "{{nxtport_public_reference_id}}",
    "receiverId": "{{your_nxtport_id}}",
    "senderId": null,
    "timestamp": "{{ISO_Timestamp}}",
    "type": "ReleaseLight",
    "warnings": []
}

Customs Manual Overwrite

The container has been Released manually by the Ship Agent or Terminal Operator.

The Customs Release Light switches to GREEN.

JSON 
{
    "assetId": "00000000-0000-0001-0000-000000000037",
    "body": {
        "carrier": {
            "nxtEntityId": "{{carrier_identification_code_nxtentityid}}",
            "name": "{{carrier_name}}",
            "eori": "{{carrier_identification_code_eori}}",
            "tin": "{{carrier_identification_code_tin}}",
            "apcs": "{{carrier_identification_code_apcs}}",
            "duns": "{{carrier_identification_code_duns}}",
            "externalId": "{{carrier_identification_code_externalId}}"
        },
        "terminalCode": "{{terminal_code}}",
        "equipmentNumber": "{{equipment_number}}",
        "billOfLadingNumbers": [
            "{{bl_number}}",
            "{{bl_number}}"
        ],
        "releaseIdentification": "{{unique_release_identification}}",
        "greenLightName": "Customs",
        "originalValue": "NOTRELEASED",
        "newValue": "MANUALOVERWRITE"
    },
    "errors": [],
    "event": "ReleaseLightChanged",
    "externalReferenceId": null,
    "id": "{{equipment_number}}",
    "publicReferenceId": "{{nxtport_public_reference_id}}",
    "receiverId": "{{your_nxtport_id}}",
    "senderId": null,
    "timestamp": "{{ISO_Timestamp}}",
    "type": "ReleaseLight",
    "warnings": []
}

Pick up Right generated

A Pick up Right has been generated, meaning a driver, barge - or rail operator was assigned for pick up by the last Transport Operator holding the Release Right.

The Pick up Light switches to GREEN.

Transport Operator identity is available from release 3.4.0

JSON 
{
    "assetId": "00000000-0000-0001-0000-000000000037",
    "body": {
        "carrier": {
            "nxtEntityId": "{{carrier_identification_code_nxtentityid}}",
            "name": "{{carrier_name}}",
            "eori": "{{carrier_identification_code_eori}}",
            "tin": "{{carrier_identification_code_tin}}",
            "apcs": "{{carrier_identification_code_apcs}}",
            "duns": "{{carrier_identification_code_duns}}",
            "externalId": "{{carrier_identification_code_externalId}}"
        },
        "transportOperator": {
            "nxtEntityId": "{{transportOperator_identification_code_nxtentityid}}",
            "name": "{{transportOperator_name}}",
            "eori": "{{transportOperator_identification_code_eori}}",
            "tin": "{{transportOperator_identification_code_tin}}",
            "apcs": "{{transportOperator_identification_code_apcs}}",
            "duns": "{{transportOperator_identification_code_duns}}",
            "externalId": "{{transportOperator_identification_code_externalId}}"
        },
        "terminalCode": "{{terminal_code}}",
        "portLoCode": "{{port_lo_code}}"
        "equipmentNumber": "{{equipment_number}}",
        "billOfLadingNumbers": [
            "{{bl_number}}",
            "{{bl_number}}"
        ],
        "releaseIdentification": "{{unique_release_identification}}",
        "greenLightName": "PickupLight",
        "originalValue": "UNKNOWN",
        "newValue": "ASSIGNED",
        "meansOfTransport": {
          "oldMeansOfTransport": "{{oldMeansOfTransport}}",
          "newMeansOfTransport": "{{newMeansOfTransport}}"
        },
        "releaseId": "{{release_uuid}}"
    },
    "errors": [],
    "event": "ReleaseLightChanged",
    "externalReferenceId": null,
    "id": "{{equipment_number}}",
    "publicReferenceId": "{{nxtport_public_reference_id}}",
    "receiverId": "{{your_nxtport_id}}",
    "senderId": null,
    "timestamp": "{{ISO_Timestamp}}",
    "type": "ReleaseLight",
    "warnings": []
}

Pick up Right updated

A Pick up Right has been updated, meaning a new driver, barge - or rail operator was assigned for pick up by the last Transport Operator holding the Release Right.

The Pick up Light remains GREEN.

Transport Operator identity is available from release 3.5.0

CODE 
{
    "assetId": "00000000-0000-0001-0000-000000000037",
    "body": {
        "carrier": {
            "nxtEntityId": "{{carrier_identification_code_nxtentityid}}",
            "name": "{{carrier_name}}",
            "eori": "{{carrier_identification_code_eori}}",
            "tin": "{{carrier_identification_code_tin}}",
            "apcs": "{{carrier_identification_code_apcs}}",
            "duns": "{{carrier_identification_code_duns}}",
            "externalId": "{{carrier_identification_code_externalId}}"
        },
        "transportOperator": {
            "nxtEntityId": "{{transportOperator_identification_code_nxtentityid}}",
            "name": "{{transportOperator_name}}",
            "eori": "{{transportOperator_identification_code_eori}}",
            "tin": "{{transportOperator_identification_code_tin}}",
            "apcs": "{{transportOperator_identification_code_apcs}}",
            "duns": "{{transportOperator_identification_code_duns}}",
            "externalId": "{{transportOperator_identification_code_externalId}}"
        },
        "terminalCode": "{{terminal_code}}",
        "equipmentNumber": "{{equipment_number}}",
        "billOfLadingNumbers": [
            "{{bl_number}}",
            "{{bl_number}}"
        ],
        "releaseIdentification": "{{unique_release_identification}}",
        "greenLightName": "PickupLight",
        "originalValue": "ASSIGNED",
        "newValue": "ASSIGNED",
        "meansOfTransport": {
          "oldMeansOfTransport": "{{oldMeansOfTransport}}",
          "newMeansOfTransport": "{{newMeansOfTransport}}"
        },
        "releaseId": "{{release_uuid}}"
    },
    "errors": [],
    "event": "ReleaseLightChanged",
    "externalReferenceId": null,
    "id": "{{equipment_number}}",
    "publicReferenceId": "{{nxtport_public_reference_id}}",
    "receiverId": "{{your_nxtport_id}}",
    "senderId": null,
    "timestamp": "{{ISO_Timestamp}}",
    "type": "ReleaseLight",
    "warnings": []
}

Pick up Right revoked

A Pick up Right has been revoked, meaning the driver, barge - or rail operator was de-assigned by the last Transport Operator holding the Release Right.

The Pick up Light switches to RED.

CODE 
{
    "assetId": "00000000-0000-0001-0000-000000000037",
    "body": {
        "carrier": {
            "nxtEntityId": "{{carrier_identification_code_nxtentityid}}",
            "name": "{{carrier_name}}",
            "eori": "{{carrier_identification_code_eori}}",
            "tin": "{{carrier_identification_code_tin}}",
            "apcs": "{{carrier_identification_code_apcs}}",
            "duns": "{{carrier_identification_code_duns}}",
            "externalId": "{{carrier_identification_code_externalId}}"
        },
        "terminalCode": "{{terminal_code}}",
        "equipmentNumber": "{{equipment_number}}",
        "billOfLadingNumbers": [
            "{{bl_number}}",
            "{{bl_number}}"
        ],
        "releaseIdentification": "{{unique_release_identification}}",
        "greenLightName": "PickupLight",
        "originalValue": "ASSIGNED",
        "newValue": "REVOKED",
        "meansOfTransport": {
          "oldMeansOfTransport": "{{oldMeansOfTransport}}",
          "newMeansOfTransport": "{{newMeansOfTransport}}"
        },
        "releaseId": "{{release_uuid}}"
    },
    "errors": [],
    "event": "ReleaseLightChanged",
    "externalReferenceId": null,
    "id": "{{equipment_number}}",
    "publicReferenceId": "{{nxtport_public_reference_id}}",
    "receiverId": "{{your_nxtport_id}}",
    "senderId": null,
    "timestamp": "{{ISO_Timestamp}}",
    "type": "ReleaseLight",
    "warnings": []
}

You have reached the end of the page. Go back to the integration guidelines.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.

Contact Support Close