文档中心 > API类目 > 五道口API

qimen.alibaba.tcls.aelophy.delivery.query (查询配送订单)

翱象配送运力对接-配送订单查询

公共参数

请求地址：

环境	HTTP请求地址
正式环境	http://qimen.api.taobao.com/router/qm
测试环境	http://qimen.api.taobao.com/router/qmtest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
customerId	String	是	WMS颁发给用户的ID
sign_method	String	是	签名的摘要算法，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
deliveryQueryRequest	DeliveryQueryRequest	必须			配送订单查询入参
└ deliveryNo String 可选 12312312 配送单号 └ merchantCode String 必须 CSSJ 商家编码 └ deliveryShopId String 必须 12312321 isv配送店ID └ orderFrom Number 必须 1 订单来源 └ outOrderId String 必须 123131 外部订单号

响应参数

名称	类型	示例值	描述
deliveryQueryResult	DeliveryQueryResult		配送订单查询返回结果
data DeliverInfos [] 配送订单信息 goodsList GoodInfos [] 货物 └ totalWeight Number 1000 子单总重(g) └ saleQuantity Number 2 销售数量 └ skuName String 测试品商品名称 └ subOrderId String 123123 子单号 └ predictDeliveryTime Number 20 预计配送时长(分钟) └ deliveryDistance Number 1000 配送距离(米) └ deliveryEndTime Number 1642667809000 配送结束时间(毫秒时间戳) └ deliveryStartTime Number 1642667809000 配送开始时间(毫秒时间戳) └ deliveryActualFee Number 800 配送费实际支付(分) └ deliveryDiscountFee Number 100 配送费优惠(分) └ deliveryOriginalFee Number 900 配送费原价(分) └ devliveryStatus String 配送中配送状态 └ deliveryNo String 199511 配送单号 └ outOrderId String 19951123 外部订单号 └ deliveryChannelName String 测试运力平台运力平台名称 └ deliveryChannelCode String csylpt 运力平台编码 receiver ReceiverInfo 收件人信息 └ lng String 168.1.1 收件人坐标-经度（高德坐标） └ lat String 192.0.0 收件人坐标-维度（高德坐标） └ address String 西溪园区B 收件人地址 └ phone String 12345667 收件人手机号 └ name String 张三收件人姓名 └ errCode String 1 调用接口失败返回错误编码 └ errMsg String 1 调用接口失败返回错误信息 └ success Boolean true 调用接口返回成功失败

请求示例

{"deliveryQueryRequest":{"deliveryShopId":"12312321","merchantCode":"CSSJ","outOrderId":"123131","deliveryNo":"12312312","orderFrom":1}}

响应示例

{
    "deliveryQueryResult":{
        "data":[
            {
                    "goodsList":[
                        {
                                "totalWeight":1000,
                                "saleQuantity":2,
                                "skuName":"测试品",
                                "subOrderId":"123123"
                        }
                    ],
                    "predictDeliveryTime":20,
                    "deliveryDistance":1000,
                    "deliveryEndTime":1642667809000,
                    "deliveryStartTime":1642667809000,
                    "deliveryActualFee":800,
                    "deliveryDiscountFee":100,
                    "deliveryOriginalFee":900,
                    "devliveryStatus":"配送中",
                    "deliveryNo":"199511",
                    "outOrderId":"19951123",
                    "deliveryChannelName":"测试运力平台",
                    "deliveryChannelCode":"csylpt",
                    "receiver":{
                        "lng":"168.1.1",
                        "lat":"192.0.0",
                        "address":"西溪园区B",
                        "phone":"12345667",
                        "name":"张三"
                    }
            }
        ],
        "errCode":"1",
        "errMsg":"1",
        "success":true
    }
}

验签示例

{"deliveryQueryResult":{"success":"false","errCode":"sign-check-failure","errMsg":"Illegal request"}}

错误码解释

错误码	错误描述	解决方案

API工具

错误码查询工具 SDK下载

FAQ

有用( 0 ) 我要提问

返回
顶部

淘宝开放平台

五道口API

qimen.alibaba.tcls.aelophy.delivery.query (查询配送订单)

公共参数

请求参数

响应参数

请求示例

响应示例

验签示例

错误码解释

API工具

FAQ