Documentation

Certified Pick-up uses asynchronous notifications. This tutorial describes which notifications are sent, where they are sent and how they are triggered.

Notification

Restricted access

This information is only available for registered users. Please login with your NxtPort account. 


Register new account
Login

Introduction

This document describes the different notifications that can be received by the Certified Pick-up API. 

Assumptions

How to read this document

This document lists the different notifications that are sent within the solution. It covers 

  • The type of notification
  • The trigger when this notification is sent
  • The link to the notification itself

The content of the notifications can be found on the specific pages and is linked. If you would find any missing links, please create a service ticket which would allow us to update the information accordingly.

Notification example

{
  "assetId": "00000000-0000-0001-0000-000000000037",
  "body": {
    "carrier": {
      "nxtEntityId": "NXT20000037754",
      "name": "NXTPORT CVBA",
      "eori": null,
      "tin": "BE0429672881"
    },
    "terminalCode": "0524",
    "equipmentNumber": "TTTT1234567",
    "billOfLadingNumbers": [
      "BLTTTT1234567"
    ],
    "releaseIdentification": "ReleaseID1",
    "greenLightName": "CommercialRelease",
    "originalValue": null,
    "newValue": "OK"
  },
  "errors": [],
  "event": "ReleaseLightChanged",
  "externalReferenceId": null,
  "id": "TTTT1234567",
  "publicReferenceId": "87314c3a-d342-4ce4-aba9-56a7b8ca7abc",
  "receiverId": "NXT20000037754",
  "senderId": null,
  "timestamp": "2020-12-30T09:24:05.6991364Z",
  "type": "ReleaseLight",
  "warnings": []
}

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 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 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 GUID GUID If provided by you when sending us a request, this value will be included in here (if applicable)
externalReferenceId String String Your own reference, as provided in the request header (optional). Will be empty in case the notification was triggered by another party.
senderId String APCS code The APCS code 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 APCS code This should always be your APCS code as you are the receiver of this message.
type Enumeration
  • releaseRight
  • releaseLight
  • pickUp
  • terminalEvent
  • preAnnouncement

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 stamp The timestamp when the notification was created by the Certified Pick up platform
errors Array Free text list of descriptive errors and warnings in the form of USECASE_ERROR|WARNING_SPECIFIC_DESCRIPTION
warnings Array Free text list of descriptive errors and warnings in the form of USECASE_ERROR|WARNING_SPECIFIC_DESCRIPTION             

Release Light notifications

Event

Occurance

Sent To

Messsage

Commercial Release created

Event
ReleaseLightChanged

When a COREOR or SubmitReleaseLight Release action is successfully processed via Ingestion or Commercial Release was created via UI

  • Ship Agent,
  • Terminal,
  • Owner,
  • Subscribed Parties
{
  "assetId": "00000000-0000-0001-0000-000000000037",
  "body": {
    "carrier": {
      "nxtEntityId": "NXT20000037754",
      "name": "NXTPORT CVBA",
      "eori": null,
      "tin": "BE0429672881"
    },
    "terminalCode": "0524",
    "equipmentNumber": "TTTT1234567",
    "billOfLadingNumbers": [
      "BLTTTT1234567"
    ],
    "releaseIdentification": "ReleaseID1",
    "greenLightName": "CommercialRelease",
    "originalValue": null,
    "newValue": "OK"
  },
  "errors": [],
  "event": "ReleaseLightChanged",
  "externalReferenceId": null,
  "id": "TTTT1234567",
  "publicReferenceId": "87314c3a-d342-4ce4-aba9-56a7b8ca7abc",
  "receiverId": "NXT20000037754",
  "senderId": null,
  "timestamp": "2020-12-30T09:24:05.6991364Z",
  "type": "ReleaseLight",
  "warnings": []
}

Commercial Release blocked

Event
ReleaseLightChanged

When a UI ‘Commercial Block’ or SubmitReleaseLight Block action is succesfully processed

  • Ship Agent,
  • Terminal,
  • Owner,
  • Subscribed Parties
{
  "assetId": "00000000-0000-0001-0000-000000000037",
  "body": {
    "carrier": {
      "nxtEntityId": "NXT20000037754",
      "name": "NXTPORT CVBA",
      "eori": null,
      "tin": "BE0429672881"
    },
    "terminalCode": "0524",
    "equipmentNumber": "TTTT1234567",
    "billOfLadingNumbers": [
      "BLTTTT1234567"
    ],
    "releaseIdentification": "ReleaseID1",
    "greenLightName": "CommercialRelease",
    "originalValue": "OK",
    "newValue": "NOK"
  },
  "errors": [],
  "event": "ReleaseLightChanged",
  "externalReferenceId": null,
  "id": "TTTT1234567",
  "publicReferenceId": "87314c3a-d342-4ce4-aba9-56a7b8ca7abc",
  "receiverId": "NXT20000037754",
  "senderId": null,
  "timestamp": "2020-12-30T09:24:05.6991364Z",
  "type": "ReleaseLight",
  "warnings": []
}

