批量获取包裹账单
通过此 API 可一次查询多个包裹的账单。
账单在我司出库之后方会生成。未生成账单或不存在的包裹将不会出现在返回结果中;若没有任何符合条件的账单,则返回空数组。
请求规格说明
请求方式
GET api/parcels/invoices?processCodes={processCode1}|{processCode2}|{processCode3}
processCode 为处理号,多个处理号之间用竖线(|)隔开。单次请求最多支持 100 个处理号,超过 100 个将返回错误。
如果手动拼接url的话,注意需要将拼接好的处理号做次urlEncode才能作为queryString的值。
注:花括号{}为参数占位符,实际请求中无需传递
返回数据格式说明
返回数据中的 Data 为账单数组,数组中每个元素的格式如下。
返回数据格式
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| AccountNo | string | 客户代码 | |
| ReferenceId | string | 客户订单号 | |
| ProcessCode | string | 包裹处理号 | |
| TrackingNumber | string | 跟踪号 | |
| WarehouseCode | string | 送货仓库代码 | SZ |
| ShippingMethod | ParcelShippingMethod | 发货方式 | |
| TotalValue | Money | 包裹申报金额 | |
| WeightInKg | decimal | 包裹预报重量(单位:KG) | |
| CheckWeightInKg | decimal | 包裹复核重量(单位:KG) | |
| TotalVolume | CubeSize | 包裹预报尺寸 | |
| CheckTotalVolume | CubeSize | 包裹复核尺寸 | |
| FeeWeightInKg | decimal | 计费重量(单位:KG) | |
| TotalFee | Money | 包裹总费用 | |
| POBOFee | Money | 代缴税费 | |
| Fees | InvoiceFee[] | 费用明细 | |
| CreateOn | Time | 创建时间 | |
| ReceiveOn | Time | 收货时间 | |
| ShipOn | Time | 出库时间 |
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| Amount | Money | 金额 | |
| Code | string |
费用类型 Parcel_WeightCharge: 重量费 Parcel_RegisterCost: 挂号费 Parcel_HandlCost: 处理费 Parcel_FuelCharge: 燃油费 Parcel_RemoteCost: 偏远附加费 Parcel_ClearanceCost: 清关费 Parcel_DutyCost: 关税 Parcel_VatCost: VAT |
返回数据示例
{
"Data": [{
"AccountNo": "TEST",
"ReferenceId": "WISH1700828002ES",
"ProcessCode": "DEVPAA0000052905YQ",
"TrackingNumber": "0028037097000833001072004818",
"WarehouseCode": "SZ",
"ShippingMethod": {
"Code": "V2ALL",
"Name": null,
"IsTracking": false,
"IsVolumeWeight": false,
"MaxVolumeWeightInCm": null,
"MaxWeightInKg": null,
"Region": null,
"Description": null
},
"TotalValue": {
"Code": "USD",
"Value": 18.45
},
"WeightInKg": 0.25,
"CheckWeightInKg": 0.4,
"TotalVolume": {
"Length": 10,
"Width": 10,
"Height": 5,
"Unit": "CM"
},
"CheckTotalVolume": {
"Length": 10,
"Width": 10,
"Height": 5,
"Unit": "CM"
},
"FeeWeightInKg": 0.4,
"TotalFee": {
"Code": "CNY",
"Value": 31
},
"POBOFee": {
"Code": "CNY",
"Value": 0
},
"Fees": [{
"Amount": {
"Code": "CNY",
"Value": 26
},
"Code": "Parcel_WeightCharge"
},
{
"Amount": {
"Code": "CNY",
"Value": 5
},
"Code": "Parcel_HandlCost"
}
],
"CreateOn": "2017-08-28T04:19:24.317Z",
"ReceiveOn": "2017-08-28T04:35:27.107Z",
"ShipOn": "2017-08-28T04:40:00Z"
},
{
"AccountNo": "TEST",
"ReferenceId": "WISH1700828003ES",
"ProcessCode": "DEVPAA0000052906YQ",
"TrackingNumber": "0028037097000833001072004819",
"WarehouseCode": "SZ",
"ShippingMethod": {
"Code": "V2ALL",
"Name": null,
"IsTracking": false,
"IsVolumeWeight": false,
"MaxVolumeWeightInCm": null,
"MaxWeightInKg": null,
"Region": null,
"Description": null
},
"TotalValue": {
"Code": "USD",
"Value": 22.10
},
"WeightInKg": 0.30,
"CheckWeightInKg": 0.5,
"TotalVolume": {
"Length": 12,
"Width": 10,
"Height": 6,
"Unit": "CM"
},
"CheckTotalVolume": {
"Length": 12,
"Width": 10,
"Height": 6,
"Unit": "CM"
},
"FeeWeightInKg": 0.5,
"TotalFee": {
"Code": "CNY",
"Value": 38
},
"POBOFee": {
"Code": "CNY",
"Value": 0
},
"Fees": [{
"Amount": {
"Code": "CNY",
"Value": 33
},
"Code": "Parcel_WeightCharge"
},
{
"Amount": {
"Code": "CNY",
"Value": 5
},
"Code": "Parcel_HandlCost"
}
],
"CreateOn": "2017-08-28T05:11:10.220Z",
"ReceiveOn": "2017-08-28T05:26:31.900Z",
"ShipOn": "2017-08-28T05:33:00Z"
}
],
"Succeeded": true,
"Error": null
}