ECJiaWiki:Api:express/user/location

来自ECJiaWiki
跳转至: 导航搜索

应用场景

 查看配送员位置

接口名称

 express/user/location

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
订单id order_id int 订单id
配送单id express_id int 配送单id

举例如下

{
      "token":"d122e3c72332c5af12a71d77c9f1462f5901d276",
      "order_id" : 15,
      "express_id":10,
}

返回参数

字段名 变量名 必填 类型 示例值 描述
返回状态码 status Array() {"succeed" : 1} 返回请求接口后的数据,succeed为1代表成功,0则为失败,失败后则返回error_code(错误code)及error_desc(错误说明)
返回信息 data data字典 请求接口提供的返回信息
└ 开始位置信息 from String 开始位置信息
   └ 开始位置 name string 开始位置
   └ 开始位置经纬度信息 location字典 string 开始位置经纬度信息
      └ 维度 lat string 纬度
      └ 经度 lng string 经度
└ 结束位置信息 to String 结束位置信息
   └ 结束位置 name string 结束位置
   └ 结束位置经纬度信息 location location字典 结束位置经纬度信息
      └ 维度 lat string 纬度
      └ 经度 lng string 经度
└ 配送员 express_user string 配送员
└ 配送员电话 express_mobile string 配送员电话
└ 配送员头像 avatar string 配送员头像
└ 配送状态 shipping_status string 配送状态(onShipping配送中,finished已送达)

成功举例如下

{
    "data": {
                "from":{
                         "name":"上海火车站",
                          "location":{
                                 "lat":"39.111094",
                                 "lng":"116.111989"
                           }
                  },
                "to":{
                       "name":"中山北路3553号",
                       "location":{
                              "lat":"39.112073",
                              "lng":"116.112405"
                       }
                 },
                "express_user":"曹可丽",
                "express_mobile":"13468678174",
                "avatar":"https://cityo2o.ecjia.com/content/uploads/merchant/120/data/avatar/38_avatar.png",
                "shipping_status":"finished",
                "label_shipping_status":"您的商品已成功送达"
            },
    "status": {
        "succeed": 1
    }
}

失败举例如下

{
    "status": {
        "succeed": 0,
        "error_code": "invalid_parameter",
        "error_desc": "参数无效"
    }
}

注:错误编码