Commercial Release deleted

Event
ReleaseLightChanged

When a UI ‘Commercial Delete’ or SubmitReleaseLight Delete action is succesfully processed

  • Ship Agent,
  • Terminal,
  • Owner,
  • Subscribed Parties
{
  "assetId": "00000000-0000-0001-0000-000000000037",
  "body": {
    "carrier": {
      "nxtEntityId": "NXT20000037754",
      "name": "NXTPORT CVBA",
      "eori": null,
      "tin": "BE0429672881"
    },
    "terminalCode": "0524",
    "equipmentNumber": "TTTT1234567",
    "billOfLadingNumbers": [
      "BLTTTT1234567"
    ],
    "releaseIdentification": "ReleaseID1",
    "greenLightName": "CommercialRelease",
    "originalValue": "OK",
    "newValue": "UNKNOWN"
  },
  "errors": [],
  "event": "ReleaseLightChanged",
  "externalReferenceId": null,
  "id": "TTTT1234567",
  "publicReferenceId": "87314c3a-d342-4ce4-aba9-56a7b8ca7abc",
  "receiverId": "NXT20000037754",
  "senderId": null,
  "timestamp": "2020-12-30T09:24:05.6991364Z",
  "type": "ReleaseLight",
  "warnings": []
}

Terminal “Release”

Event
ReleaseLightChanged

When a UI or API ‘Terminal Release' is succesfully processed

  • Ship Agent,
  • Terminal,
  • Owner,
  • Subscribed Parties
{
  "assetId": "00000000-0000-0001-0000-000000000037",
  "body": {
    "carrier": {
      "nxtEntityId": "NXT20000051292",
      "name": "MSC Belgium SA",
      "eori": null,
      "tin": "BE0464255361"
    },
    "terminalCode": "1700",
    "equipmentNumber": "TTTT1234567",
    "billOfLadingNumbers": [
      "BOL001",
      "BOL002"
    ],
    "releaseIdentification": "updateEquipment",
    "greenLightName": "TerminalReady",
    "originalValue": "UNKNOWN",
    "newValue": "RELEASED"
  },
  "errors": [],
  "event": "ReleaseLightChanged",
  "externalReferenceId": null,
  "id": "TTTT1234567",
  "publicReferenceId": "f37062c2-c616-4068-8638-02ab075f36c4",
  "receiverId": "NXT20000051292",
  "senderId": null,
  "timestamp": "2021-01-04T11:03:04.0618663Z",
  "type": "ReleaseLight",
  "warnings": []
}

 

Terminal “Block“

Event
ReleaseLightChanged

When a UI or API ‘Terminal Block' is succesfully processed

  • Ship Agent,
  • Terminal,
  • Owner,
  • Subscribed Parties
{
  "assetId": "00000000-0000-0001-0000-000000000037",
  "body": {
    "carrier": {
      "nxtEntityId": "NXT20000051292",
      "name": "MSC Belgium SA",
      "eori": null,
      "tin": "BE0464255361"
    },
    "terminalCode": "1700",
    "equipmentNumber": "TTTT1234567",
    "billOfLadingNumbers": [
      "BOL001",
      "BOL002"
    ],
    "releaseIdentification": "updateEquipment",
    "greenLightName": "TerminalReady",
     "originalValue": "RELEASED",
     "newValue": "BLOCKED"
  },
  "errors": [],
  "event": "ReleaseLightChanged",
  "externalReferenceId": null,
  "id": "TTTT1234567",
  "publicReferenceId": "f37062c2-c616-4068-8638-02ab075f36c4",
  "receiverId": "NXT20000051292",
  "senderId": null,
  "timestamp": "2021-01-04T11:03:04.0618663Z",
  "type": "ReleaseLight",
  "warnings": []
}

Terminal(Operation) “Discharge”

Possible values:

  • UNKNOWN
  • DISCHARGED
  • DISCHARGECANCELED
  • LOADED
  • LOADCANCELED

