GET /API/v1/Report/CargoManifests/GetListByDomesticNo/{domesticNo}?customId={customId}

社内管理番号を指定して、帳票:積荷目録を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:積荷目録を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:積荷目録を取得します。

Request Information

URI Parameters

NoLimitOnNumberGetListByDomesticNoRequest

NameDescriptionTypeAdditional information
customId

帳票のカスタムIDを指定します。

String

Required

domesticNo

帳票を取得する取引を特定するために社内管理番号を指定します。

String

Required

Body Parameters

None.

Response Information

Resource Description

CargoManifests

CargoManifests

NameDescriptionTypeAdditional information
_etag

etag

String

Required

bLDetails

Collection, Null of bLDetails

None.

businessTypeId

事業種別ID

String

Required

Format : Protect

Pattern : ^(?!.*(\?|\$|#|&|,|=)).*$

callSign

コールサイン

String, Null

Format : ForeignKey /API/v1/Master/BusinessCodes?$filter=categoryCode eq '029' and businessCode eq '{value}'

consolId

混載業者番号

String, Null

None.

customId

カスタムID

String, Null

Format : Protect

dealReportId

取引・帳票ID

String

Required

estimatedTimeOfArrivalPodEta

荷揚港 入港予定日

String, Null

Format : date

estimatedTimeOfArrivalPolEta

積荷港 入港予定日

String, Null

Format : date

estimatedTimeOfDeparturePolEtd

積荷港 出港予定日

String, Null

Format : date

finalDestination

最終仕向地_名称

String, Null

None.

finalDestinationCode

最終仕向地_コード

String, Null

None.

freightAndCharges

Collection, Null of freightAndCharges

None.

nationalityOfShip

船籍

String, Null

None.

note1

備考1

String, Null

Min length: 0

Max length: 140

note2

備考2

String, Null

None.

note3

備考3

String, Null

None.

oceanCarrierCompanyName

運送人(海運)_会社名

String, Null

None.

organizationId

組織ID

String

Required

Format : Protect

Pattern : ^(?!.*(\?|\$|#|&|,|=)).*$

partitionNo

パーティション番号

Integer, Null

Format : Protect

placeOfDelivery

荷渡地_名称

String, Null

None.

placeOfDeliveryCode

荷渡地_コード

String, Null

None.

portOfDischarge

荷揚港_名称

String, Null

None.

portOfDischargeCode

荷揚港_コード

String, Null

None.

portOfLoading

積荷港_名称

String, Null

None.

portOfLoadingCode

積荷港_コード

String, Null

None.

portTotalCbm

港の総体積

Number, Null

Format : Number(10,3)

Maximum : 9999999.999

Minimum : 0

portTotalKgs

港の総重量

Number, Null

Format : Number(10,3)

Maximum : 9999999.999

Minimum : 0

portTotalPkg

港の総パッケージ数

Number, Null

Format : Number(8,0)

Maximum : 99999999

Minimum : 0

portTotalRt

港の総レベニュートン

Number, Null

Format : Number(10,3)

Maximum : 9999999.999

Minimum : 0

portWhereReportIsMade

報告書作成港

String, Null

None.

printedDate

書類発行日

String, Null

Format : date

receiptDate

荷受日

String, Null

Format : date

vesselCode

本船コード

String, Null

Format : ForeignKey /API/v1/Master/BusinessCodes?$filter=categoryCode eq '029' and businessCode eq '{value}'

vesselIMONo

IMO船舶識別番号

String, Null

None.

vesselName

本船名

String, Null

Min length: 0

Max length: 35

voyageNo

航海番号

String, Null

Min length: 0

Max length: 10