创建来货/揽收袋
请求规格说明
请求说明
POST /api/parcelCollectBags
请求数据格式
名称 | 类型 | 是否必须 | 描述 | 示例值 |
---|---|---|---|---|
Type | string | 必须 | 来货件类型 SelfDelivery: 自送到仓 |
SelfDelivery |
ReferenceId | string | 袋号,袋子上需要有此条码以便我司扫描 同一袋号只能使用一次 若您未能提供袋号,我司将在确认交运袋子时将我司内部唯一袋号作为此袋号,您需要将此袋号做成条码贴在袋子上 |
||
WeightInKg | decimal | 整袋重量(单位Kg),如无数据则可留空null | ||
Volume | CubeSize | 袋子尺寸,如无数据则可留空null | ||
EstimatedArriveTime | string | ISO格式时间字符串 | 2016-05-18T10:00:00Z | |
Items | EditBagItemsRequest | 袋内明细 | ||
AutoConfirm | bool | 是否自动确认交运袋子 如果在生成来货袋之后不再需要修改数据的话,即调用此接口时袋子重量以及袋内明细等数据已准确无误,则可以将此值设置为true |
false |
示例请求
{
"Type": "SelfDelivery",
"ReferenceId": "BAG1605180001",
"WeightInKg": 12.3,
"Volume": {
"Length": 15.0,
"Width": 15.0,
"Height": 10.0,
"Unit": "CM"
},
"EstimatedArriveTime": "2016-05-18T10:00:00",
"Items": {
"IdType": "ReferenceId",
"Ids": ["REF160517002", "REF160517003", "REF160517004"]
},
"AutoConfirm": false
}
返回数据格式说明
此接口返回创建好的来货袋
返回数据格式
名称 | 类型 | 描述 |
---|---|---|
Id | string | 我司内部唯一袋号 |
AccountNo | string | 客户代码 |
Type | string | 来货袋类型 |
Status | string | 状态 Draft: 初始 Confirmed: 已提交 |
ReferenceId | string | 袋号 |
ParcelsCount | int | 袋内包裹数,如未提交任何包裹数据则为null |
WeightInKg | decimal | 整袋重量,如未提交数据则为null |
Volume | CubeSize | 袋子尺寸,如未提交数据则为null |
CreateOn | string | ISO格式时间字符串 |
ConfirmOn | string | 确认交运时间,如尚未提交则为null |
返回数据示例
{
"Data": {
"Id": "DPCB20160500027",
"AccountNo": "TEST",
"Type": "SelfDelivery",
"Status": "Draft",
"ReferenceId": "BAG1605180001",
"ParcelsCount": 3,
"WeightInKg": 12.3,
"Volume": {
"Length": 15,
"Width": 15,
"Height": 10,
"Unit": "CM"
},
"CreateOn": "2016-05-17T14:33:57Z",
"ConfirmOn": null
},
"Succeeded": true,
"Error": null
}