CPu variables overview

Request body fields

Below you can find the overview of all the request body field keys which are used in the API calls.

This overview acts like a reference guide, not all fields are to be included in each call. The request bodies are always marked with the calls.

	Field name	Type	Allowed values	Field description
1	`releaseIdentification`	string	Free text	Unique release identification (per carrier).
2	`releaseOrderReference`	string	Free text	Optional reference for you to identify the release internally.
3	`emptyReturnReference`	string	Free text	Self-explanatory
4	`equipmentSupplier`	string	Free text	Self-explanatory
5	`equipmentStatus`	Enum	“Import” / “Export” / “Transhipment”	Self-explanatory
6	`fullEmptyIndicator`	Enum	“Full” / “Empty“	Self-explanatory
7	`equipmentOperator`	string	Free text	Self-explanatory
8	`vesselName`	string	Free text	Self-explanatory
9	`vesselCallSign`	string	Free text	Self-explanatory
10	`voyageNumber`	string	Free text	Self-explanatory
11	`equipmentType`	string	ISO container type (e.g. “20GP“, “40HC“) or “Container”	Self-explanatory
12	`isCarrierHaulage`	boolean	true, false	A boolean value indicating if the release is carrier haulage (true) or merchant haulage (false). For invoicing purposes.
13	`billOfLadingNumbers`	Array of strings	Free text	Bill of Lading number(s) of the container. The unique combination of container/BL will be used for the identification of the container release.
14	`terminalCode`	string	Terminalcodes.pdf	The indicative terminal where the container will be available for pickup. Can be updated at any time using the Update Commercial Release.
15	`actionType`	Enum	Different per action you need to perform. Check the specific action.	Action which is sent to the CPu platform, e.g. “Release”, “Block“, “Update“
16	`carrier> identificationType`	Enum	“TIN” / “NxtEntityId” / “Eori” / “Duns” / “APCS”	Enter the type of identification of the carrier. Remark: TIN should be used for the VAT number of a company.
17	`carrier> identificationCode`	string	Free text	The value that belongs to the selected identification. Note: a carrier is not mandatory, but if filled, a check will occur if the identificationCode is known
18	`releaseTo> identificationType`	Enum	“TIN” / “NxtEntityId” / “Eori” / “Duns” / “APCS”	Enter the type of identification of the party that will receive the Release Right. If the releaseTo party is not yet known at the moment of the commercial release, this information can be left out and updated later on in the process by using the Transfer Release Right method. Remark: TIN should be used for the VAT number of a company.
19	`releaseTo> identificationCode`	string	Free text	The value that belongs to the selected identification. Note: When carrier and releaseTo are not provided, the Release Right will automatically be assigned to the submitting Shipping Agent.
20	`releaseFrom> identificationType`	Enum	“TIN” / “NxtEntityId” / “Eori” / “Duns” / “APCS”	Enter the type of identification of the party transfers the Release Right. Remark: TIN should be used for the VAT number of a company.
21	`releaseFrom> identificationCode`	string	Free text	The value that belongs to the selected identification.
22	`releaseDateTimeUtc`	string	ISO 8601 timestamp format in UTC time. E.g. `2022-09-17T09:35:25.189Z`	Date/time (UTC) from which the Commercial Release will be active.
23	`expirationDateTimeUtc`	string	ISO 8601 timestamp format in UTC time. E.g. `2022-09-17T09:35:25.189Z`	Date/time (UTC) until the Commercial Release is active. If not entered, a default of 60 calendar days will be applied.
24	`equipmentNumber`	string	Free text with maximum 50 characters, uppercase	The container number. This number will be used onwards in the process.
25	`portLoCode`	string	UN/LoCode	The UN/Locode of the operational port. For Antwerp this is “BEANR”, for Bruges this is “BEZEE”.
26	`reasonForAction`	string	Free text	Free text to provide, is displayed in the audit trail of the Release Right
27	`meansOfTransport`	Enum	“Truck“ / “Barge“ / “Rail“ / “Unknown“	Reported means of transport for post-carriage of the container
28	`vesselNumber`	string	IMO number of vessel	Self-explanatory
29	`stayNumber`	string	Stay number assigned by port authority	e.g. V234555

Notification variables

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

	Variable in notification	Explanation	Can be NULL if no information was provided
