文档中心 > API类目 > 千帆计划

qimen.alibaba.ovs.logistic.order.query (物流单查询)

物流单查询

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
request LogisticOrderQueryRequest 必须 请求
  • └ traceId
  • String
  • 必须
  • 43532463424356
  • 平台日志id 用于平台排查问题
  • └ platformOrderIds
  • String []
  • 可选
  • [32342424,5354342,5324356,325352]
  • 业务主键(如平台物流单id)数组 上限20 可指定多个集运单id做查询 如果不指定平台集运单id则可以指定时间区间查询
  • └ pageSize
  • Number
  • 可选
  • 20
  • 页大小
  • └ modifyEndTime
  • Number
  • 可选
  • 1640683589996
  • 集运场景专用,物流商系统内数据被更新的结束时间 时间戳(豪秒)可以按数据更新时间区间分页查询
  • └ modifyBeginTime
  • Number
  • 可选
  • 1640683568946
  • 集运场景专用,物流商系统内数据被更新的开始时间 时间戳(豪秒) 可以按更新时间区间分页查询
  • └ currentPage
  • Number
  • 可选
  • 0
  • 集运场景专用分页查询 当前页
  • └ openUserId
  • String
  • 必须
  • daf242324rr24
  • 平台买家id(已加密 不可逆)
  • └ platformOrderId
  • String
  • 可选
  • 42542324
  • 业务主键 如平台物流单id
  • └ providerUserCode
  • String
  • 可选
  • 857453535
  • 在非集运场景时候使用,物流服务商的用户编码

响应参数

名称 类型 示例值 描述
data LogisticOrderQueryResponse 响应业务参数
  • └ total
  • Number
  • 150
  • 总数
  • orderList
  • OrderList []
  • 物流单列表
  • └ orderId
  • String
  • 53423535
  • 物流商物流单id
  • └ exceptionDesc
  • String
  • -
  • 如状态异常时,填入详细的异常原因
  • └ status
  • String
  • ORDER_RECEIVED
  • 物流单状态 ORDER_RECEIVED(已接单), ORDER_CANCElED(已取消), ORDER_PACKAGE(已打包), ORDER_EXCEPTION(状态异常)
  • └ platformOrderId
  • String
  • 4353353463
  • 业务主键 如平台物流单id
  • packageList
  • LogisticPackage []
  • 集运专用,包裹列表 对应真实待出库包裹 拆包发货时专用
  • └ originPackageMailNos
  • String []
  • 预报单的物流单号数组 ["VL63539882424",""]
  • └ mailNo
  • String
  • VL9847524
  • 物流单号 当使用该字段时,外层的mailNo失效(因为此时是拆包发货,会存在多个物流单号)
  • serviceFulfilResult
  • LogisticServiceFulfilDTO []
  • LogisticServicePerformDTO
  • 集运专用,物流产品履行情况,包括标准物流服务和增值物流服务
  • └ picUrls
  • String []
  • 图片数组 ["url1","url2"]
  • └ remark
  • String
  • -
  • 备注 限长100字符
  • └ serviceCode
  • String
  • VL42
  • 服务code
  • └ mailNo
  • String
  • VL4923475245
  • 物流单号
  • └ mailCompany
  • String
  • -
  • 物流公司
  • └ endMailNo
  • String
  • E4529757724524
  • 集运场景无用,末端物流单号
  • └ endMailCompany
  • String
  • ----
  • 集运场景无用,末端物流公司
  • └ pageSize
  • Number
  • 20
  • 页大小
  • └ currentPage
  • Number
  • 1
  • 当前页
success Boolean true 接口成功失败 true/false
failMessage String 系统异常 错误信息
failCode String 1100 错误码

请求示例

{"request":{"traceId":"43532463424356","platformOrderIds":"[32342424,5354342,5324356,325352]","providerUserCode":"857453535","pageSize":20,"modifyEndTime":0,"modifyBeginTime":0,"currentPage":0,"openUserId":"daf242324rr24","platformOrderId":"42542324"}}

响应示例

{
    "data":{
        "total":150,
        "orderList":[
            {
                    "orderId":"53423535",
                    "exceptionDesc":"-",
                    "status":"ORDER_RECEIVED",
                    "platformOrderId":"4353353463",
                    "packageList":[
                        {,
                                "mailNo":"VL9847524"
                        }
                    ],
                    "serviceFulfilResult":[
                        {,
                                "remark":"-",
                                "serviceCode":"VL42"
                        }
                    ],
                    "mailNo":"VL4923475245",
                    "mailCompany":"-",
                    "endMailNo":"E4529757724524",
                    "endMailCompany":"----"
            }
        ],
        "pageSize":20,
        "currentPage":1
    },
    "success":true,
    "failMessage":"系统异常",
    "failCode":"1100"
}

验签示例

{"success":"false","failCode":"sign-check-failure","failMessage":"Illegal request"}

错误码解释

错误码 错误描述 解决方案

API工具

FAQ

返回
顶部