Certified Pick up uses two different environments. A UAT or testing environment (operational as of September 2020) and a Production environment (operational as of December 15th 2020). When reading this document, please use the relevant environment URL's and credentials. When you intend to use both environments, please remember that each of the environments will require each of the steps (signup, credentials, ...)
Certified Pick up uses an asynchronous notification mechanism using HTTP post end points/webhooks. This means GET or POST calls will not generate a response with a body other than a Public Reference ID. Any response will be sent to your configured HTTPS endpoint(s). For further information on how to setup your notification channels, please refer to the corresponding tutorial.
This document describes how stakeholders of type “Terminal” should integrate the Certified Pick up process within their applications.
When an import container is commercially released, a Ship’s Agent typically sends a PIN code to the Terminal and shares this code with the next party in the release chain (e.g. Forwarder, Transporter,…). This code, which is required to be granted access to the terminal and release the container, is distributed further in the supply chain until a party, which knows the PIN code, claims the container for pick up at the terminal.
By using the Certified Pick up platform, a Ship Agent will not create and distribute a PIN code to the Terminal, increasing the security of the release chain. Instead, the Ship Agent sends the commercial release information towards the Certified Pick up platform, which vouches for a secure transfer of the “Release Right” until it is assigned to an entitled transporter to pick up the container at the terminal. The code to release the container will be sent via a secured and audited communication channel towards the Terminal.
The Certified Pick up (CPu) process consists of multiple data elements and actions. Most of these will be provided through dedicated API’s. However, to facilitate the integration of CPu with existing processes, it is possible for Ship Agents and Terminals to communicate with existing message types to the CPu Backbone.
Read more about integrating with existing message types (Coarri & Codeco).
To ensure a secure container release at the terminal, three questions are vital: “Is it okay for the terminal that the container leaves the yard?” ,“Is it okay for the ship agent that a container leaves the terminal?” and “Which party is authorised to pick up the container?”.
Just like traffic lights indicate that you can cross a street, the Release Lights API is used to obtain/capture information about the “release status” of a container, i.e. can this container leave the terminal or not.
At this moment, two parties will need to give their permission concerning this departure, being the Terminal and the Ship Agent. Only these two parties will use the Release Lights API.
NxtPort is also integrating the Customs Release Light (CCRM). Until the direct link with Customs is functional, this light is included in the Terminal Release.
To know which party has the right to pick up a container at the terminal (assuming that both Terminal and Ship Agent have given their consent with the Release Lights API), a different API is used. When a commercial release has occurred, a “Release Right” is created and can be transferred from one party to another.
The Terminal provides crucial information that is required to release the container from the terminal: the Terminal Release. It covers
The most straightforward way to implement this, is by using the Release Lights API.
In addition, the Terminal will provide the information needed to “close” the release chain: the Gate-Out event.
The Gate-out information can be provided by sending CODECO-OUT messages to the NxtPort platform. Please contact support@nxtport.com to help you set up your ingestion channel.
Certified Pick-Up uses a separate API to ingest the Commercial Release information. Ship Agents therefore need to use two different endpoint hostnames when providing us the necessary information. Each of the API's described below will either mention {{HOST - Ingestion}} or {{HOST - CPU API}}.
In case of the Ingestion API, you will need a specified Channel that is setup for your organisation. Ship Agents that did not yet receive their dedicated Channel ID can create a support ticket on our helpdesk.
The question “Is it okay for the terminal that a container leaves the yard?” can be answered through the “Release Light” method.
PUT - {Host}/certified-pickup/v1/{port-locode}/containers/{equipment-number}/import/terminal-release
Swagger linkParameters
Headers
Body
{
"terminalCode": "string",
"actionType": "Release",
"releaseDateTimeUtc": "2020-09-17T09:35:25.189Z",
"equipmentNumber": "string",
"portLoCode": "string"
}
Field name
|
Type
|
Mandatory
|
Allowed value
|
Field Description
|
---|---|---|---|---|
equipmentNumber | String | Yes | Free text | Container number |
portLoCode | String | Yes | UNLocode | Use the UNLocode of the port. For Antwerp, this is BEANR |
terminalCode | String | Yes | Free text | The terminal where the container will be available for pickUp. Can be updated later on in the process. |
actionType | Enum | Yes | Release | You can only use the value Release when you wish to do a terminal release |
releaseDateTimeUtc | DateTimeUTC | Yes | Date Time | Date from which the Terminal release will be active |
When the 200 result is returned, the state of the container will be set to “Released” or “SelectedForScan”.
{
"publicReferenceId": "GUID",
"externalReferenceId": "string"
}
Notifications
A successful request will generate a notification of type Release-Light with action terminalRelease that will be sent to
To get the current state of a container, please refer to the "Get status of the release light" section of this document.
The Certified Pick up API uses an async mechanism that does not allow to return a full json body. To verify the information that was stored, you can process the notification that will be sent to your notification channel(s) or use the "Get status of the release light" request.
Something in your call wasn’t what we were expecting. Please:
The below error message will be sent to your notification channel(s)
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
}
This error indicates that you do not have the rights to perform the requested action. To overcome this, please make sure that you are:
The below error message will be sent to your notification channel(s)
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
}
PUT - {Host}/certified-pickup/v1/{port-locode}/containers/{equipment-number}/import/terminal-release
Swagger linkParameters
Headers
Body
{
"terminalCode": "string",
"actionType": "Block",
"equipmentNumber": "string",
"portLoCode": "string"
}
Field name
|
Type
|
Mandatory
|
Allowed value
|
Field Description
|
---|---|---|---|---|
equipmentNumber | String | Yes | Free text | Container number |
billOfLadingNumbers | Array of strings | Yes | Free text | The unique combination of Cointainer/BL will be used for the identification of the Container Release |
actionType | Enum | Yes | Block | You can only use the value Block when you wish to block a commercial release |
When the 200 result is returned, the state of the container will be set to “Blocked”.
{
"publicReferenceId": "GUID",
"externalReferenceId": "string"
}
Notifications
A successful request will generate a notification of type Release-Light with action terminalBlocked that will be sent to
Something in your call wasn’t what we were expecting. Please:
The below error message will be sent to your notification channel(s)
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
}
This error indicates that you do not have the rights to perform the requested action. To overcome this, please make sure that you are:
The below error message will be sent to your notification channel(s)
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
}
PUT - {Host}/certified-pickup/v1/{port-locode}/containers/{equipment-number}/import/terminal-release
Swagger linkParameters
Headers
Body
{
"terminalCode": "string",
"actionType": "Scanning",
"releaseDateTimeUtc": "2020-09-17T09:35:25.189Z",
"equipmentNumber": "string",
"portLoCode": "string"
}
Field name
|
Type
|
Mandatory
|
Allowed value
|
Field Description
|
---|---|---|---|---|
equipmentNumber | String | Yes | Free text | Container number |
portLoCode | String | Yes | UNLocode | Use the UNLocode of the port. For Antwerp, this is BEANR |
terminalCode | String | Yes | Free text | The terminal where the container will be available for pickUp. |
actionType | Enum | Yes | Scanning | You can only use the value Scanning when the container needs to be transported to the scanner |
releaseDateTimeUtc | DateTimeUTC | Yes | Date Time | Date from which the Terminal release will be active |
When the 200 result is returned, the state of the container will be set to “SelectedForScan”.
{
"publicReferenceId": "GUID",
"externalReferenceId": "string"
}
Notifications
A successful request will generate a notification of type Release-Light with action terminalScan that will be sent to
To get the current state of a container, please refer to the "Get status of the release light" section of this document.
The Certified Pick up API uses an async mechanism that does not allow to return a full json body. To verify the information that was stored, you can process the notification that will be sent to your notification channel(s) or use the "Get status of the release light" request.
Something in your call wasn’t what we were expecting. Please:
The below error message will be sent to your notification channel(s)
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
}
This error indicates that you do not have the rights to perform the requested action. To overcome this, please make sure that you are:
The below error message will be sent to your notification channel(s)
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
}
At any time, stakeholders that are allowed to see the information, can retrieve the detail and greenlights of a specific container release.
GET - {Host}/certified-pickup/v1/{port-locode}/containers/import/release-rights/{equipment-number}
Swagger linkParameters
Headers
Body
N/A
{
"publicReferenceId": "GUID",
"externalReferenceId": "string"
}
When the 200 result is returned, the call was successful and the information of the requested container will be sent to your Notification Channel(s).
{
"publicRefernceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"externalReferenceId": "string"
"portLoCode": "string",
"equipmentNumber": "string",
"billOfLadingNumbers": [
"string"
],
"terminalCode": "string",
"state": "Unknown"
}
Something in your call wasn’t what we were expecting. Please:
The below error message will be sent to your notification channel(s)
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
}
This error indicates that you do not have the rights to perform the requested action.To overcome this, please make sure that you are:
The below error message will be sent to your notification channel(s)
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
}
Notification
This is an example of the response you can expect over the predefined notification channel.
{
"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": []
}
Certified Pick up uses a real-time asynchronous notification mechanism. This means that, once the right to pick up a container is submitted or transferred, a notification is sent towards the other stakeholders. (the new Release Right owner.)
Several notifications, can be received. In the notification, the “Event” field allows to identify one of the following actions:
To setup your notification channels, you can find detailed information on our Wiki pages.
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 |
---|---|---|---|
timestamp | DateTime | UTC datetime stamp | The timestamp when the notification was created by the Certified Pick up platform |
PublicReferenceId | GUID | GUID | Automatically generated response |
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. |
asset | String | Free Text | Name of the asset that generated the notification. For the Certified Pick up this will always be “Certified Pick up”. |
id | String | Free Text | For the Certified Pick up, this value will list the Equipment number, allowing integrators to quickly process the json message |
type | String | Release-Right or pick up-right | Will always contain Release Right |
event | Enumeration | release, update, delete, block, unblock, terminalRelease, terminalBlocked and terminalScan for Release Lights | See above |
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 |
Field name | Type | Allowed Values | Field description |
sender> tinNumber | String | TIN number | The TIN (VAT) number of the entity that caused the notification. This is the number that is stored in the NxtPort entity database. Will always contain a value. |
sender> name | String | Free text | The name of the entity that caused the notification. This is the name that is stored in the NxtPort entity database. Will always contain a value. |
sender> eori | String | EORI number | The EORI number of the entity that caused the notification. This is the EORI nu,ber that is stored in the NxtPort entity database. Can be empty |
releaseIdentification | String | Free text | Unique release identification (per carrier) |
releaseOrderReference | String | Free text | Release Order Reference |
equipmentNumber | String | Free text | Container number |
equipmentType | String | Free text | In most cases, this will be “Container” |
billOfLadingNumbers | Array of strings | Free text | The unique combination of Cointainer/BL will be used for the identification of the Container Release |
portLoCode | String | UNLocode | The UNLocode of the port. For Antwerp, this is BEANR |
terminalCode | String | Free text | The terminal yard where the container will be available for pickUp. |
actionType | Enumeration | release, update, delete, block, unblock, terminalRelease, terminalScan, terminalBlocked | Identifies the action that was taken to trigger the Release Light notification. |
carrier> tinNumber | String | TIN number | The TIN (VAT) number of the carrier. This is the number that is stored in the NxtPort entity database. Will always contain a value. |
carrier> name | String | Free text | The name of the carrier. This is the name that is stored in the NxtPort entity database. Will always contain a value. |
carrier> eori | String | EORI number | The EORI number of the carrier. This is the EORI nu,ber that is stored in the NxtPort entity database. Can be empty |
releaseDateTimeUtc | DateTimeUTC | Date Time |
Date from which the Commercial release will be active |
expirationDateTimeUtc | DateTimeUTC | Date Time | Date until which the Commercial release will be active. If not entered, there is no expiration date applied |
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 |
{
"timestamp": "2019-08-28T09:41:18Z",
"publicReferenceId": "6d113ff6-4805-430f-be32-d8918fab83f1",
"ExternalReferenceId": "your-reference-here"
"senderId": "APCS001",
"receiverId": "APCS002",
"asset": "CPU",
"id": "ABCU1234560",
"type": "Release-Light",
"action": "create",
"body": {
"sender": {
"tinNumber": "BE0123456789",
"name": "Shipping agent name",
"eori": ""
}
"releaseIdentification": "xxxxx",
"releaseOrderReference": "Ref001",
"equipmentNumber": "ABCU1234560",
"equipmentType": "Container",
"billOfLadingNumbers": [
"ABCUAA123456"
],
"portLoCode": "BEANR",
"terminalCode": "123",
"actionType": "Release",
"carrier": {
"tinNumber": "BE0123456789",
"name": "Shipping agent name",
"eori": ""
},
"releaseDateTimeUtc": "2020-04-30T17:42:18.251Z",
"expirationDateTimeUtc": "2020-04-30T17:42:18.251Z",
"errors": [],
"warnings": []
},
"errors": [],
"warnings": []
}