This page will guide you through the notifications you - as a Release Party - might receive in Certified Pick up (CPu). We will guide you through the different types of notifications and what to do with them.
For Release Parties, there are three types of CPu notifications:
Responses: asynchronous responses sent to your notification channel after you have sent a request tot the CPu API. These notifications indicate an error and require you to take action
Release Light events: events which relate to the Release Lights of the container (Terminal release, Customs release, Commercial release - released, blocked etc.)
Release Right events: events which happen to the Release Right (transferred to next party, accepted, declined, revoked)
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 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 an 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 on the Release Right. The error message is included in the "body" field, all possible messages are listed below, including the mitigation steps.
Example of a notification
Mismatch in Entity
{
"assetId": "00000000-0000-0001-0000-000000000037",
"body": "Unable to perform SubmitReleaseRight action Accept on CAIU1234567 due to invalid identification",
"errors": [],
"event": "NotValidated",
"externalReferenceId": null,
"id": "CAIU1234567",
"publicReferenceId": "8cb81019-80d1-4cc7-b15e-76b1a5b4c450",
"receiverId": "NXT22125864695",
"senderId": null,
"timestamp": "2022-11-22T08:53:05.5688854Z",
"type": "ReleaseRight",
"warnings": []
}
JSON
Notification received | Explanation | How to mitigate? | Notification body |
|---|
Mismatch in entity | No Release Right action <Transfer / Accept / Decline / Revoke> due to: mismatch in provided identity. When a Release Right action 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). | Verify if you are allowed to perform the required action on the Release Right. |
{
"assetId": "00000000-0000-0001-0000-000000000037",
"body": "Unable to perform SubmitReleaseRight action <see explanation> on {{equipment_number}} due to invalid identification",
"errors": [],
"event": "NotValidated",
"externalReferenceId": "{{external_reference_id}}",
"id": "{{equipment_number}}",
"publicReferenceId": "{{nxtport_public_reference_id}}",
"receiverId": "{{your_nxtport_id}}",
"senderId": null,
"timestamp": "{{ISO_Timestamp}}",
"type": "ReleaseRight",
"warnings": []
}
JSON
|
|---|
No matching entity found | No matching entity found. No Release Right Transfer / Accept / Decline due to: no matching NxtPort Entity found for provided parameters (NxtEntityId, APCS, DUNS, EORI or TIN). | Verify if the receiving company has been correctly registered for CPu (check their NxtPort ID or use the Company Registry call) |
{
"assetId": "00000000-0000-0001-0000-000000000037",
"body": "Couldn't find the entities based on the following parameters: IdentificationType: {{identification_type}} and IdentificationCode {{identification_code}}",
"errors": [],
"event": "NotValidated",
"externalReferenceId": "{{external_reference_id}}",
"id": "{{equipment_number}}",
"publicReferenceId": "{{nxtport_public_reference_id}}",
"receiverId": "{{your_nxtport_id}}",
"senderId": null,
"timestamp": "{{ISO_Timestamp}}",
"type": "ReleaseRight",
"warnings": []
}
JSON
|
|---|
No matching release right | No Release Right Transfer / Accept / Decline due to: no matching Release Right found for provided parameters. When a Release Right action with a non-existing Equipment Number / Bill of Lading Number(s) / Release Identification combination is performed. | Verify the provided identifiers (equipmentNumber, billOfLadingNumbers & releaseIdentification ) and try again. |
{
"assetId": "00000000-0000-0001-0000-000000000037",
"body": "Could not find release right for unique key {{equipment_number}}, {{bl_number}}, {{unique_release_identification}}",
"errors": [],
"event": "NotValidated",
"externalReferenceId": "{{external_reference_id}}",
"id": "{{equipment_number}}",
"publicReferenceId": "{{nxtport_public_reference_id}}",
"receiverId": "{{your_nxtport_id}}",
"senderId": null,
"timestamp": "{{ISO_Timestamp}}",
"type": "ReleaseRight",
"warnings": []
}
JSON
|
|---|
Release Right not pending | No Release Right Revoke due to: Release Right not in state ‘Pending’. When a Release Right Revoke is performed on on a Release Right that is not ‘pending’ (awaiting accept or decline) but instead is f.e. active. | Verify if the Release Right you wish to revoke has the Pending status (CPu UI or Get Release Detail call). |
{
"assetId": "00000000-0000-0001-0000-000000000037",
"body": ""Unable to perform SubmitReleaseRight action Revoke on {{equipment_number}} because Release right is not Pending but Accepted",
"errors": [],
"event": "NotValidated",
"externalReferenceId": "{{external_reference_id}}",
"id": "{{equipment_number}}",
"publicReferenceId": "{{nxtport_public_reference_id}}",
"receiverId": "{{your_nxtport_id}}",
"senderId": null,
"timestamp": "{{ISO_Timestamp}}",
"type": "ReleaseRight",
"warnings": []
}
JSON
|
|---|
Release Right transferred to current owner | When a Transfer Release Right action is performed with releaseTo equal to current owner of Release Right.
You will only receive this if you are the current owner of the Release Right.
| Make sure to provide the correct identifiers of the releaseTo party. |
{
"assetId": "00000000-0000-0001-0000-000000000037",
"body": "It is not possible to transfer {{equipment_number}} to the current owner",
"errors": [],
"event": "NotValidated",
"externalReferenceId": "{{external_reference_id}}",
"id": "{{equipment_number}}",
"publicReferenceId": "{{nxtport_public_reference_id}}",
"receiverId": "{{your_nxtport_id}}",
"senderId": null,
"timestamp": "{{ISO_Timestamp}}",
"type": "ReleaseRight",
"warnings": []
}
JSON
|
|---|
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
{
"assetId": "00000000-0000-0001-0000-000000000037",
"body": {
"carrier": {
"nxtEntityId": "NXT210000274362",
"name": "Shipping Agent",
"eori": "btw53698888",
"tin": "BE1234567898",
"apcs": "ZA0000",
"duns": null
},
"terminalCode": "0100",
"portLoCode": "BEANR",
"equipmentNumber": "HBMU2699709",
"billOfLadingNumbers": [
"BOL2022112885212"
],
"releaseIdentification": "SARI2022112885212",
"greenLightName": "CommercialRelease",
"originalValue": null,
"newValue": "OK"
},
"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": []
}
JSON
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) in which your company has been identified as First Release Party. The Commercial Release Light switches to GREEN. |
{
"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}}"
},
"terminalCode": "{{terminal_code}}",
"equipmentNumber": "{{equipment_number}}",
"billOfLadingNumbers": [
"{{bl_number}}",
"{{bl_number}}"
],
"releaseIdentification": "{{unique_release_identification}}",
"greenLightName": "CommercialRelease",
"originalValue": null,
"newValue": "OK"
},
"errors": [],
"event": "ReleaseLightChanged",
"externalReferenceId": "{{external_reference_id}}",
"id": "{{equipment_number}}",
"publicReferenceId": "{{nxtport_public_reference_id}}",
"receiverId": "{{your_nxtport_id}}",
"senderId": null,
"timestamp": "{{ISO_Timestamp}}",
"type": "ReleaseLight",
"warnings": []
}
JSON
|
|---|
Commercial Release blocked | A Commercial Release was blocked by the submitting Shipping Agent. The Commercial Release Light switches to RED. |
{
"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}}"
},
"terminalCode": "{{terminal_code}}",
"equipmentNumber": "{{equipment_number}}",
"billOfLadingNumbers": [
"{{bl_number}}",
"{{bl_number}}"
],
"releaseIdentification": "{{unique_release_identification}}",
"greenLightName": "CommercialRelease",
"originalValue": "OK",
"newValue": "NOK"
},
"errors": [],
"event": "ReleaseLightChanged",
"externalReferenceId": "{{external_reference_id}}",
"id": "{{equipment_number}}",
"publicReferenceId": "{{nxtport_public_reference_id}}",
"receiverId": "{{your_nxtport_id}}",
"senderId": null,
"timestamp": "{{ISO_Timestamp}}",
"type": "ReleaseLight",
"warnings": []
}
JSON
|
|---|
Commercial Release updated | A Commercial Release was updated by the submitting Shipping Agent. This notification serves as a heads-up. You will need to perform a Get Release Detail call to retrieve the updated release information. |
{
"assetId": "00000000-0000-0001-0000-000000000037",
"body": {
"sender": {
"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}}"
},
"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}}"
},
"releaseIdentification": "{{unique_release_identification}}",
"releaseOrderReference": "{{carrier_release_order_reference}}",
"equipmentNumber": "{{equipment_number}}",
"billOfLadingNumbers": [
"{{bl_number}}"
],
"portLoCode": "{{port_locode}}",
"terminalCode": "{{terminal_code}}",
"actionType": "Update",
"releaseDatetimeUtc": "{{ISO_Timestamp}}",
"expirationDatetimeUtc": "{{ISO_Timestamp}}"
},
"errors": [],
"event": "Update",
"externalReferenceId": "",
"id": "{{equipment_number}}",
"publicReferenceId": "{{nxtport_public_reference_id}}",
"receiverId": "{{your_nxtport_id}}",
"senderId": null,
"timestamp": "{{ISO_Timestamp}}",
"type": "ReleaseLight",
"warnings": []
}
JSON
|
|---|
Commercial Release deleted | A Commercial Release was deleted by the submitting Shipping Agent. The Release Right is no longer active in CPu. |
{
"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}}"
},
"terminalCode": "{{terminal_code}}",
"equipmentNumber": "{{equipment_number}}",
"billOfLadingNumbers": [
"{{bl_number}}",
"{{bl_number}}"
],
"releaseIdentification": "{{unique_release_identification}}",
"greenLightName": "CommercialRelease",
"originalValue": "OK",
"newValue": "UNKNOWN"
},
"errors": [],
"event": "ReleaseLightChanged",
"externalReferenceId": "{{external_reference_id}}",
"id": "{{equipment_number}}",
"publicReferenceId": "{{nxtport_public_reference_id}}",
"receiverId": "{{your_nxtport_id}}",
"senderId": null,
"timestamp": "{{ISO_Timestamp}}",
"type": "ReleaseLight",
"warnings": []
}
JSON
|
|---|
Release Right 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
Release Right transferred
{
"assetId": "00000000-0000-0001-0000-000000000037",
"body": {
"sender": {
"nxtEntityId": "NXT21055057655",
"name": "Release Party 1",
"eori": null,
"tin": "BE345678",
"apcs": "ZA0001",
"duns": null
},
"carrier": {
"nxtEntityId": "NXT210000274362",
"name": "Shipping Agent",
"eori": "btw53698888",
"tin": "BE1234567898",
"apcs": "ZA0000",
"duns": null
},
"releaseTo": {
"nxtEntityId": "NXT21000057840",
"name": "Transport Operator 1",
"eori": "BTW005611",
"tin": "BE567891",
"apcs": "ZA0002",
"duns": null
},
"releaseFrom": {
"nxtEntityId": "NXT21055057655",
"name": "Release Party 1",
"eori": null,
"tin": "BE345678",
"apcs": "ZA0001",
"duns": null
},
"equipmentNumber": "HBMU2699709",
"equipmentType": "45G1",
"portLoCode": "BEANR",
"terminalCode": "0100",
"actionType": "Transfer",
"reasonForAction": "Transfer to Transport Company",
"billOfLadingNumbers": [
"BOL2022112885212"
],
"releaseDatetimeUtc": "2022-11-28T08:52:12.928Z",
"expirationDatetimeUtc": null,
"releaseIdentification": "SARI2022112885212",
"emptyReturnReference": null,
"equipmentSupplier": null,
"equipmentStatus": null,
"fullEmptyIndicator": null,
"equipmentOperator": null,
"vesselName": null,
"vesselCallSign": null,
"voyageNumber": null
},
"errors": [],
"event": "Transferred",
"externalReferenceId": "ERI+transferReleaseRight+159",
"id": "HBMU2699709",
"publicReferenceId": "03c7c559-8f5f-47fb-b284-46096d1c45f6",
"receiverId": "NXT22125864695",
"senderId": null,
"timestamp": "2022-11-22T08:52:38.042174Z",
"type": "ReleaseRight",
"warnings": []
}
JSON
Event | Explanation | Notification Body |
|---|
Release Right Transferred | The Release Right was successfully transferred to the releaseTo party, awaiting their Accept / Decline.
You will only receive this notification if you are the releaseFrom or releaseTo party.
|
{
"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": "{{sender_identification_code_apcs}}",
"duns": "{{sender_identification_code_duns}}"
},
"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}}"
},
"releaseTo": {
"nxtEntityId": "{{releaseto_identification_code_nxtentityid}}",
"name": "{{releaseto_name}}",
"eori": "{{releaseto_identification_code_eori}}",
"tin": "{{releaseto_identification_code_tin}}",
"apcs": "{{releaseto_identification_code_apcs}}",
"duns": "{{releaseto_identification_code_duns}}"
},
"releaseFrom": {
"nxtEntityId": "{{releasefrom_identification_code_nxtentityid}}",
"name": "{{releasefrom_name}}",
"eori": "{{releasefrom_identification_code_eori}}",
"tin": "{{releasefrom_identification_code_tin}}",
"apcs": "{{releasefrom_identification_code_apcs}}",
"duns": "{{releasefrom_identification_code_duns}}"
},
"releaseIdentification": "{{unique_release_identification}}",
"equipmentNumber": "{{equipment_number}}",
"equipmentType": "{{equipment_type}}",
"portLoCode": "BEANR",
"terminalCode": "{{terminal_code}}",
"actionType": "Transfer",
"reasonForAction": "{{your_reason_for_action}}",
"billOfLadingNumbers": [
"{{bl_number}}",
"{{bl_number}}"
],
"releaseDatetimeUtc": "{{ISO_Timestamp}}",
"expirationDatetimeUtc": "{{ISO_Timestamp}}"
},
"errors": [],
"event": "Transferred",
"externalReferenceId": "{{external_reference_id}}",
"id": "{{equipment_number}}",
"publicReferenceId": "{{nxtport_public_reference_id}}",
"receiverId": "{{your_nxtport_id}}",
"senderId": null,
"timestamp": "{{ISO_Timestamp}}",
"type": "ReleaseRight",
"warnings": []
}
JSON
|
|---|
Release Right Revoked | The transferred (but not accepted by the releaseTo party yet) Release Right was revoked by the releaseFrom party, returning the ownership to the releaseFrom party.
You will only receive this notification if you are the releaseFrom or releaseTo party.
|
{
"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": "{{sender_identification_code_apcs}}",
"duns": "{{sender_identification_code_duns}}"
},
"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}}"
},
"releaseTo": {
"nxtEntityId": "{{releaseto_identification_code_nxtentityid}}",
"name": "{{releaseto_name}}",
"eori": "{{releaseto_identification_code_eori}}",
"tin": "{{releaseto_identification_code_tin}}",
"apcs": "{{releaseto_identification_code_apcs}}",
"duns": "{{releaseto_identification_code_duns}}"
},
"releaseFrom": {
"nxtEntityId": "{{releasefrom_identification_code_nxtentityid}}",
"name": "{{releasefrom_name}}",
"eori": "{{releasefrom_identification_code_eori}}",
"tin": "{{releasefrom_identification_code_tin}}",
"apcs": "{{releasefrom_identification_code_apcs}}",
"duns": "{{releasefrom_identification_code_duns}}"
},
"releaseIdentification": "{{unique_release_identification}}",
"equipmentNumber": "{{equipment_number}}",
"equipmentType": "{{equipment_type}}",
"portLoCode": "BEANR",
"terminalCode": "{{terminal_code}}",
"actionType": "Revoke",
"reasonForAction": "{{your_reason_for_action}}",
"billOfLadingNumbers": [
"{{bl_number}}",
"{{bl_number}}"
],
"releaseDatetimeUtc": "{{ISO_Timestamp}}",
"expirationDatetimeUtc": "{{ISO_Timestamp}}"
},
"errors": [],
"event": "RevokedByPreviousParty",
"externalReferenceId": "{{external_reference_id}}",
"id": "{{equipment_number}}",
"publicReferenceId": "{{nxtport_public_reference_id}}",
"receiverId": "{{your_nxtport_id}}",
"senderId": null,
"timestamp": "{{ISO_Timestamp}}",
"type": "ReleaseRight",
"warnings": []
}
JSON
|
|---|
Release Right Accepted | The transferred Release Right was accepted by the releaseTo party, transferring the ownership to the releaseTo party.
You will only receive this notification if you are the releaseFrom or releaseTo party.
|
{
"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": "{{sender_identification_code_apcs}}",
"duns": "{{sender_identification_code_duns}}"
},
"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}}"
},
"releaseTo": {
"nxtEntityId": "{{releaseto_identification_code_nxtentityid}}",
"name": "{{releaseto_name}}",
"eori": "{{releaseto_identification_code_eori}}",
"tin": "{{releaseto_identification_code_tin}}",
"apcs": "{{releaseto_identification_code_apcs}}",
"duns": "{{releaseto_identification_code_duns}}"
},
"releaseFrom": {
"nxtEntityId": "{{releasefrom_identification_code_nxtentityid}}",
"name": "{{releasefrom_name}}",
"eori": "{{releasefrom_identification_code_eori}}",
"tin": "{{releasefrom_identification_code_tin}}",
"apcs": "{{releasefrom_identification_code_apcs}}",
"duns": "{{releasefrom_identification_code_duns}}"
},
"releaseIdentification": "{{unique_release_identification}}",
"equipmentNumber": "{{equipment_number}}",
"equipmentType": "{{equipment_type}}",
"portLoCode": "BEANR",
"terminalCode": "{{terminal_code}}",
"actionType": "Accept",
"reasonForAction": "{{your_reason_for_action}}",
"billOfLadingNumbers": [
"{{bl_number}}",
"{{bl_number}}"
],
"releaseDatetimeUtc": "{{ISO_Timestamp}}",
"expirationDatetimeUtc": "{{ISO_Timestamp}}"
},
"errors": [],
"event": "AcceptedByNextParty",
"externalReferenceId": "{{external_reference_id}}",
"id": "{{equipment_number}}",
"publicReferenceId": "{{nxtport_public_reference_id}}",
"receiverId": "{{your_nxtport_id}}",
"senderId": null,
"timestamp": "{{ISO_Timestamp}}",
"type": "ReleaseRight",
"warnings": []
}
JSON
|
|---|
Release Right Declined | A Decline Release Right action was successfully processed, declining the pending release right and returning the ownership to the previous party.
You will only receive this notification if you are the releaseFrom or releaseTo party.
|
{
"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": "{{sender_identification_code_apcs}}",
"duns": "{{sender_identification_code_duns}}"
},
"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}}"
},
"releaseTo": {
"nxtEntityId": "{{releaseto_identification_code_nxtentityid}}",
"name": "{{releaseto_name}}",
"eori": "{{releaseto_identification_code_eori}}",
"tin": "{{releaseto_identification_code_tin}}",
"apcs": "{{releaseto_identification_code_apcs}}",
"duns": "{{releaseto_identification_code_duns}}"
},
"releaseFrom": {
"nxtEntityId": "{{releasefrom_identification_code_nxtentityid}}",
"name": "{{releasefrom_name}}",
"eori": "{{releasefrom_identification_code_eori}}",
"tin": "{{releasefrom_identification_code_tin}}",
"apcs": "{{releasefrom_identification_code_apcs}}",
"duns": "{{releasefrom_identification_code_duns}}"
},
"releaseIdentification": "{{unique_release_identification}}",
"equipmentNumber": "{{equipment_number}}",
"equipmentType": "{{equipment_type}}",
"portLoCode": "BEANR",
"terminalCode": "{{terminal_code}}",
"actionType": "Decline",
"reasonForAction": "{{your_reason_for_action}}",
"billOfLadingNumbers": [
"{{bl_number}}",
"{{bl_number}}"
],
"releaseDatetimeUtc": "{{ISO_Timestamp}}",
"expirationDatetimeUtc": "{{ISO_Timestamp}}"
},
"errors": [],
"event": "DeclinedByNextParty",
"externalReferenceId": "{{external_reference_id}}",
"id": "{{equipment_number}}",
"publicReferenceId": "{{nxtport_public_reference_id}}",
"receiverId": "{{your_nxtport_id}}",
"senderId": null,
"timestamp": "{{ISO_Timestamp}}",
"type": "ReleaseRight",
"warnings": []
}
JSON
|
|---|
