订舱提交 - 安通订舱API

1.提交后无法修改单据。
2.暂不支持危险品与冷藏箱订舱业务。

请求参数

Header 参数

Content-Type

string

必需

示例值:

application/json

token

string

token令牌

必需

示例值:

Body 参数application/json

orderNumber

string

订单号

可选

订单号保存后生成，非必填，但保存与提交时如果有订单号需要传入，否则默认生成新订单。

startPort

string

起始港

必需

调用“获取港口信息/api/basedata/getPortList”获取

endPort

string

目的港

必需

调用“获取港口信息/api/basedata/getPortList”获取

shipperiodId

string

船期ID

必需

调用“获取船期接口/api/freight/getShipSchlList”获取；如果船期接口返回无数据，则字段可放空

workflowpath

string

物流路径

必需

调用“获取船期接口/api/freight/getShipSchlList”获取，取flowPath字段

forwardingClause

enum<string>

运输条款

必需

运输条款

枚举值:

CFS/CFSCFS/CYCFS/DOORCY/CFSCY/CYCY/DOORCY/FODOOR/CFSDOOR/CYDOOR/DOORDOOR/FOFI/CYFI/DOORFI/FO

endtrucksup

string

目的港指定车队名称

可选

目的港运输条款为DOOR可指定目的港车队，调用“获取目的港置指定车队/api/booking/getDestinationFleet”获取

startTruckType

enum<string>

起始港运输类型

可选

条款为DOOR/*必填。

枚举值:

0123

endTruckType

enum<string>

目的港运输类型

可选

条款为*/DOOR必填。

枚举值:

0123

isSearailWay

string

是否海铁联运

必需

默认0。是：1，否：0

searailWayPathId

string

海铁路径ID

可选

调用“分页获取运价（海铁联运）/api/freight/pageSeaRailwayPrices”获取

searailWayPath

string

海铁联运路径

可选

调用“分页获取运价（海铁联运）/api/freight/pageSeaRailwayPrices”获取

consigneeId

string

收货人地址ID

必需

调用“用户地址列表查询/api/basedata/getAddressList”获取历史地址；调用“地址信息保存新增/api/basedata/getAddressList”新增订单地址（订单目的港条款为CY，即运输条款为*/CY，要求地址的收货人公司在安通系统要有备案记录，否则无法完成收货地址的新增，请咨询安通对应订舱网点咨询收货人公司备案事宜）

consignorId

string

发货人地址ID

必需

调用“用户地址列表查询/api/basedata/getAddressList”获取历史地址；调用“地址信息保存新增/api/basedata/getAddressList”新增发货地址

goodsName

string

货名

必需

调用“获取货物信息列表/api/basedata/getGoodsList”获取

goodsTypeName

string

货物种类名称

必需

调用“获取货物信息列表/api/basedata/getGoodsList”获取

packingType

enum<string>

包装类型名称

必需

枚举值:

液袋普通袋装托盘纸箱罐装桶装木箱散装空箱卷装片装捆套裸包木制托盘木制托盘(复数)束束(复数)

signinbox

string

是否箱内签收单

可选

默认0。0：否，1：是

shippingMark

string

唛头

可选

唛头

count

integer

件数

可选

件数

roughWeight

string

货重

必需

传值单箱货重具体数值即可，无需传货重单位；（货重单位：千克）

volume

string

体积

可选

传值单箱体积具体数值即可，无需传体积单位；（体积单位：CMB）

cellPhoneNumber

string

理赔电话

必需

传值为手机号码

thirdParty

string

第三方付款单位

可选

第三方付款单位

description

string

订单备注

可选

订单备注

isDangerous

string

是否危险品

可选

暂时不支持危险品。默认0。0：否，1：是

declaredValue

integer

保险声明价值

可选

传值单箱保险申明价值数值即可，无需传价值单位；（单位：万元）,传空值默认传值对应货名的最低保险申明价值

paymentType

string

付款方式

必需

默认：1。如选择到付则，需传入到付付款对象paymentobj。 1：预付，2：到付

paymentobj

string

到付付款对象

可选

paymentType='2'时必填

coldStorage

string

是否冷藏品

可选

默认0。0：否，1：是

coldGuaranteeId

string

冷藏品保函附件id

可选

调用“冷藏品保函上传/api/booking/uploadBookingFile”获取data参数，必填

plugIn

string

冷藏品拖车是否插电

可选

precool

string

冷藏品是否预冷

可选

coldStorage='1'时必填，默认0。0：否，1：是

ptiOk

string

冷藏品PTI_OK

可选

temperatureType

enum<string>

冷藏品温度类型

可选

coldStorage='1'时必填

枚举值:

temperatureHigh

number

冷藏品温度值

可选

coldStorage='1'时必填

temperatureUnit

enum<string>

冷藏品温度单位

可选

coldStorage='1'时必填

枚举值:

1fahrenheit2Centigrade

ventilation

number

冷藏品通风度

可选

coldStorage='1'时必填

plugInType

enum<string>

冷藏品拖车插电类型

可选

枚举值:

123

dockPlugInType

enum<string>

冷藏品码头插电类型

可选

coldStorage='1'时必填

枚举值:

123

coolRemark

string

冷藏品特别说明

可选

imdg

string

危险品字段

可选

dangerType

string

危险品字段

可选

unnumber

string

危险品字段

可选

