Data Dictionary Home

BillOfLadings : /API/v2/Reports/BillOfLadings

Venndor name

0000000000000_CyberPort（港湾物流分野）

System name

CyberPort

船荷証券(B/L)

Infomation
Category
Field
Governments
Data / Business logic	Business logic
Paid / Free	Free
Fees
Created by
Maintainer
Date created
Last updated
Update frequency
Necessity of contract	Unnecessary
About contract
Version
Terms and Conditions

API List

API		Description
POST	/API/v2/Reports/BillOfLadings/Create	船荷証券(B/L)を作成します。船荷証券(B/L)を作成するには、利用者が船荷証券(B/L)を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。船荷証券(B/L)に関する詳細については、[船荷証券(B/L)について]()を参照ください。
DELETE	/API/v2/Reports/BillOfLadings/Delete/{reportId}	船荷証券(B/L) を削除します。帳票ID（*reportId）を指定して、船荷証券(B/L)を削除します。船荷証券(B/L)を削除しても、ルートドキュメントの内容までは削除されません。申請種別を使用して、作成した船荷証券(B/L)のキャンセルを伝える場合は、キャンセル（Cancel）を実施後、帳票の提出（Submit*）を実施してください。船荷証券(B/L)に関する詳細については、[船荷証券(B/L)について]()を参照ください。
DELETE	/API/v2/Reports/BillOfLadings/DeleteFile/{fileId}	船荷証券(B/L) の添付ファイルを削除します。ファイルID（*fileId*）を指定して、船荷証券(B/L) の添付ファイルを削除します。帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。
GET	/API/v2/Reports/BillOfLadings/Get/{reportId}	船荷証券(B/L)を取得します。帳票ID（*reportId*）を指定して、船荷証券(B/L)を取得します。編集が行われていない場合は、ルートドキュメントから最新の船荷証券(B/L)を取得します。編集中の場合は、先に保存した、船荷証券(B/L)を取得します。船荷証券(B/L)に関する詳細については、[船荷証券(B/L)について]()を参照ください。
GET	/API/v2/Reports/BillOfLadings/GetFile/{fileId}	船荷証券(B/L)に添付されたファイルを取得します。ファイルID（*fileId）を指定して、船荷証券(B/L)に添付されたファイルを取得します。帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー（/API/v2/Reports/AccessiblePartners*）にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。
GET	/API/v2/Reports/BillOfLadings/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo}	船荷証券(B/L)を全て取得します。検索条件に該当する船荷証券(B/L)を全て取得します。編集が行われていない場合は、ルートドキュメントから最新の船荷証券(B/L)を取得します。編集中の場合は、先に保存した、船荷証券(B/L)を取得します。船荷証券(B/L)に関する詳細については、[船荷証券(B/L)について]()を参照ください。
PATCH	/API/v2/Reports/BillOfLadings/Lock/{reportId}	編集するため、船荷証券(B/L)をロックします帳票ID（*reportId）を指定して、船荷証券(B/L)をロックします。船荷証券(B/L)を作成（Create）した時点では、船荷証券(B/L)をロックが掛かりますが、取得（Get）したあとで、船荷証券(B/L)を編集する場合は、このメソッドを呼び出して、船荷証券(B/L)をロックします。ロックされた船荷証券(B/L)は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、船荷証券(B/L)をルートドキュメントから参照できますが、編集中（ロック中）の船荷証券(B/L)は参照できません。このロックは、アンロック（Unlock）を呼び出すか、帳票の保存後、帳票の提出（Submit**）を行うと解除されます。船荷証券(B/L)に関する詳細については、[船荷証券(B/L)について]()を参照ください。
PATCH	/API/v2/Reports/BillOfLadings/SetCancel/{reportId}	船荷証券(B/L)の申請種別をキャンセルします帳票ID（*reportId）を指定して、船荷証券(B/L)の申請種別（applyType）を、キャンセル（CANCEL）にします。申請種別（applyType）が、訂正（AMEND）の場合に、この操作は有効になります。このメソッドで、申請種別（applyType）を、キャンセル（CANCEL）にし、帳票の提出（Submit*）することで、申請種別が確定します。船荷証券(B/L)に関する詳細については、[船荷証券(B/L)について]()を参照ください。
PATCH	/API/v2/Reports/BillOfLadings/Submit/{reportId}	船荷証券(B/L)を提出します帳票ID（*reportId）を指定して、更新（Update）した船荷証券(B/L)を提出します。このメソッドでは、変更内容をルートドキュメントへ反映し、船荷証券(B/L)が参照できる取引内のパートナーに、変更内容を公開することになります。帳票の更新（Update*）しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、船荷証券(B/L)もロックされた状態のままなので、ご注意ください。船荷証券(B/L)に関する詳細については、[船荷証券(B/L)について]()を参照ください。
PATCH	/API/v2/Reports/BillOfLadings/Unlock/{reportId}	船荷証券(B/L)のロックを解除します帳票ID（*reportId）を指定して、船荷証券(B/L)のロックを解除します。更新内容のルートドキュメントへの反映は、帳票の提出（Submit*）で行うので、このメソッドを呼び出すと、編集内容は破棄されます。船荷証券(B/L)に関する詳細については、[船荷証券(B/L)について]()を参照ください。
PATCH	/API/v2/Reports/BillOfLadings/Update/{reportId}	船荷証券(B/L)を更新します。帳票ID（*reportId）を指定して、船荷証券(B/L)を更新します。このメソッドでは、船荷証券(B/L)の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。ルートドキュメントへの反映は、帳票の提出メソッド（Submit*）を使用します。船荷証券(B/L)に関する詳細については、[船荷証券(B/L)について]()を参照ください。
POST	/API/v2/Reports/BillOfLadings/UploadFile	船荷証券(B/L)にファイルを添付します。指定された船荷証券(B/L)に、ファイルを添付します。帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー（*/API/v2/Reports/AccessiblePartners*）にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。