运单数据拉取

接口地址：/openapi/waybill/getWaybillData
请求方式：POST
说明：拉取运单数据，支持按运单号查询或按时间增量拉取。result 为运单对象数组，仅包含下表所列字段；无值字段以 null 返回。

费用字段说明

费用类字段来自拓展表，按运单号关联查询，有记录则返回对应金额，无记录时为 null。

查询条件

主查询条件（三选一）： waybillNo、jyWaybillNo、startTime 必须且只能传入其一。

startTime 按 ES updateTime 增量拉取。

companyWorkNo 使用规则：

与 waybillNo 组合查询时必填
按 jyWaybillNo 查询时可不传，具语单号可单独查
按 startTime 增量拉取时可选，传入则追加公司范围过滤

请求参数

参数名	类型	是否必填	说明
`waybillNo`	String	三选一必填	与 `jyWaybillNo`、`startTime` 三选一，且仅能传 1 个；须与 `companyWorkNo` 组合查询
`jyWaybillNo`	String	三选一必填	与 `waybillNo`、`startTime` 三选一，且仅能传 1 个；可单独查询，无需传 `companyWorkNo`
`startTime`	String	三选一必填	与 `waybillNo`、`jyWaybillNo` 三选一；格式：`yyyy-MM-dd HH:mm:ss`，按 ES `updateTime` 增量拉取
`pageSize`	Integer	否	返回条数，默认 `1000`，最大 `1000`
`openDateTimeStart`	String	否	开单时间起，需与 `openDateTimeEnd` 成对传入
`openDateTimeEnd`	String	否	开单时间止，需与 `openDateTimeStart` 成对传入
`companyWorkNo`	String	按查询方式	公司会员号；`waybillNo` 查询时必填；`jyWaybillNo` 单独查询时可不传；增量拉取时可选
`distributionType`	String	否	配送方式，等值匹配 1、客户自提 2、送货到楼下 3、送货到家 4、送货到家并安装
`sendName`	String	否	发货人姓名前缀匹配

请求示例

按具语单号单独查询：

json

{ "jyWaybillNo": "JY225051200001" }

按运单号 + 公司会员号组合查询：

json

{ "waybillNo": "WB202605120001", "companyWorkNo": "101121" }

按时间增量：

json

{ "startTime": "2026-05-12 00:00:00", "pageSize": 50, "companyWorkNo": "101121" }

响应示例

json

{
  "code": 200,
  "message": "success",
  "result": [
    {
      "busId": "5f4dcc3b5aa765d61d8327deb882cf99",
      "openDateTime": "2026-05-12 10:00:00",
      "status": "待揽收",
      "source": "具语TMS",
      "jyWaybillNo": "JY225051200001",
      "waybillNo": "WB202605120001",
      "electronicWaybillNo": "LP202605120001CN",
      "sourceWaybillNo": "SRC202605120001",
      "sendCompany": "某某物流",
      "companyId": "COMPANY-001",
      "companyWorkNo": "101121",
      "serviceProviderWorkNo": "101122",
      "sendName": "发货人A",
      "receiverName": "收货人B",
      "sendCity": "深圳市",
      "endCity": "上海市",
      "updateTime": "2026-05-12 10:30:00",
      "syncTime": "2026-05-12 10:30:00",
      "trackState": null,
      "signType": null,
      "trunkLineCost": "200.00",
      "branchLineCost": "150.00",
      "installCost": "80.00",
      "otherCost": null,
      "packingCost": null
    }
  ]
}

示例仅展示部分字段；实际响应包含下表全部字段，未赋值项为 null。

响应字段

字段	类型	说明
`code`	Integer	业务状态码，`200` 表示成功
`message`	String	返回消息
`result`	Array	运单数据列表
`result[].busId`	String	业务主键
`result[].openDateTime`	String	开单日期，格式 `yyyy-MM-dd HH:mm:ss`
`result[].status`	String	运单状态
`result[].source`	String	单据来源
`result[].jyWaybillNo`	String	具语运单号
`result[].waybillNo`	String	物流运单号
`result[].electronicWaybillNo`	String	菜鸟电子面单号；无记录时为 `null`
`result[].sourceWaybillNo`	String	来源单号；无记录时为 `null`
`result[].sendCompany`	String	物流公司名称
`result[].companyId`	String	物流公司 id
`result[].companyWorkNo`	String	物流商会员号
`result[].serviceProviderWorkNo`	String	服务商会员号；仅来源为 `具语TMS` 时有值，无记录时为 `null`
`result[].cargoName`	String	货物名称/信息
`result[].cargoPack`	String	货物包装
`result[].cargoPoll`	String	货物票数
`result[].cargoNumber`	String	货物件数
`result[].cargoWeight`	String	货物重量
`result[].cargoVolume`	String	货物体积
`result[].sendName`	String	发货人
`result[].sendMobile`	String	发货人手机
`result[].receiverName`	String	收货人
`result[].receiverMobile`	String	收货人手机
`result[].sendCity`	String	发货地
`result[].sendCityCode`	String	发货地编码
`result[].endCity`	String	收货地
`result[].endCityCode`	String	收货地编码
`result[].receiverAddress`	String	收货地址
`result[].createTime`	String	创建时间
`result[].syncTime`	String	同步时间（ES `syncTime`），增量拉取游标，格式 `yyyy-MM-dd HH:mm:ss`
`result[].updateTime`	String	更新时间（ES `updateTime`），格式 `yyyy-MM-dd HH:mm:ss`
`result[].distributionType`	String	配送方式 1、客户自提 2、送货到楼下 3、送货到家 4、送货到家并安装
`result[].consignorName`	String	货主
`result[].isReceipt`	String	是否回单：`0`-否；`1`-是
`result[].shipperProvince`	String	发货省
`result[].shipperCity`	String	发货市
`result[].shipperDistrict`	String	发货区
`result[].shipperAddress`	String	发货详细地址
`result[].consigneeProvince`	String	收货省
`result[].consigneeCity`	String	收货市
`result[].consigneeDistrict`	String	收货区
`result[].consigneeAddress`	String	收货详细地址
`result[].trackState`	String	最新轨迹状态文案
`result[].trackDate`	String	最新轨迹时间，格式 `yyyy-MM-dd HH:mm:ss`
`result[].totalMoney`	String	总金额
`result[].signType`	Integer	签收状态，取值以业务字典为准
`result[].trunkLineCost`	String	干线费
`result[].branchLineCost`	String	支线费
`result[].upstairsCost`	String	上楼费
`result[].installCost`	String	安装费
`result[].receivingCost`	String	提货费
`result[].loadAndUnloadCost`	String	装卸费
`result[].repairCost`	String	维修费
`result[].serviceCost`	String	服务费
`result[].otherCost`	String	其他费
`result[].discountCost`	String	折让金额
`result[].dismantlingCost`	String	拆卸费
`result[].woodenFrameCost`	String	打木架费
`result[].packingCost`	String	包装费
`result[].superzoneCost`	String	超区费
`result[].excessVolumeCost`	String	超方费
`result[].subscribeStatus`	Integer	订阅状态：`0`-未订阅；`1`-已订阅
`result[].interceptionStatus`	Integer	拦截状态：`1`-未拦截；`2`-已拦截

运单数据拉取 ​

查询条件 ​

请求参数 ​

请求示例 ​

响应示例 ​

响应字段 ​

运单数据拉取

查询条件

请求参数

请求示例

响应示例

响应字段