API 接口文档

Appearance

获取运单提货信息 orderPickup

​

接口说明 ​

通过此接口可获取运单的提货相关信息。

接口地址: http://tms.gateway.sc-express.cn/api/order/pickup

请求方式： POST

请求参数 ​

字段名称字段类型字段长度是否必需字段说明
authorizationJSONObject接口校验信息
codeString5-20Y客户编码
tokenString50YAPI授权码
datasJSONObject
waybillnumberJSONArrayY运单号,最多一次查询20个单号，与系统单号二选一提交即可
systemnumberJSONArrayY系统单号,最多一次查询20个单号，与运单号二选一提交即可

请求报文示例 ​

json
{
    "authorization": {
        "code": "test002",
        "token": "7a6a2c0d-7508-4113-9c64-037f67e7a13c"
    },
    "datas": {
        "waybillnumber": [
            "5722916732",
            "1Z1518YW0326750752",
            "SYS211112000010"
        ]
    }
}
{
    "authorization": {
        "code": "test002",
        "token": "7a6a2c0d-7508-4113-9c64-037f67e7a13c"
    },
    "datas": {
        "waybillnumber": [
            "5722916732",
            "1Z1518YW0326750752",
            "SYS211112000010"
        ]
    }
}

响应数据 ​

字段名称字段类型字段说明
code接口请求是否通过 0：表示接口请求通过，其他表示失败
msg说明信息
dataJSONArray
searchNumber查询的单号
errormsg错误信息，若存在错误则返回
systemnumber系统单号
waybillnumber运单号
customernumber1客户参考号1
pickupnumber提货批号
pickupway提货方式编码
pickupwayname提货方式
driver司机用户ID
drivername司机名称
driverphone司机联系方式
pickupstatus提货状态编码
pickupstatusname提货状态
pickupaddress提货地址
contact联系人
contactphone联系电话
pickuptime提货时间
createdate创建时间

响应数据示例 ​

json
{
    "msg": "success",
    "code": 0,
    "data": [
        {
            "searchNumber": "5722916732",
            "systemnumber": "SYS221114000090",
            "customernumber1": "SYS221114000090",
            "waybillnumber": "5722916732",
            "pickupnumber": "PUK221122000001",
            "pickupway": "smqj",
            "pickupwayname": "上门取件",
            "driver": "nwc",
            "drivername": "小聂同学呀",
            "driverphone": "13926557055",
            "pickupstatus": 1,
            "pickupstatusname": "待确认",
            "pickupaddress": "宝源路名优采购中心",
            "contact": "聂同学",
            "contactphone": "075526499136",
            "pickuptime": "2022-11-22 09:48:43",
            "createdate": "2022-11-22 09:49:50"
        },
        {
            "searchNumber": "1Z1518YW0326750752",
            "errormsg": "暂未设置提货"
        },
        {
            "searchNumber": "SYS211112000010",
            "errormsg": "查询单号不存在"
        }
    ]
}
{
    "msg": "success",
    "code": 0,
    "data": [
        {
            "searchNumber": "5722916732",
            "systemnumber": "SYS221114000090",
            "customernumber1": "SYS221114000090",
            "waybillnumber": "5722916732",
            "pickupnumber": "PUK221122000001",
            "pickupway": "smqj",
            "pickupwayname": "上门取件",
            "driver": "nwc",
            "drivername": "小聂同学呀",
            "driverphone": "13926557055",
            "pickupstatus": 1,
            "pickupstatusname": "待确认",
            "pickupaddress": "宝源路名优采购中心",
            "contact": "聂同学",
            "contactphone": "075526499136",
            "pickuptime": "2022-11-22 09:48:43",
            "createdate": "2022-11-22 09:49:50"
        },
        {
            "searchNumber": "1Z1518YW0326750752",
            "errormsg": "暂未设置提货"
        },
        {
            "searchNumber": "SYS211112000010",
            "errormsg": "查询单号不存在"
        }
    ]
}