ECJiaWiki:Api:admin/express/staff/online

来自ECJiaWiki
跳转至: 导航搜索

应用场景

 掌柜指派订单获取在线配送员列表

接口名称

 admin/express/staff/online

Header请求参数

字段名 变量名 必填 类型 示例值 描述 since deprecated
设备唯一ID device-udid String a46d663d675d4858ea7d0a21c2de06e9 设备的唯一编号 1.3.0
设备客户端类型 device-client String android,iphone,h5,weapp 设备类型的描述 1.3.0
产品编号 device-code String 6015 产品编号 1.3.0
API版本 api-version String 1.6 API接口版本号 1.3.0

举例如下

{
    "device-udid" : "a46d663d675d4858ea7d0a21c2de06e9",
    "device-client" : "weapp",
    "device-code " : "6015",
    "api-version" : "1.6",
}

请求参数

字段名 变量名 必填 类型 示例值 描述
token token String d122e3c72332c5af12a71d77c9f1462f5901d276 token
分页信息 pagination pagination字典 分页信息
└ 每页显示条数 count Int 每页显示条数
└ 当前页数 page Int 当前页数
配送单id express_id int 配送单id
关键字 keywords string 关键字

举例如下

{
      "token" : "d122e3c72332c5af12a71d77c9f1462f5901d276",
      "express_id":1,
       "pagination" : {
    	   "count" : 10,
    	   "page" : 1
      },
}

返回参数

字段名 变量名 必填 类型 示例值 描述
返回状态码 status Json {"succeed" : 1} 返回请求接口后的数据,succeed为1代表成功,0则为失败,失败后则返回error_code(错误code)及error_desc(错误说明)
返回信息 data Array() 请求接口提供的返回信息
└ 配送员id staff_id int 配送员id
└ 配送员名称 staff_name String 配送员名称
└ 头像 avatar String 头像
└ 电话 mobile String 电话
└ 待取货订单数 wait_count int 待取货订单数
└ 配送中订单数 sending_count int 配送中订单数
└ 配送员与订单间距离 distance int 配送员与订单间距离

成功举例如下

{ 
      "data": [{
            "staff_id":1,
            "staff_name" : "配送员1号",
            "avatar":"http://www.yinuopai.com/content/apps/express/statics/images/touxiang.png",
            "mobile" : "13468678174",
            "wait_count":2,
            "sending_count":3,
            "distance":13510
      }],
      "status": {
            "succeed": 1
      },
     "paginated": {
        "total": 38,
        "count": 38,
        "more": 0
    }
}

失败举例如下

{
      "status" : {
            "succeed" : 0,
            "error_code" : 100,
            "error_desc" : "Invalid session",
      }
}

注:错误编码