Event
ReleaseLightChanged

When a Terminal Discharge requested via Ingestion was succesfully processed

  • Ship Agent,
  • Terminal,
  • Owner,
  • Subscribed Parties
{
  "assetId": "00000000-0000-0001-0000-000000000037",
  "body": {
    "carrier": {
      "nxtEntityId": "NXT20000051292",
      "name": "MSC Belgium SA",
      "eori": null,
      "tin": "BE0464255361"
    },
    "terminalCode": "1700",
    "equipmentNumber": "TTTT1234567",
    "billOfLadingNumbers": [
      "BOL001",
      "BOL002"
    ],
    "releaseIdentification": "updateEquipment",
    "greenLightName": "TerminalOperation",
    "originalValue": "Unkown",
    "newValue": "SELECTEDFORSCAN"
  },
  "errors": [],
  "event": "ReleaseLightChanged",
  "externalReferenceId": null,
  "id": "TTTT1234567",
  "publicReferenceId": "f37062c2-c616-4068-8638-02ab075f36c4",
  "receiverId": "NXT20000051292",
  "senderId": null,
  "timestamp": "2021-01-04T11:03:04.0618663Z",
  "type": "ReleaseLight",
  "warnings": []
}

GateOut Received

Event
ReleaseLightChanged

When a valid GateOut request is received and the release right is subsequently archived

  • Ship Agent,
  • Terminal,
  • Owner,
  • Subscribed Parties
{
  "assetId": "00000000-0000-0001-0000-000000000037",
  "body": {
    "carrier": {
      "nxtEntityId": "NXT20000051292",
      "name": "MSC Belgium SA",
      "eori": null,
      "tin": "BE0464255361"
    },
    "terminalCode": "01700",
    "equipmentNumber": "TTTT1234567",
    "billOfLadingNumbers": [
      "BOL001",
      "BOL002"
    ],
    "releaseIdentification": "Container_is_property_of_arne",
    "greenLightName": "GateOperation",
    "originalValue": "UNKNOWN",
    "newValue": "GATEOUTRECEIVED"
  },
  "errors": [],
  "event": "ReleaseLightChanged",
  "externalReferenceId": null,
  "id": "TTTT1234567",
  "publicReferenceId": "2fcdb045-1d08-4a9c-be97-b1e337f9fd59",
  "receiverId": "NXT20000050787",
  "senderId": null,
  "timestamp": "2021-01-06T20:02:48.9938871Z",
  "type": "ReleaseLight",
  "warnings": []
}

Missing parameters

No Commercial Release action processed due to:missing parameters

Event
NotValidated

When mandatory properties such as equipmentNumber, Bill Of Lading, PortLocode are missing or invalid; a list of all missing/invalid properties is returned as a notification

Sender

