Data Dictionary Home

Trades : /API/v2/Trades

Venndor name

0000000000000_CyberPort（港湾物流分野）

System name

CyberPort

取引

Infomation
Category
Field
Governments
Data / 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/Trades/Create	取引を作成します。サイバーポートで、複数の事業者間で帳票のやり取りを行うには、まずはこのメソッドで取引を作成します。取引は、複数の事業者間と港湾・貿易業務を行う上での共有空間として機能します。作成された取引には、取引管理番号（*tradeNo）という一意の番号が附番され、空のルートドキュメントが作成されます。以降、取引は、取引管理番号（tradeNo）で一意に識別できます。取引が作成された時点では、取引のオーナーとして指定した組織に所属する利用者しかアクセス出来ません。他の事業者を取引に参加させ、帳票のやり取りを行うには、作成した取引に対し、取引のパートナーを追加（/API/v2/Trades/Partners*）を行う必要があります。取引に関する詳細については、[取引について]()を参照ください。
DELETE	/API/v2/Trades/Delete/{tradeNo}	取引を削除します。取引管理番号（*tradeNo*）を指定して、取引を削除します。取引を削除するには、その取引に利用者が所属する組織が参加しており、かつ、その組織が取引のオーナーである必要があります。ただし、取引に他のパートナーが参加してたり、帳票が作成されている場合は、削除できません。この場合は、取引のステータスを変更してください。取引に関する詳細については、[取引について]()を参照ください。
POST	/API/v2/Trades/Duplicate	取引を複製します。複製できる取引は、利用者が所属する組織が参加している取引のみとなります。取引を複製すると、複製元の取引から、取引のパートナーを引き継いだ形で、取引が作成されます。但し、複製範囲（*organizationScope*）で、追加したパートナーのみとした場合、複製元で利用者が所属する組織が追加したパートナーが複製対象となります。複製元の取引内に存在している帳票は複製対象とはなりません。また、複製した取引には、パートナーの帳票アクセス権限も含まれます。取引に関する詳細については、[取引について]()を参照ください。
GET	/API/v2/Trades/Get/{tradeNo}	取引を取得します。取引管理番号（*tradeNo*）を指定して、利用者が所属する組織が参加している取引を取得します。取引に関する詳細については、[取引について]()を参照ください。
GET	/API/v2/Trades/GetContainerRequests/{tradeNo}?newReportCode=!{newReportCode}	取引内のコンテナ要求を取得します。取引管理番号（*tradeNo*）を指定して、各帳票を通して登録された取引内のコンテナ要求を全て取得します。
GET	/API/v2/Trades/GetContainers/{tradeNo}?newReportCode=!{newReportCode}	取引内のコンテナを取得します。取引管理番号（*tradeNo*）を指定して、各帳票を通して登録された取引内のコンテナを全て取得します。
GET	/API/v2/Trades/Search?tradeNo=!{tradeNo}&tradeType=!{tradeType}&tradeName=!{tradeName}&uniqueNo=!{uniqueNo}&parentTradeNo=!{parentTradeNo}&organizationIdAsOwner=!{organizationIdAsOwner}&organizationIdAsPartnerList=!{organizationIdAsPartnerList}&tradeStatus=!{tradeStatus}&createdAtFrom=!{createdAtFrom}&createdAtTo=!{createdAtTo}&createdAtRange=!{createdAtRange}&createdAtRangeUnit=!{createdAtRangeUnit}&updatedAtFrom=!{updatedAtFrom}&updatedAtTo=!{updatedAtTo}&updatedAtRange=!{updatedAtRange}&updatedAtRangeUnit=!{updatedAtRangeUnit}&bookingNo=!{bookingNo}&scacCode=!{scacCode}&callsign=!{callsign}&vesselName=!{vesselName}&voyageNo=!{voyageNo}&blNo=!{blNo}&invoiceNo=!{invoiceNo}&keyword=!{keyword}&cyOpenAtFrom=!{cyOpenAtFrom}&cyOpenAtTo=!{cyOpenAtTo}&cyOpenAtRange=!{cyOpenAtRange}&cyOpenAtRangeUnit=!{cyOpenAtRangeUnit}&cyCutAtFrom=!{cyCutAtFrom}&cyCutAtTo=!{cyCutAtTo}&cyCutAtRange=!{cyCutAtRange}&cyCutAtRangeUnit=!{cyCutAtRangeUnit}&cfsCutAtFrom=!{cfsCutAtFrom}&cfsCutAtTo=!{cfsCutAtTo}&cfsCutAtRange=!{cfsCutAtRange}&cfsCutAtRangeUnit=!{cfsCutAtRangeUnit}&portOfLoadingCode=!{portOfLoadingCode}&portOfLoadingEtaFrom=!{portOfLoadingEtaFrom}&portOfLoadingEtaTo=!{portOfLoadingEtaTo}&portOfLoadingEtaRange=!{portOfLoadingEtaRange}&portOfLoadingEtaRangeUnit=!{portOfLoadingEtaRangeUnit}&portOfLoadingEtdFrom=!{portOfLoadingEtdFrom}&portOfLoadingEtdTo=!{portOfLoadingEtdTo}&portOfLoadingEtdRange=!{portOfLoadingEtdRange}&portOfLoadingEtdRangeUnit=!{portOfLoadingEtdRangeUnit}&portOfDischargeCode=!{portOfDischargeCode}&portOfDischargeEtaFrom=!{portOfDischargeEtaFrom}&portOfDischargeEtaTo=!{portOfDischargeEtaTo}&portOfDischargeEtaRange=!{portOfDischargeEtaRange}&portOfDischargeEtaRangeUnit=!{portOfDischargeEtaRangeUnit}&portOfDischargeEtdFrom=!{portOfDischargeEtdFrom}&portOfDischargeEtdTo=!{portOfDischargeEtdTo}&portOfDischargeEtdRange=!{portOfDischargeEtdRange}&portOfDischargeEtdRangeUnit=!{portOfDischargeEtdRangeUnit}	取引を全て取得します。検索条件に該当する、利用者が所属する組織が参加している取引を全て取得します。取引に関する詳細については、[取引について]()を参照ください。
GET	/API/v2/Trades/SearchByShortcut/{searchShortcutId}	検索ショートカットを指定して、取引を取得します。検索ショートカットID（*searchShortcutId*）を指定して、ショートカットとして保存した検索条件に該当する、利用者が所属する組織が参加している取引を全て取得します。取引に関する詳細については、[取引について]()を参照ください。
PATCH	/API/v2/Trades/SetOwner/{tradeNo}	取引のオーナーを設定します。取引管理番号（*tradeNo*）を指定して、取引のオーナーを設定、変更します。オーナーを設定、変更をするには、その取引に利用者が所属する組織が参加しており、かつ、その組織が取引のオーナーである必要があります。取引に関する詳細については、[取引について]()を参照ください。
PATCH	/API/v2/Trades/SetParent/{tradeNo}	親となる取引を設定します。取引管理番号（*tradeNo*）を指定して、親となる取引を設定、変更します。親となる取引を設定、変更をするには、その取引に利用者が所属する組織が参加しており、かつ、親となる取引についても同様に、その取引に利用者が所属する組織が参加している必要があります。取引に関する詳細については、[取引について]()を参照ください。
PATCH	/API/v2/Trades/SetStatus/{tradeNo}	取引のステータスを設定します。取引管理番号（*tradeNo*）を指定して、取引のステータスを設定、変更します。取引のステータスを設定、変更をするには、その取引に利用者が所属する組織が参加しており、かつ、その組織が取引のオーナーである必要があります。取引に関する詳細については、[取引について]()を参照ください。
PATCH	/API/v2/Trades/SetTradeName/{tradeNo}	取引名を設定します。取引管理番号（*tradeNo*）を指定して、取引名を設定、変更します。取引名を設定、変更をするには、その取引に利用者が所属する組織が参加しており、かつ、その組織が取引のオーナーである必要があります。取引に関する詳細については、[取引について]()を参照ください。
PATCH	/API/v2/Trades/SetUniqueNo/{tradeNo}	取引に社内管理番号を設定します。取引管理番号（*tradeNo）を指定して、取引に社内管理番号を設定、変更します。社内管理番号（uniqueNo）は、取引管理番号の別名として機能します。社内管理番号は取引に参加している組織・事業種別毎に附番できるので、各組織で任意の文字列による取引の特定が可能になります。社内管理番号（uniqueNo*）を設定、変更をするには、その取引に利用者が所属する組織がパートナーとして参加している必要があります。取引に関する詳細については、[取引について]()を参照ください。