获取包裹信息

请求规格说明

请求方式

GET api/parcels/{processCode}

processCode 为我司处理号

注：花括号{}为参数占位符，实际请求中无需传递

返回数据格式说明

返回数据格式

名称 类型 描述 示例值
AccountNo string 客户代码 TEST
ReferenceId string 客户订单号
ProcessCode string 包裹处理号
IndexNumber string 检索号
SellingPlatformOrder SellingPlatformOrder 销售平台订单信息
ShippingAddress Address 收件人地址信息
Status string 包裹状态 Original: 初始状态
Confirmed: 己确认交运(已预报)
Arrived: 已揽件/到仓
InStock: 已收货/核验
Shipped: 己发货
Transfer: 运输中
Abnormal: 异常
DepartFromPort: 己离港
Cancel: 己取消
Returned: 已退回
WeightInKg decimal 包裹预报重量(单位:KG)
CheckWeightInKg decimal 可空 包裹复核重量(单位:KG)
ItemDetails ParcelItemDetail[] 包裹件内明细
Cases ParcelCase[] 一票多件分箱信息
TotalValue Money 包裹申报金额
TotalVolume CubeSize 包裹预报尺寸
CheckTotalVolume CubeSize 包裹复核尺寸
WithBatteryType WithBatteryType 包裹带电信息
Notes string 包裹备注
BatchNo string 批次
WarehouseCode string 送货仓库代码 SZ
WarehouseName string 送货仓库名称 深圳
ProcessLocation string 送货仓库名称 深圳
ShippingMethod ParcelShippingMethod 申请的发货方式
ItemType ParcelItemType 包裹类型 DOC,SPX
DutyPaymentMethod DutyPaymentMethod 关税结算方式
RealShippingMethod ParcelShippingMethod 实际的发货方式
TrackingNumber string 已废弃，创建包裹时候的导入的跟踪号，或者Relabel前系统分配的跟踪号
RealTrackingNumber string 已废弃，Relabel后的跟踪号
FinalTrackingNumber string 最终跟踪号
TrackingNoProcessResult.Code 为 Success 时，此属性才会有值。请始终先参考 TrackingNoProcessResult 属性查看跟踪号分配信息

当TrackingNoProcessResult.Code为Success，并且TrackingNoProcessResult.IsVirtual为true 时，说明当前单号为虚拟单号。请先打单发货，待我司操作之后才会分配最终的派送单号。 您需要视平台标记发货方式而定，有选择性地调用本接口来查询包裹真实派送单号。当我司操作货物并且成功获取到真实派送单号之后，TrackingNoProcessResult.Code为Success，TrackingNoProcessResult.IsVirtual为false。
一般只有美国USPS渠道才会出现此情况。
TrackingNoProcessResult TrackingNoProcessResult 跟踪号分配信息

Code 为 Success 表示跟踪号分配成功，可通过 FinalTrackingNumber 获取跟踪号。

Code 为 Processing 时，你需要隔一阵子再次查询获取包裹接口以获取跟踪号。 通常会在5分钟内完成。

Code 为 Error 时，请参考 Message 查看具体错误信息
SortCode string 包裹分区码
要求客户分区装箱时，可以通过此字段获取包裹所属的分区。
跟踪号分配成功状态下，此分区码方才有效。
IsMPS bool 快递一票多件(multiple package shipment)
MPSType ParcelMPSType 快递一票多件类型 如:Normal, FBA
Shipper string 发运人
已废弃，请参考 ShipperInfo
ShipContactInfo string 已废弃，请参考 ShipperInfo
ShippedBy string 已废弃，请参考 ShipperInfo
ShipVatNo string 已废弃，请参考 ShipperInfo
ShipperInfo ParcelShipperInfo 发件信息
IsRemoteArea bool 是否偏远
CreateOn Time 创建时间
ArriveOn Time 揽件/到仓时间
ReceiveOn Time 收货/核验时间
ShipOn Time 出库时间

一票多件分箱信息

名称 类型 描述 示例值
CustomerCaseNo string 客户箱号
CaseCode string 内部箱号
TrackingNumber string 箱跟踪号
WeightInKg decimal 预报重
CheckWeightInKg decimal 核重
Size CubeSize 预报尺寸
CheckSize CubeSize 核验尺寸

返回数据示例

{
  "Data": {
    "AccountNo": "TEST",
    "ReferenceId": "REF1000000006",
    "ProcessCode": "SBXPAA0000038638YQ",
    "IndexNumber": "90010000038638",
    "SellingPlatformOrder": null,
    "ShippingAddress": {
      "Company": "Company",
      "Street1": "Street1",
      "Street2": "Street1",
      "Street3": "",
      "District": "",
      "City": "City",
      "Province": "",
      "Country": "United Kingdom",
      "CountryCode": "GB",
      "Postcode": "NW1 6XE",
      "Contacter": "Jon Snow",
      "Tel": "134567890",
      "Email": "",
      "TaxId": ""
    },
    "Status": "Confirmed",
    "WeightInKg": 1.2,
    "CheckWeightInKg": null,
    "ItemDetails": [
      {
        "GoodsId": "GoodsId",
        "GoodsTitle": "GoodsTitle",
        "DeclaredNameEn": "Test",
        "DeclaredNameCn": "品名测试",
        "DeclaredValue": {
          "Code": "USD",
          "Value": 5
        },
        "WeightInKg": 0.6,
        "Quantity": 2,
        "HSCode": "",
        "CaseCode": "",
        "CustomerCaseNo": null,
        "SalesUrl": "http://www.amazon.co.uk/gp/product/B00FEDIPQ4"
      }
    ],
    "TotalValue": {
      "Code": "USD",
      "Value": 10
    },
    "TotalVolume": {
      "Length": 1,
      "Width": 1,
      "Height": 1,
      "Unit": "CM"
    },
    "CheckTotalVolume": null,
    "WithBatteryType": "NOBattery",
    "Notes": "Test",
    "BatchNo": "",
    "WarehouseCode": "SZ",
    "WarehouseName": "深圳",
    "ProcessLocation": "深圳",
    "ShippingMethod": {
      "Code": "3HPA",
      "Name": null,
      "IsTracking": true,
      "IsVolumeWeight": false,
      "MaxVolumeWeightInCm": null,
      "MaxWeightInKg": null,
      "Region": null,
      "Description": null
    },
    "ItemType": "SPX",
    "TradeType": "B2C",
    "DutyPaymentMethod": "DDP",
    "RealShippingMethod": {
      "Code": "3HPA",
      "Name": null,
      "IsTracking": true,
      "IsVolumeWeight": false,
      "MaxVolumeWeightInCm": null,
      "MaxWeightInKg": null,
      "Region": null,
      "Description": null
    },
    "TrackingNumber": "JD0002255030609022",
    "RealTrackingNumber": "",
    "FinalTrackingNumber": "JD0002255030609022",
    "SortCode": "",
    "IsMPS": false,
    "MPSType": null,
    "ShipperInfo": null,
    "TrackingNoProcessResult": {
      "Code": "Success",
      "Message": "",
      "IsVirtual": false
    },
    "IsRemoteArea": false,
    "CreateOn": "2017-08-06T10:07:06.76Z",
    "ArriveOn": null,
    "ReceiveOn": null,
    "ShipOn": null
  },
  "Succeeded": true,
  "Error": null
}

变更记录

2021-07-19

2019-08-21

2016-06-01

2015-06-26

2015-06-06

2015-04-17