{
  "assetId": "00000000-0000-0001-0000-000000000037",
  "body": "'Equipment Number' must not be empty.
\n'Bill Of Lading Numbers'
must not be empty.\n'Port Lo Code' must not be empty.\n'Port Lo Code' must be equal to 'BEANR'.", "errors": [], "event": "NotValidated", "externalReferenceId": null, "id": "Unknown", "publicReferenceId": "f3b70af0-258a-4c63-a10e-ee3f84a25d19", "receiverId": "NXT20000051292", "senderId": null, "timestamp": "2020-12-23T11:42:27.2848743Z", "type": "ReleaseLight", "warnings": [] }

Invalid Terminal Code

No Commercial Release action processed due to: invalid terminalCode

Event
NotValidated

When a provided terminalCode in the SubmitReleaseLight request could not be matched with an existing AKA record or NxtPort entity.

Sender

{
  "assetId": "00000000-0000-0001-0000-000000000037",
  "body": "PublicReferenceId: 6ca82989-935e-4008-9e6d-ef716981399a => SubmitReleaseLightActionCommand 
does not have a valid terminal code XXXXX for port BEANR. No NxtEntityId found.", "errors": [], "event": "NotValidated", "externalReferenceId": null, "id": "TTTT1234567", "publicReferenceId": "6ca82989-935e-4008-9e6d-ef716981399a", "receiverId": "NXT20000051292", "senderId": null, "timestamp": "2020-12-29T08:27:07.5015829Z", "type": "ReleaseLight", "warnings": [] }

 

No match found for identifiers

No Commercial Release action (different from Release) processed due to: no matching release right found for provided identifiers

Event
NotValidated

When a SubmitReleaseLight action (except for the Release action) fails due to no matching release right reference found based on the EquipmentNumber, One or more bill of ladings & releaseIdentification

Sender

{
  "assetId": "00000000-0000-0001-0000-000000000037",
  "body": "No releaseRightReference found for equipment number DEV_V1.14_WO",
  "errors": [],
  "event": "NotValidated",
  "externalReferenceId": null,
  "id": "TTTT1234567",
  "publicReferenceId": "98476c8d-0c1b-4612-82cd-64829d4c111b",
  "receiverId": "NXT20000051292",
  "senderId": null,
  "timestamp": "2021-01-04T12:07:09.8026272Z",
  "type": "ReleaseLight",
  "warnings": []
}

No state change

No Commercial Release/Terminal Release/… action processed due to: the current state of the release right is identical to the new provided state

Event
NotValidated

When a Terminal/Commercial/… Light is received but the value is identical to the existing value for this light.

  • Ship Agent,
  • Terminal,
  • Owner,
  • Subscribed Parties
{
  "assetId": "00000000-0000-0001-0000-000000000037",
  "body": "No change detected for Light 'TerminalReady' - Value: RELEASED",
  "errors": [],
  "event": "NotValidated",
  "externalReferenceId": null,
  "id": "TTTT1234567",
  "publicReferenceId": "fcb478a4-894f-419c-ae46-00929a9a2e4d",
  "receiverId": "NXT20000051292",
  "senderId": null,
  "timestamp": "2021-01-04T13:14:23.2930754Z",
  "type": "ReleaseLight",
  "warnings": []
}

 

 Customs "Release"

Event
CustomsLightChanged

 When a Customs Release action is successfully processed via Ingestion
  •  Ship Agent,
  • Terminal,
    Owner,
  • Subscribed Parties
{
  "assetId": "00000000-0000-0001-0000-000000000037",
  "body": {
    "carrier": {
      "nxtEntityId": "NXT2100005446",
      "name": "Automation Shipping Agent 1",
      "eori": "btw53698752",
      "tin": "BE0000001"
    },
    "terminalCode": "0100",
    "equipmentNumber": "BEANRCN2021053191549",
    "billOfLadingNumbers": [
      "8991010755"
    ],
    "releaseIdentification": "rid*BEANRCN2021053191549",
    "greenLightName": "Customs",
    "originalValue": "NotReleased",
    "newValue": "Released"
  },
  "errors": [],
  "event": "ReleaseLightChanged",
  "externalReferenceId": null,
  "id": "BEANRCN2021053191549",
  "publicReferenceId": "2b38c1cd-8ba5-469b-84b3-1d0a36035a57",
  "receiverId": "NXT2100005446",
  "senderId": null,
  "timestamp": "2021-05-31T07:16:31.9010585Z",
  "type": "ReleaseLight",
  "warnings": []
}

 





 

Release Right notifications

Event

Occurance

Sent To

Message

Release Right Transferred

Event
Transferred

A SubmitReleaseRight Transfer request was successfully processed

Release From / Release to

{
  "assetId": "00000000-0000-0001-0000-000000000037",
  "body": {
    "sender": {
      "nxtEntityId": "NXT20000051292",
      "name": "MSC",
      "eori": "",
      "tin": "BE0464255361"
    },
    "carrier": {
      "nxtEntityId": "NXT20000051292",
      "name": "MSC",
      "eori": "",
      "tin": "BE0464255361"
    },
    "releaseTo": {
      "nxtEntityId": "NXT20000050989",
      "name": "Katoen Natie ",
      "eori": "",
      "tin": "BE0404778426"
    },
    "releaseFrom": {
      "nxtEntityId": "NXT20000051292",
      "name": "MSC",
      "eori": "",
      "tin": "BE0464255361"
    },
    "releaseIdentification": "string",
    "equipmentNumber": "test1234",
    "equipmentType": "",
    "portLoCode": "BEANR",
    "terminalCode": "01700",
    "actionType": "Transfer",
    "reasonForAction": null,
    "billOfLadingNumbers": [
      "BOL001",
      "BOL002"
    ],
    "releaseDatetimeUtc": "2020-12-18T14:33:42.8719897Z",
    "expirationDatetimeUtc": "2022-05-27T08:16:01.642Z"
  },
  "errors": [],
  "event": "Transferred",
  "externalReferenceId": null,
  "id": "test1234",
  "publicReferenceId": "936678dc-c366-4785-be4a-32d39139be5e",
  "receiverId": "NXT20000051292",
  "senderId": null,
  "timestamp": "2021-01-04T15:28:35.9434964Z",
  "type": "ReleaseRight",
  "warnings": []
}

 

Release Right Revoked

Event
RevokedByPreviousParty

A SubmitReleaseRight Revoke was succesfully processed, revoking the pending release right and returning the ownership to the previous party

Release From / Release to

{
  "assetId": "00000000-0000-0001-0000-000000000037",
  "body": {
    "sender": {
      "nxtEntityId": "NXT20000051292",
      "name": "MSC",
      "eori": "",
      "tin": "BE0464255361"
    },
    "carrier": {
      "nxtEntityId": "NXT20000051292",
      "name": "MSC",
      "eori": "",
      "tin": "BE0464255361"
    },
    "releaseTo": {
      "nxtEntityId": "NXT20000050989",
      "name": "Katoen Natie ",
      "eori": "",
      "tin": "BE0404778426"
    },
    "releaseFrom": {
      "nxtEntityId": "NXT20000051292",
      "name": "MSC",
      "eori": "",
      "tin": "BE0464255361"
    },
    "releaseIdentification": "string",
    "equipmentNumber": "test1234",
    "equipmentType": "",
    "portLoCode": "BEANR",
    "terminalCode": "01700",
    "actionType": "Revoke",
    "reasonForAction": null,
    "billOfLadingNumbers": [
      "BOL001",
      "BOL002"
    ],
    "releaseDatetimeUtc": "2021-01-04T15:28:35.725305Z",
    "expirationDatetimeUtc": "2022-05-27T08:16:01.642Z"
  },
  "errors": [],
  "event": "RevokedByPreviousParty",
  "externalReferenceId": null,
  "id": "test1234",
  "publicReferenceId": "7957d0a4-b2ab-40f2-bfd7-f80dfa88bbdf",
  "receiverId": "NXT20000051292",
  "senderId": null,
  "timestamp": "2021-01-04T16:14:48.0367377Z",
  "type": "ReleaseRight",
  "warnings": []
}

 

Release Right Accepted

Event
AcceptedByNextParty

A SubmitReleaseRight Accept was succesfully processed, accepting the pending release right and transferring the ownership to the releaseTo party

Release From / Release to

{
  "assetId": "00000000-0000-0001-0000-000000000037",
  "body": {
    "sender": {
      "nxtEntityId": "NXT20000051292",
      "name": "MSC",
      "eori": "",
      "tin": "BE0464255361"
    },
    "carrier": {
      "nxtEntityId": "NXT20000050989",
      "name": "Katoen Natie ",
      "eori": "",
      "tin": "BE0404778426"
    },
    "releaseTo": {
      "nxtEntityId": "NXT20000050989",
      "name": "Katoen Natie ",
      "eori": "",
      "tin": "BE0404778426"
    },
    "releaseFrom": {
      "nxtEntityId": "NXT20000051292",
      "name": "MSC",
      "eori": "",
      "tin": "BE0464255361"
    },
    "releaseIdentification": "string",
   "equipmentNumber": "test1234",
    "equipmentType": "",
    "portLoCode": "BEANR",
    "terminalCode": "01700",
    "actionType": "Accept",
    "reasonForAction": null,
    "billOfLadingNumbers": [
      "BOL001",
      "BOL002"
    ],
    "releaseDatetimeUtc": "2021-01-04T16:19:38.4720593Z",
    "expirationDatetimeUtc": "2022-05-27T08:16:01.642Z"
  },
  "errors": [],
  "event": "AcceptedByNextParty",
  "externalReferenceId": null,
  "id": "test1234",
  "publicReferenceId": "f003cbac-b6e5-4091-9f75-eee02a4b5c52",
  "receiverId": "NXT20000050989",
  "senderId": null,
  "timestamp": "2021-01-04T16:20:17.3856965Z",
  "type": "ReleaseRight",
  "warnings": []
}

 

Release Right Declined

Event
DeclinedByNextParty

A SubmitReleaseRight Decline was succesfully processed, declining the pending release right and returning the ownership to the previous party

Release From / Release to

{
  "assetId": "00000000-0000-0001-0000-000000000037",
  "body": {
    "sender": {
      "nxtEntityId": "NXT20000051292",
      "name": "MSC",
      "eori": "",
      "tin": "BE0464255361"
    },
    "carrier": {
      "nxtEntityId": "NXT20000050989",
      "name": "Katoen Natie ",
      "eori": "",
      "tin": "BE0404778426"
    },
    "releaseTo": {
      "nxtEntityId": "NXT20000050989",
      "name": "Katoen Natie ",
      "eori": "",
      "tin": "BE0404778426"
    },
    "releaseFrom": {
      "nxtEntityId": "NXT20000051292",
      "name": "MSC",
      "eori": "",
      "tin": "BE0464255361"
    },
   "releaseIdentification": "string",
   "equipmentNumber": "test1234",
    "equipmentType": "",
    "portLoCode": "BEANR",
    "terminalCode": "01700",
    "actionType": "Decline",
    "reasonForAction": null,
    "billOfLadingNumbers": [
      "BOL001",
      "BOL002"
    ],
    "releaseDatetimeUtc": "2021-01-04T16:25:00.2049701Z",
    "expirationDatetimeUtc": "2022-05-27T08:16:01.642Z"
  },
  "errors": [],
  "event": "DeclinedByNextParty",
  "externalReferenceId": null,
  "id": "test1234",
  "publicReferenceId": "d0f57aa8-7f56-4731-86e7-97c4ac2e3996",
  "receiverId": "NXT20000050989",
  "senderId": null,
  "timestamp": "2021-01-04T16:25:15.1097306Z",
  "type": "ReleaseRight",
  "warnings": []
}

 

No change in owner

No Release Right Transfer due to: releaseTo is equal to current owner

Event
NotValidated

When a SubmitReleaseRight Transfer action is perfomed with ReleaseTo equal to current owner of release right

Release From 

{
  "assetId": "00000000-0000-0001-0000-000000000037",
  "body": "It is not possible to transfer TCLU1036476 to the current owner",
  "errors": [],
  "event": "NotValidated",
  "externalReferenceId": null,
  "id": "TCLU1036476",
  "publicReferenceId": "f7f13626-b1d5-40ed-a3c4-5cfffb852d57",
  "receiverId": "NXT20000051292",
  "senderId": null,
  "timestamp": "2021-01-04T09:44:34.8243447Z",
  "type": "ReleaseRight",
  "warnings": []
}

 

No matching entity found

No Release Right Transfer/Accept/Decline due to: no matching NxtPort Entity found for provided parameters or mismatch in provided identity

Event
NotValidated

When a SubmitReleaseRightAction with a non-existing identification is performed or when the sender’s identity is different from the current owner (during transfer,revoke) or next owner (during accept, decline)

Sender

{
  "assetId": "00000000-0000-0001-0000-000000000037",
  "body": "Unable to perform SubmitReleaseRight action 'Accept' on TCLU1036476 due to invalid identification",
  "errors": [],
  "event": "NotValidated",
  "externalReferenceId": null,
  "id": "TCLU1036476",
  "publicReferenceId": "f7f13626-b1d5-40ed-a3c4-5cfffb852d57",
  "receiverId": "NXT20000051292",
  "senderId": null,
  "timestamp": "2021-01-04T09:44:34.8243447Z",
  "type": "ReleaseRight",
  "warnings": []
}

No matching release right

No Release Right Transfer/Accept/Decline due to: no matching release right found for provided parameters

Event
NotValidated

When a SubmitReleaseRight action with a non-existing EquipmentNumber / BillOfLadingNumber(s) / ReleaseIdentification combination is performed.

Sender

{
  "assetId": "00000000-0000-0001-0000-000000000037",
  "body": "Could not find release right for unique key TCLU1036476, BOL0001 BOL0002, ReleaseIdentifcation01,
  "errors": [],
  "event": "NotValidated",
  "externalReferenceId": null,
  "id": "TCLU1036476",
  "publicReferenceId": "f7f13626-b1d5-40ed-a3c4-5cfffb852d57",
  "receiverId": "NXT20000051292",
  "senderId": null,
  "timestamp": "2021-01-04T09:44:34.8243447Z",
  "type": "ReleaseRight",
  "warnings": []
}

Release right not pending

No Release Right Revoke due to: release right not in state ‘Pending’

Event
NotValidated

When a SubmitReleaseRight revoke is performed on on a releaseright that is not ‘pending’ (awaiting accept or decline) but instead is f.e. active

Sender

{
  "assetId": "00000000-0000-0001-0000-000000000037",
  "body": ""Unable to perform SubmitReleaseRight action 'Revoke' on TCLU1036476 because Release right is not 'Pending' but 'Accepted'",
  "errors": [],
  "event": "NotValidated",
  "externalReferenceId": null,
  "id": "TCLU1036476",
  "publicReferenceId": "f7f13626-b1d5-40ed-a3c4-5cfffb852d57",
  "receiverId": "NXT20000051292",
  "senderId": null,
  "timestamp": "2021-01-04T09:44:34.8243447Z",
  "type": "ReleaseRight",
  "warnings": []
}

Get Release Rights List

When a valid set of query parameters for retrieving a list of release rights is provided

Sender

{
  "assetId": "00000000-0000-0001-0000-000000000037",
  "body": {
    "page": 1,
    "pageSize": 25,
    "totalRows": 36,
    "pendingReleaseCount": 0,
    "dateStart": null,
    "dateEnd": null,
    "status": "Active",
    "billOfLadingNumberFilter": null,
    "shippingAgentNameFilter": null,
    "shippingAgentTinFilter": null,
    "currentStakeholderNameFilter": null,
    "currentStakeholderTinFilter": null,
    "releaseRightStatusFilter": 0,
    "result": [
      {
        "equipmentNumber": "releaseStatus",
        "releaseIdentification": "releaseStatus",
        "expirationDateTimeUtc": "2022-05-27T08:16:01.642Z",
        "operationalStatus": 0,
        "originatorNxtEntityId": "NXT20000051292",
        "originatorName": "MSC",
        "releaseDateTimeUtc": "2020-05-09T13:16:01.642Z",
        "terminalNxtEntityId": "NXT20000050787",
        "terminalName": "MPET",
        "terminalCode": "1700",
        "portLoCode": null,
        "startDate": "2020-12-21T12:56:08.4610874Z",
        "releaseFromName": null,
        "releaseFromNxtEntityId": null,
        "releaseFromVatNumber": null,
        "releaseToName": "MSC",
        "releaseToNxtEntityId": "NXT20000051292",
        "releaseToVatNumber": null,
        "dataBrokerName": null,
        "releaseOrderReference": "",
        "equipmentType": "CN",
        "pickUpReleaseRightStatus": 0,
        "releaseRightStatus": 3,
        "releaseLightStatus": 1,
        "billOfLadingNumbers": [
          "BOL001",
          "BOL002"
        ],
        "releaseRightActions": [
          {
            "label": "Transfer",
            "isEnabled": true
          },
          {
            "label": "Pick-Up",
            "isEnabled": true
          },
          {
            "label": "Generate Pre-Announcement Code",
            "isEnabled": true
          }
        ],
        "commercialReleaseActions": []
      }, ....
 

Get Release Right Detail

When a valid identifier for a release right is provided

Sender

{
  "assetId": "00000000-0000-0001-0000-000000000037",
  "body": {
    "equipmentNumber": "TTTT1234567",
    "releaseIdentification": "ReleaseID1",
    "billOfLadingNumbers": [
      "BOL001"
    ],
    "releaseOrderReference": "TTTT1234567",
    "terminalName": "MPET",
    "terminalCode": "01700",
    "portLoCode": "BEANR",
    "lights": [
      {
        "greenLightName": "CommercialRelease",
        "greenLightValue": "OK",
        "color": 1,
        "label": "Commercial Release",
        "isEnabled": true,
        "isVisible": true
      },
      {
        "greenLightName": "TerminalReady",
        "greenLightValue": "RELEASED",
        "color": 1,
        "label": "Terminal Ready",
        "isEnabled": true,
        "isVisible": true
      },
      {
        "greenLightName": "TerminalOperation",
        "greenLightValue": "UNKNOWN",
        "color": 4,
        "label": "Terminal Operation",
        "isEnabled": false,
        "isVisible": true
      },
      {
        "greenLightName": "CCRM",
        "greenLightValue": "UNKNOWN",
        "color": 4,
        "label": "Customs Release",
        "isEnabled": false,
        "isVisible": true
      },
      {
        "greenLightName": "NGPS",
        "greenLightValue": "UNKNOWN",
        "color": 4,
        "label": "Customs Status",
        "isEnabled": false,
        "isVisible": true
      },
      {
        "greenLightName": "GateOperation",
        "greenLightValue": "UNKNOWN",
        "color": 4,
        "label": "Gate Operation",
        "isEnabled": false,
        "isVisible": true
      },
      {
        "greenLightName": "PickupLight",
        "greenLightValue": "UNKNOWN",
        "color": 4,
        "label": "Pick-up Light",
        "isEnabled": true,
        "isVisible": true
      }
    ],
    "releaseDateTimeUtc": "2020-12-19T00:00:00Z",
    "expirationDateTimeUtc": "2020-12-20T00:00:00Z",
    "shippingAgentName": "MSC",
    "publicReferenceId": "498ea4e5-6b32-4020-8254-66695d03c194",
    "externalReferenceId": null
  },
  "errors": [],
  "event": "GetReleaseDetail",
  "externalReferenceId": null,
  "id": "Unknown",
  "publicReferenceId": "498ea4e5-6b32-4020-8254-66695d03c194",
  "receiverId": "NXT20000051292",
  "senderId": null,
  "timestamp": "2021-01-04T09:01:09.4563365Z",
  "type": "ReleaseRight",
  "warnings": []
}

 





 

Pickup notifications

Event

Occurance

Sent To

Message

Pickup Right assigned succesfully

Event
ReleaseRightChanged

When a valid SubmitPickup request is sent via API or UI (independent of whether the container is already available for pickup). This steps always precedes the possible next step of send the pickup right to the blackbox

Owner/Ship Agent/Subscribed Parties/Terminal

{
  "assetId": "00000000-0000-0001-0000-000000000037",
  "body": {
    "carrier": {
      "nxtEntityId": "NXT20000051292",
      "name": "MSC Belgium SA",
      "eori": null,
      "tin": "BE0464255361"
    },
    "terminalCode": "1700",
    "equipmentNumber": "BIDU4974260",
    "billOfLadingNumbers": [
      "SF02024823"
    ],
    "releaseIdentification": "dfedee09-86ad-4151-8708-484c38300a26",
    "greenLightName": "PickupLight",
    "originalValue": "UNKNOWN",
    "newValue": "ASSIGNED"
  },
  "errors": [],
  "event": "ReleaseLightChanged",
  "externalReferenceId": null,
  "id": "BIDU4974260",
  "publicReferenceId": "999d6bc2-71c2-43a8-835a-c645075f4dcd",
  "receiverId": "NXT20000050787",
  "senderId": null,
  "timestamp": "2021-01-05T10:39:14.7630524Z",
  "type": "ReleaseLight",
  "warnings": []
}

 

Terminal code not found

No Pickup Right Assigned due to: provided terminalCode does not match existing terminal for release right

Event
NotValidated

When a SubmitPickup request contains a terminalCode that is mapped to a different terminal NxtEntity then the terminal that is registered for the release right

Sender

{
  "assetId": "00000000-0000-0001-0000-000000000037",
  "body": "Terminal codes do not match for container BIDU4974260 and bill of lading SF02024823.",
  "errors": [],
  "event": "NotValidated",
  "externalReferenceId": null,
  "id": "BIDU4974260",
  "publicReferenceId": "0131841e-0f24-4eda-bc65-8d1f254a5a0d",
  "receiverId": "NXT20000051292",
  "senderId": null,
  "timestamp": "2021-01-05T10:36:39.2040693Z",
  "type": "PickUp",
  "warnings": []
}

Release right not active 

No Pickup Right Assigned due to: release right not active for an owner

Event
NotValidated

When a SubmitPickup request is performed via API for a release right that is currently in state ‘pending’ (waiting for accept, decline or revoke)

Sender

{
  "assetId": "00000000-0000-0001-0000-000000000037",
  "body": "Unable to perform SubmitPickupRight action on BIDU4974260 due to invalid release right state : Pending",
  "errors": [],
  "event": "NotValidated",
  "externalReferenceId": null,
  "id": "BIDU4974260",
  "publicReferenceId": "0131841e-0f24-4eda-bc65-8d1f254a5a0d",
  "receiverId": "NXT20000051292",
  "senderId": null,
  "timestamp": "2021-01-05T10:36:39.2040693Z",
  "type": "PickUp",
  "warnings": []
}

No matching active pickup right

No Pickup Right Revoked/Updated: no matching active Pickup Right found

Event
NotValidated

When a SubmitPickup request with actionType Revoke/Update is performed via API for a release right that is currently has no active PickupRight assigned

Sender

{
  "assetId": "00000000-0000-0001-0000-000000000037",
  "body": "Unable to revoke/update the existing Pickup Right, no matching active Pickup Right was found",
  "errors": [],
  "event": "NotValidated",
  "externalReferenceId": null,
  "id": "BIDU4974260",
  "publicReferenceId": "0131841e-0f24-4eda-bc65-8d1f254a5a0d",
  "receiverId": "NXT20000051292",
  "senderId": null,
  "timestamp": "2021-01-05T10:36:39.2040693Z",
  "type": "PickUp",
  "warnings": []
}

 


 
Register your company