Data Dictionary Home

PackingLists : /API/v2/Reports/PackingLists

Venndor name

0000000000000_CyberPort（港湾物流分野）

System name

CyberPort

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