作成した取引や帳票を特定するには

主に貴社システムからの API 連携を実現するための 取引／帳票の特定方法について説明します。

取引の特定

サイバーポートでは、取引新規作成時に取引に対して「取引管理番号」を自動的に付与します。
「取引管理番号」は、取引を一意に特定するためのキー項目になります。
取引に１枚のみ作成される帳票は、取引管理番号のみで帳票の特定が可能です。
※ 取引に参加していることが前提となります。

＜取引の特定のイメージ＞

取引管理番号の代替項目

取引管理番号を指定することにより、取引を一意に特定することができますが、以下の代替項目を利用し、特定することもできます。
※ 取引に参加していることが前提となります。

＜取引管理番号および代替項目による取引・帳票の特定＞

No.	取引管理番号および代替項目
		特定したい対象						説明
		取引
			帳票
			B/L単位	ｺﾝﾃﾅ単位	EIR単位	制限無し	制限無し（本船単位）
１	取引管理番号 dealNo	○	○	-	-	-	-		取引管理番号にて帳票を特定できます。
２	社内管理番号 domesticNo	○	○	-	-	-	-	作成した取引に社内管理番号を附番することで、その社内管理番号で取引を特定することができます。
３
	・ ブッキング番号 bookingNo	○	○	-	-	-	-	当該取引内のデータのブッキング番号＋船社コードにより、取引及びB/L単位帳票を特定することができます。
	・ 船社コード scacCode
４	B/L番号 blNo	○	○	-	-	-	-	当該取引内のデータのB/L番号により、取引及びB/L単位帳票を特定することができます。

帳票の特定

サイバーポートでは、帳票新規作成時に帳票に対して「取引・帳票 ID」を自動的に付与します。
「取引・帳票 ID」は、帳票を一意に特定するためのキー項目になります。
取引に１枚以上作成される帳票は、「取引・帳票 ID」を指定し、帳票を特定する必要があります。
※ 取引に参加していることが前提となります。

＜帳票の特定のイメージ＞

取引・帳票 ID の代替項目

取引・帳票 ID を指定することにより、取引内の帳票を一意に特定することができますが、以下の代替項目を利用し、特定することもできます。
※ 取引に参加していることが前提となります。

＜取引・帳票 ID の代替項目＞

No.	取引・帳票IDおよび代替項目
		特定したい対象						説明
		取引
			帳票
			B/L単位	ｺﾝﾃﾅ単位	EIR単位	制限無し	制限無し（本船単位）
１
	取引・帳票ID dealReportId	取引管理番号の代替項目にて、一意に特定される。		○	○	○	○	取引・帳票IDにて帳票を特定できます。
２
	・ 取引管理番号および代替項目	取引管理番号の代替項目にて、一意に特定される。		○	-	-	-	取引管理番号および代替項目と当該取引内のデータのコンテナ番号により、コンテナ単位帳票を特定することができます。
	・ コンテナ番号 containerNo
３
	・ 取引管理番号および代替項目	取引管理番号の代替項目にて、一意に特定される。		-	-	○	-	取引管理番号および代替項目と当該取引内のデータのカスタムIDにより、制限無し帳票を特定することができます。
	・ カスタムID customId
４
	・ 取引管理番号および代替項目	取引管理番号の代替項目にて、一意に特定される。		-	○	-	-	取引管理番号および代替項目と当該取引内の左記データ項目により、制限無し帳票を特定することができます。
	・ コンテナ番号
	・ EIR種別（IN/OUT）
	・ コンテナ状態（FULL/EMPTY）
	・ 搬出入先ターミナル