Data Dictionary Home

DeliveryDocuments : /API/v2/Reports/DeliveryDocuments

Venndor name

0000000000000_CyberPort（港湾物流分野）

System name

CyberPort

貨物輸送送り状

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