dangerRemark

string

危险品字段

可选

couponDeduct

string

优惠劵抵扣

可选

默认：0。0：否，1：是

couponNo

string

优惠劵编号

可选

调用“获取订舱优惠券/api/booking/getBookingCoupons”获取，使用优惠券抵扣该字段必填

pointsDeduct

string

积分抵扣

可选

默认0；0：不使用，1：使用。使用积分抵扣前，先调用“积分抵扣校验/api/booking/getIntegralDeductionRules“获取

pressureYears

string

是否压年

可选

默认：0。0：否，1：是；收货日期为客户收货计划，用箱期标准参照我司春节期间用箱期规定执行！

boxSurcharge

string

购买增值箱体附加

必需

默认：0。0：否，1：是

buyBoxInsurance

string

是否购买航次箱体保险

必需

默认：0。0：否，1：是;2023-09-05 00:00:00后开始添加

boxPremiumConfigNo

string

箱体保险配置编号

必需

是否购买航次箱体保险为是时，该字段必填；获取航次箱体保险配置信息接口（/api/booking/listBoxPremiumInfo）返回的boxPremiumNo字段

isUploadAttachment

string

是否上传附件（传0、1）

可选

0：否；1：是；根据获取货物信息列表接口【/api/basedata/getGoodsList】返回的isUploadAttachment字段判断；

attachmentIdList

array[string]

其他附件ID

可选

是否上传附件为是时，该字段必填；传货物其他附件上传接口【/api/booking/uploadBookingAttachmentFile】返回的data；多个用英文逗号隔开；

bookingExpOrderEntries

array [object {2}]

出口港起指定车队

可选

boxNum

string

出口港起指定车队箱量

必需

出口港起指定车队名称有值时，该字段必须大于0

supplierName

string

出口港起指定车队名称

必需

出口港出口港起指定车队箱量有值时，该字段不能为空，获取出口办单授权车队接口（/api/booking/getExitFleetList）返回的supplierName字段。

boxEntrys

array [object {7}]

箱信息模块

必需

freightmfeid

string

箱对应运价ID

可选

已废弃

boxTypeId

string

箱类型ID

必需

获取指定流向运价获取

emptyFull

string

空重E/F

必需

E：空箱，F：重箱

soc

string

是否SOC箱

必需

默认0。 0：否，1：是

boxSize

string

箱尺寸

必需

count

integer

订舱箱个数

必需

运价接口获取

price

integer

单箱运价

必需

示例

{
    "orderNumber": "",
    "startPort": "海口",
    "endPort": "天津",
    "shipperiodId": "vjAAAVvz4/OCq9xE",
    "workflowpath": "上海-福州",
    "forwardingClause": "CY/CY",
    "startTruckType": "0",
    "endTruckType": "0",
    "isSearailWay": "0",
    "searailWayPathId": "",
    "searailWayPath": "",
    "consigneeId": "9YR5IXGrTeyde2CtWeA1janumgY=",
    "consignorId": "STIC+U8MSUW9VoRHJRlC0KnumgY=",
    "goodsName": "云母",
    "goodsTypeName": "矿石类",
    "signinbox": "1",
    "shippingMark": "唛头",
    "count": "3",
    "roughWeight": "25000",
    "volume": "2000",
    "cellPhoneNumber": "17750808237",
    "isBuyCntrInsurance":"0",
    "thirdParty": "",
    "description": "api订舱费用计算1",
    "isDangerous": 0,
    "isColdStorage": "0",
    "isPlugin": "1",
    "declaredValue": 4,
    "paymentType": "1",
    "packingType": "卷装",
    "isPrecool": "",
    "isPtIok": "",
    "temperatureType": "",
    "temperatureHigh": "",
    "temperatureUnit": "",
    "ventilation": "",
    "pluginType": "",
    "coolRemark": "",
    "imdg": "",
    "dangerType": "",
    "unnumber": "",
    "dangerRemark": "",
    "iscoupondeduct":"0",
    "couponno":"",
    "pointsDeduct":"",
    "boxEntrys": [
        {
            "freightmfeid": "vjAAAV8zraqNS5E3",
            "boxTypeId": "vjAAAACEFJEIo/xj",
            "emptyFull": "F",
            "soc": "0",
            "boxSize": "20",
            "count": 1,
            "price": 8012
        }
    ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

status_code

integer

状态码(200=成功)

必需

data

object

必需

bookingNo

string

订舱单号

必需

workflowpath

string

物流路径

必需

shipperiodId

string

船期ID

必需

bookingId

string

订舱单ID

必需

fee

number

订舱合计费用

必需

obtainPoints

number

预计获赠积分

必需

autoReceive

boolean

是否自动接舱

必需

true:是，false:否

autoReceiveMsg

string

自动接舱说明

必需

state

string

状态

必需

示例

{
    "status_code": 200,
    "data": {
        "bookingNo": "I-AT2022095849729",
        "autoReceiveMsg": "您已享受舱位保障服务,自动接舱成功！运单号：ASHAFOC220000426",
        "workflowpath": "上海-南沙-海口",
        "fee": 12724,
        "shipperiodId": "vjAAAP9okURrBDIo",
        "obtainPoints": 0,
        "autoReceive": true,
        "bookingId": "pAzxuwCeQXWMh2y8ihP7KtH5lcM="
    },
    "state": "ok"
}