POST /API/v2/Trades/Create
取引を作成します。 サイバーポートで、複数の事業者間で帳票のやり取りを行うには、まずはこのメソッドで取引を作成します。取引は、複数の事業者間と港湾・貿易業務を行う上での共有空間として機能します。 作成された取引には、取引管理番号（***tradeNo***）という一意の番号が附番され、空のルートドキュメントが作成されます。以降、取引は、取引管理番号（***tradeNo***）で一意に識別できます。 取引が作成された時点では、取引のオーナーとして指定した組織に所属する利用者しかアクセス出来ません。他の事業者を取引に参加させ、帳票のやり取りを行うには、作成した取引に対し、取引のパートナーを追加（***/API/v2/Trades/Partners***）を行う必要があります。 取引に関する詳細については、[取引について]()を参照ください。
Request Information
URI Parameters
None.
Body Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| organizationId | 組織ID |
String |
Required Max length: 20 Pattern : ^(?!.*(\?|\$|#|&|,|=)).+$ |
| tradeType | 取引タイプ |
String |
Required Max length: 8 |
| tradeName | 取引名 |
String, Null |
Max length: 100 |
| message | メッセージ |
String, Null |
None. |
Response Information
Resource Description
| Name | Description | Type | Additional information |
|---|---|---|---|
| tradeNo | 取引管理番号 |
String |
Required Max length: 20 |
| tradeName | 取引名 |
String, Null |
None. |
| tradeType | 取引タイプ |
String |
Required Max length: 8 |
| parentTradeNo | 親の取引管理番号 |
String, Null |
None. |
| partnerIdAsOwner | オーナーとなる取引のパートナーID |
String |
Required Max length: 41 |
| tradeStatus | 取引ステータス |
String |
Required Max length: 9 |
| processSummary | 取引内のプロセスサマリ |
Collection, Null of processSummary |
None. |
| uniqueNos | 社内管理番号 |
Collection, Null of uniqueNos |
None. |
| vessel |
Object, Null |
None. |
|
| invoiceNo | インボイス番号 |
String, Null |
Max length: 35 |
| blNo | B/L番号 |
String, Null |
Max length: 30 |
| createdAt | 作成日時 |
String, Null |
Format : date-time |
| updatedAt | 更新日時 |
String, Null |
Format : date-time |