1	`[...]_identification_code_apcs`	APCS code (unique identifier on C-point) of the relevant party indicated by the […]. This can be: Sender; Carrier; ReleaseFrom; ReleaseTo.
2	`[...]_identification_code_duns`	DUNS number (https://www.dnb.com/duns-number.html ) of the relevant party indicated by the […]. This can be: Sender; Carrier; ReleaseFrom; ReleaseTo.	X
3	`[...]_identification_code_eori`	EORI number of the relevant party indicated by the […]. This can be: Sender; Carrier; ReleaseFrom; ReleaseTo.	X
4	`[...]_identification_code_nxtentityid`	NxtEntityId (or NxtPort ID) of the relevant party indicated by the […]. This can be: Sender; Carrier; ReleaseFrom; ReleaseTo.
5	`[...]_identification_code_tin`	TIN (Tax Identification Number) number of the relevant party indicated by the […]. This can be: Sender; Carrier; ReleaseFrom; ReleaseTo. For EU countries this is the VAT number as validated through the EU VIES https://ec.europa.eu/taxation_customs/vies/ .
6	`[...]_identification_code_externalid`	ExternalId (external identifier from C-point) which is shared between C-point, NxtPort and T-MINING. This can be: Sender; Carrier; ReleaseFrom; ReleaseTo.
7	`[...]_name`	Registered company name of the relevant party indicated by the […]. This can be: Sender; Carrier; ReleaseFrom; ReleaseTo; Shipping Agent; Terminal.
8	`alfapass_number_mask`	Masked (for privacy & security reasons) Alfapass number of the driver assigned for pick up. e.g. `"**12"`	X
9	`bl_number`	Transport document (B/L or SWB) number of the shipment(s) inside the container.
10	`driver_alias`	Alias of the driver assigned for pick up.	X
11	`empty_return_reference`	Empty return reference of the container. Not fully implemented in CPu yet. Be sure to ask Shipping Agent if they provide this info.	X
12	`equipment_number`	Container number.
13	`equipment_operator`	Container operator.	X
14	`equipment_status`	`"Import", "Transhipment"`
15	`equipment_supplier`	Container owner.	X
16	`equipment_type`	ISO type of container (e.g. `45G1`) or `"Container"` or `"CN"`
17	`full_empty_indicator`	`"Full"` or `"Empty"`
18	`greenlight_value`	Value & color of the Green Light. See the Green Light table below for all possible combinations and their meaning.
19	`greenlight_color`
20	`identification_type`	`"nxtentityid"`, `"eori"`, `"tin"`, `"apcs"` or `"duns"`
21	`iso_timestamp`	ISO 8601 timestamp (in UTC) e.g. `2022-01-23T10:36:39.2040693Z`
22	`nxtport_public_reference_id`	GUID generated by the NxtPort platform to identify the notification. Is equal to the `publicReferenceId` returned in the synchronous response of your original request.
23	`port_locode`	UN/Locode of the operational port. This is “BEANR” for Antwerp and “BEZEE” for Bruges.
24	`provided_identification_code`	Identification code you provided in the original request.
25	`provided_nxtentityid`	NxtEntityId (or NxtPort ID) you provided in the original request.
26	`release_order_reference`	Reference provided by the Shipping Agent to identify the Commercial Release	X
27	`terminal_code`	NxtPort standard terminal code (“0” + quay number e.g. `"01700"`). Overview: Terminalcodes.pdf
28	`unique_release_identification`	Identifier provided by the submitting Shipping Agent. Is used together with the equipment number and bl number(s) to uniquely identify a Release Right.
29	`vessel_callsign`	Self-explanatory.	X
30	`vessel_name`	Self-explanatory.	X
31	`voyage_number`	Self-explanatory.	X
32	`your_external_reference_id`	The External Reference Id submitted as request header in the original request.	X
33	`your_nxtentityid`	NxtEntityId (or NxtPort ID) of your company, i.e. the company which has received the notification.
34	`your_reason_for_action`	Free text provided by the party which triggered the event.	X

Green Light table

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

	Green Light	“greenLightName”	“greenLightValue”	“greenLightColor”	Explanation
1	Commercial Release	`CommercialRelease`	`OK`	`GREEN`	Container has been commercially released.
2	Commercial Release	`CommercialRelease`	`UNKNOWN`	`RED`	No commercial release information received yet (initial value)
3	Commercial Release	`CommercialRelease`	`BLOCKED`	`RED`	Container has been commercially blocked.
4	Commercial Release	`CommercialRelease`	`EXPIRED`	`RED`	Commercial release has expired: expiration date set by shipping agent when no expiration date set: 60 calendar days after release date
5	Terminal Discharge	`TerminalOperation`	`UNKNOWN`	`RED`	No information on discharge status yet received (initial value)
6	Terminal Discharge	`TerminalOperation`	`LOADED`	`RED`	Container is still on board of vessel.
7	Terminal Discharge	`TerminalOperation`	`DISCHARGED`	`GREEN`	Container has been discharged from vessel (import).
8	Terminal Discharge	`TerminalOperation`	`GATEIN`	`GREEN`	Container has arrived on terminal via land side.
9	Terminal Release	`TerminalReady`	`UKNOWN`	`RED`	No information on release status yet received (initial value)
10	Terminal Release	`TerminalReady`	`SELECTEDFORSCAN`	`YELLOW`	Container has been selected for scan by Terminal Operator. Scanning procedure must be followed.
11	Terminal Release	`TerminalReady`	`BLOCKED`	`RED`	Container has been blocked on terminal by Terminal Operator.
12	Terminal Release	`TerminalReady`	`RELEASED`	`GREEN`	Container has been released on terminal by Terminal Operator.
13	Terminal Release	`TerminalReady`	`RELEASED BY DEFAULT`	`GREEN`	Container has been released on terminal by Terminal Operator by default (initial value). Might be turned on red later.
14	Terminal Release	`TerminalReady`	`ARCHIVED`	`RED`	Release Right has been archived, meaning: Container has received a gate out 10 calendar days have passed since commercial release has expired
15	Customs Light	`Customs`	`NOTRELEASED`	`RED`	No release information received yet. (initial value)
16	Customs Light	`Customs`	`SELECTEDFORSCAN`	`YELLOW`	Container has been selected for scanning by competent customs authority. Scanning procedure must be followed.
17	Customs Light	`Customs`	`RELEASED`	`GREEN`	Customs authority has sent a CCRM “release” for this container. OR Customs authority has sent a CSR with color “green” for this container (release 4.1.0 - IRP).
18	Customs Light	`Customs`	`TRANSHIPMENT`	`YELLOW`	Container can be released under transhipment
19	Customs Light	`Customs`	`PORTEQUALISATION`	`YELLOW`	Container can be released under port equalisation
20	Customs Light	`Customs`	`FAVV`	`YELLOW`	Container can be released under FAVV
21	Customs Light	`Customs`	`DOCUMENTARYCONTROL`	`RED`	Container is subject to documentary control
22	Customs Light	`Customs`	`MANUALOVERWRITE`	`GREEN`	Container manually released by Ship Agent or Terminal Operator.
23	Customs Light	`Customs`	`TRANSFER`	`YELLOW`	Container can be released for transfer.
24	Customs Progress	`CustomsProgress`	`UNKNOWN`	`RED`	No information received from customs (initial value). This information is received with delay.
25	Customs Progress	`CustomsProgress`	`PARTIALLYCLEARED`	`YELLOW`	Indicative light: at least 1 item of at least 1 BL is fully cleared. This information is received with delay and Customs light is always leading over CustomsProgress.
26	Customs Progress	`CustomsProgress`	`CUSTOMSLIGHTGREEN`	`GREEN`	Light defaulted on green as Customs Light is turned on Green.
27	Gate Operation	`GateOperation`	`UNKNOWN`	`RED`	Container has not left the terminal yet according to Terminal Operator. (initial value)
28	Gate Operation	`GateOperation`	`GATEOUTRECEIVED`	`GREEN`	Container has left the terminal according to Terminal Operator.
29	Pick up	`PickupLight`	`UNKNOWN`	`RED`	No Pick up Right has been generated yet for the container. (initial value)
30	Pick up	`PickupLight`	`ASSIGNED`	`GREEN`	Pick up Right has been generated, i.e. a driver has been assigned.
31	Pick up	`PickupLight`	`REVOKED`	`RED`	The assignment of a driver has been revoked, awaiting new assignment.

Related pages

Need any further assistance?

Raise a support ticket on the NxtPort Support Portal