POST /API/v1/Report/DeliveryDocuments/Register
帳票:貨物輸送送り状を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。
Request Information
URI Parameters
None.
Body Parameters
DeliveryDocuments
Name | Description | Type | Additional information |
---|---|---|---|
_etag | etag |
String |
Required |
businessTypeId | 事業種別ID |
String |
Required Format : Protect Pattern : ^(?!.*(\?|\$|#|&|,|=)).*$ |
commodity | 商品名 |
String, Null |
Min length: 0 Max length: 350 |
commodityDetails |
Collection, Null of commodityDetails |
None. |
|
commodityTotalGrossWeight | 商品総グロス重量 |
Number, Null |
Format : Number(10,3) Maximum : 9999999.999 Minimum : 0 |
commodityTotalGrossWeightUnitCode | 商品総グロス重量_単位コード |
String, Null |
None. |
commodityTotalMeasurement | 商品総体積 |
Number, Null |
Format : Number(10,3) Maximum : 9999999.999 Minimum : 0 |
commodityTotalMeasurementUnitCode | 商品総体積_単位コード |
String, Null |
None. |
commodityTotalQuantity | 商品総数 |
Number, Null |
Format : Number(14,2) Maximum : 999999999999.99 Minimum : 0 |
containerDetails |
Collection, Null of containerDetails |
None. |
|
containerRequestDetails |
Collection, Null of containerRequestDetails |
None. |
|
containerVanDevanDate | 積卸日付 |
String, Null |
Format : date |
containerVanDevanPlaceName | 積卸場所_名称 |
String, Null |
Min length: 0 Max length: 30 |
customId | カスタムID |
String, Null |
Format : Protect |
dealInformation |
Required |
||
dealReportId | 取引・帳票ID |
String |
Required |
destinationCode | 着地コード |
String, Null |
None. |
impNO | IMP NO. |
String, Null |
None. |
note1 | 備考1 |
String, Null |
Min length: 0 Max length: 140 |
note2 | 備考2 |
String, Null |
None. |
note3 | 備考3 |
String, Null |
None. |
organizationId | 組織ID |
String |
Required Format : Protect Pattern : ^(?!.*(\?|\$|#|&|,|=)).*$ |
partitionNo | パーティション番号 |
Integer, Null |
Format : Protect |
publisherCompanyName | 書類発行者_会社名 |
String, Null |
None. |
receiptStamp | 受領印 |
String, Null |
None. |
refNo | 参照番号 |
String, Null |
None. |
remarks | 摘要 |
String, Null |
None. |
roadTransportOperatorAddress | 運送会社(陸運)_住所 |
String, Null |
None. |
roadTransportOperatorCompanyName | 運送会社(陸運)_会社名 |
String, Null |
None. |
roadTransportOperatorEmail | 運送会社(陸運)_メールアドレス |
String, Null |
None. |
roadTransportOperatorFax | 運送会社(陸運)_FAX番号 |
String, Null |
None. |
roadTransportOperatorPersonInCharge | 運送会社(陸運)_担当者 |
String, Null |
None. |
roadTransportOperatorTel | 運送会社(陸運)_電話番号 |
String, Null |
None. |
shippingAndDeliveryMethod | 発送・引渡方法 |
String, Null |
None. |
truckNo | トラック番号 |
String, Null |
None. |
warehouseReceiptNo | 入庫番号 |
String, Null |
None. |
Response Information
Resource Description
None.