@lina 2020-09-07T05:55:50.000000Z 字数 16402 阅读 1137

秒达云快递 1.0 后台接口文档

列表项
秒云达 1.0 后台

1、项目约定

1.1 基本约定

1.1.1 API Base Url

【测试url】http://api.volunteer.alpha.flashdiet.cn/api

【线上url】/api

1.1.2 鉴权字段(身份标识)

X-auth-token : [string] 登录后获取的 token 信息, 取window.token 请求头带此字段

X-org-code : [string]https://www.zybuluo.com/mdeditor# 机构表识字段,所有请求均需要此字段，取window.orgCode 请求头带此字段

X-location : [string] 坐标 lng-lat 请求头带此字段

X-unique-key : [string] 服务端下发的标识，取window.uniqueKey 请求头带此字段

X-city : [string] 所在城市名称请求头带此字段

X-platform-code : [string] 平台标识字段,所有请求均需要此字段，取window.platformCode 请求头带此字段

1.1.3 HTTP请求中字段要求

POST请求Content-Type为：Content-Type:application/x-www-form-urlencoded

文件上传时Content-Type为：Content-Type:multipart/form-data

对于：Content-Type:application/json：Content-Type:application/xml不保证完全支持，请谨慎使用

1.2 通用接口

1.2.1 通用接口URL

【线上url】待定

【测试url】http://api.volunteer.alpha.flashdiet.cn/api/

【线上url】/api/

1.2.2 上传图片

通用图片上传文件服务

请求URL

POST
/image

请求参数

file : 文件

响应

{
    error_code: 0,
    data: {
        url: 'http://xxx'
    }
}

url : [string] 文件的访问URL

1.2.3 验证码图片

注：请求图片时，需解析图片的cookie，不然无法认证

GET
/captcha

1.2.4 发送短信

POST
/verifycode

请求参数

captcha_code : [string] 图形验证码

phone : [string] 手机号

响应

{
    error_code: 0,
    data: {
    }
}

1.3 通用响应字段

1.3.1 状态字段

error_code: [int] 服务器状态码，0 为正常状态，异常状态待定。

error_message：[string] 错误信息，但 error_code 不为 0 时返回

1.3.2 数据字段

data: [object] 数据字段，所有响应数据都在此字段中

list: [array]，当返回数据为列表时会将数据放在该字段

1.3.3 分页字段

page: [int] 当前页码，默认为1

total: [int] 总页数

pageSize: [int]
每页数量：本项目常用page_size==10

示例

{
    status: 0,
    msg: '',
    data: {
        list: [{
            key: value
        }],
        total: 23
    }
}

2、数据结构

2.1 常用字段含义

2.1.1 性别字段

sex:[int]

0: 未知
1: 男
2: 女

2.1.2 审核状态

verify_status:[int]

0: 审核中
1: 通过
2: 驳回

2.1.3 是否启用状态

status: [int]

0:未启用
1:启用

2.1.3 订单状态

status: [int]

0:待抢单
1:已抢单
2:已拒绝
3:已完成
4:订单未完成

2.2 核心结构

2.2.1 用户基本信息（v2.0修改）

{
    id: 123,
    nick_name: '梦里花落知多少',
    real_name: 'xx',
    phone: '15500000000',
    sex: 1,
    avatars: 'http://image.com/1.jpeg',
    id_number: 110101198803031321,
    bank_number: '7112312321',
    id_card_front: 'url',
    id_card_back: 'url',
    sign_photo: 'url',
    company_id: 12,
    region_id: 12,
    bus_quarter_id: 23,
    department_id: 12,
    bus_depart_id: 12,
    last_month_income: 0,
    total_income: 0,
    intro_courier_id: 12,
    intro: @用户基本信息
    user_remarks:'银行卡所属分行是 支行是'
}

id: [int] 用户ID

nick_name: [string] 用户名

phone: [string] 用户手机

avatars: [string] 头像

real_name: [string] 姓名

sex: [integer] 性别

id_number: [string] 身份证号

bank_number: [string] 银行卡号

bank_name: [string] 银行名称

id_card_front: [string] 身份证正面照片url

id_card_back: [string] 身份证反面照片url

sign_photo: [string] 签字照片

company_id: [int] 快递公司id

region_id: [int] 大区id

bus_quarter_id: [int] 营业区id

department_id: [int] 分部id，可能为空

bus_depart_id: [int] 营业部id

last_month_income: [int] 上月收入

total_income: [int] 总收入

intro_courier_id: [int] 被推荐人的courier_id

intro: [object] 被推荐人的基本用户信息，可能为空

user_remarks: [string] 用户备注

2.2.2 订单信息

{
    id: 12,
    courier_id: 1232,
    remark: '中关村南大街',
    start_time: '7112312321',
    end_time: 7777.23,
    status: 0,
    company:{
        @快递公司
    },
    region: {
        @大区
    },
    bus_quarter: {
        @营业区
    },
    department: {
        @分部
    },
    bus_depart: {
        @营业部
    }
}

id: [int] 订单ID

courier_id: [string] 快递员用户id

remark: [string] 线路备注

start_time: [date] 开始时间

end_time: [date] 结束时间

status: [integer] 订单状态

company: [obj] 快递公司信息

region: [obj] 大区信息

bus_quarter: [obj] 营业区信息

department: [obj] 分部信息（可能为null）

bus_depart: [obj] 营业部信息

2.2.3 公司、大区、营业区等

公司

{
    id: 12,
    company_name: 1232,
    contact_name: '中关村南大街',
    contact_phone: '7112312321',
    status: 0,
    province_id: 0,
    province_name: 0,
    city_id: 0,
    city_name: 0,
    county_id: 0,
    county_name: 0,
    bus_quarter_num: 12,
    region_num: 123,
    addr: 0,
}

id: [int] 公司ID

company_name: [string] 公司名称

contact_name: [string] 联系人姓名

contact_phone: [string] 联系人电话

status: [int] 启用弃用状态

province_id: [string] 省份id

province_name: [string] 省份名称

city_id: [string] 城市id

city_name: [string] 城市名称

county_id: [string] 区县id

county_name: [string] 区县名称

addr: [string] 具体地址

bus_quarter_num: [int] 营业区数量

region_num: [int] 大区数量

其他的看数据库吧，就不一一写出来，字段基本都一样的

2.2.4 分部和营业部

分部相对于公司等，多个一个后台管理用户对象

{
    id: 12,
    department_name: 1232,
    contact_name: '中关村南大街',
    contact_phone: '7112312321',
    status: 0,
    province_id: 0,
    province_name: 0,
    city_id: 0,
    city_name: 0,
    county_id: 0,
    county_name: 0,
    addr: 0,
    user: {
        username: 'xxx'
    }
}

id: [int] 分部ID

department_name: [string] 分部名称

contact_name: [string] 联系人姓名

contact_phone: [string] 联系人电话

status: [int] 启用弃用状态

province_id: [string] 省份id

province_name: [string] 省份名称

city_id: [string] 城市id

city_name: [string] 城市名称

county_id: [string] 区县id

county_name: [string] 区县名称

addr: [string] 具体地址

user: [obj] 后台管理对象

营业部就不列出来，字段基本都一样的

2.2.5 路径信息（v2.0新增）

{
    id: 12,
    company_id: 1232,
    region_id: 12,
    bus_quarter_id: 12,
    department_id: 0,
    bus_depart_id: 12,
    route: "路径1",
    status: 1,
}

id: [int] 分部ID

route: [string] 路径名称（长度最大256）

status: [int] 0 禁用 1 启用

2.2.6 财务信息（v3.0新增）

{
    liability_compensation:有责赔偿
    platform_award: 平台奖励,
}

liability_compensation: [string] 有责赔偿

platform_award: [string] 平台奖励

2.2.7 后台用户注册信息（v3.0新增）

{
    company:公司名称
    contact_name: 联系人
    contact_phone: 联系人电话
    business: 主营业务
    courier_num: 合作伙伴人数
}

3、接口列表

3.1 合作伙伴类接口

3.1.1 合作伙伴列表

请求URL

GET
/courier

请求参数

keyword: [string] 关键字搜索姓名、联系电话、证件号码【非必填】

verify_status: [int] 审核状态搜索【非必填】

page: [string] 当前页数【必填】

pageSize: [string] 每页数量【非必填】

begin_time: [date] 用户注册起时间【非必填】

end_time: [date] 用户注册止时间【非必填】

pass_begin_time: [date] 审核通过起时间【非必填】

pass_end_time: [date] 审核通过止时间【非必填】

响应

{
    "status": 0,
    "msg": "",
    "data":{
        list: [
            @用户基本信息
        ],
        total: 122 // 总数
    }
}

3.1.2 合作伙伴编辑

请求URL

PUT
/courier/${courier_id}

请求参数
手机号不可编辑

real_name: [string] 真实姓名【必填】

courier_id: [int] 合作伙伴id 【必填】

bank_num: [string] 银行卡号【必填】

bank_name: [string] 银行名称【必填】

id_card_front: [string] 身份证正面照片url【必填】

id_card_back: [string] 身份证反面照片url【必填】

sign_photo: [string] 签字照片【必填】

company_id: [int] 快递公司id【必填】

region_id: [int] 大区id【必填】

bus_quarter_id: [int] 营业区id【必填】

bus_depart_id: [int] 营业部id【必填】

verify_status: [int] 状态更新【非必填】

响应

{
    "status": 0,
    "msg": "保存成功",
    "data": null
}

3.1.3 合作伙伴信息接口

请求URL

GET
/courier/${courier_id}

请求参数

无

响应

{
    "status": 0,
    "msg": "保存成功",
    "data": {
        @用户基本信息
    }
}

3.1.4 邀请合作伙伴

请求URL

POST
/courier/invite

请求参数

phone_arr: [array] 邀请的手机号列表【必填】

响应

{
    "status": 0,
    "data":{
        phone_suc: [], // 邀请成功的手机号列表
        phone_fail: [] // 邀请失败手机号列表
    },
    "msg": ""
}

3.1.5 删除合作伙伴（v2.0新增）

请求URL

delete
/courier/id

id为合作伙伴id，只有状态处于禁用的才能删除成功，否则提示‘删除失败，启用时不能进行删除操作’

请求参数

无

{
    "status": 0,
    "data": null,
    "msg": "删除成功"
}

3.1.6 推荐列表（v2.0新增）

请求URL

get
/courier/{id}/introduce

请求参数

id为合作伙伴id

{
    "status": 0,
    "data": [
       @邀请人用户信息
    ],
    "msg": ""
}

3.1.7 合作伙伴不通过接口

请求URL

put
/courier/reject/{id}

请求参数

id: [int] 合作伙伴id 【必填】

reason: [string] 拒绝理由【必填】

响应

{
    "status": 0,
    "msg": "保存成功",
    "data": null
}

3.1.8 合作伙伴零钱提现记录接口

请求URL

get
/courier/id/bonus

请求参数

id: [int] 合作伙伴id 【必填】

响应

{
    "status": 0,
    "msg": "",
    "data": [
       @提现记录,
    ],
}

3.1.9 合作伙伴批量修改状态

请求URL

post
/courier/display

请求参数

file [string] 文件

响应

{
    "status": 0,
    "msg": "修改成功",
    "data": null
}

3.2.0 合作伙伴详情导出协议签名

请求URL

get
/courier/agreement/{id}

请求参数

id [int] 用户id

响应

{id}.pdf  [pdf]  文件

3.2 公司接口

3.2.1 公司列表接口

请求URL

GET
/company

请求参数

keyword: [string] 关键字搜索姓名、联系电话、证件号码【非必填】

page: [string] 当前页数【必填】

pageSize: [string] 每页数量【非必填】

响应

{
    "status": 0,
    "msg": "",
    "data":{
        list: [
            @公司信息
        ],
        total: 123
    }
}

3.2.2 公司新建

请求URL

POST
/company

请求参数

@公司基本数据，不包含统计的大区数、营业区数

low_password [string] 低权用户密码

low_username [string] 低权用户

响应

{
    "status": 0,
    "msg": "新建成功",
    "data": null
}

3.2.3 公司编辑（启用弃用也用这个接口）

请求URL

PUT
/company/${company_id}

请求参数

@公司基本数据

响应

{
    "status": 0,
    "msg": "保存成功",
    "data": null
}

3.2.4 公司信息接口

请求URL

GET
/company/${company_id}

请求参数

无

响应

{
    "status": 0,
    "msg": "保存成功",
    "data": {
        @公司信息
    }
}

3.3 大区营业区接口和公司类似

url中把company改成region、bus_quarter

3.3 分部相关接口

3.3.1 分部列表接口

请求URL

GET
/department

请求参数

无

响应

{
    "status": 0,
    "msg": "",
    "data":{
        list: [
            @分部信息
        ],
        pagination: {
            @分页
        }
    }
}

3.3.2 分部新建

请求URL

POST
/department

请求参数

@分部基本数据

password [string] 密码

响应

{
    "status": 0,
    "msg": "新建成功",
    "data": null
}

3.3.3 分部编辑（启用弃用也用这个接口）

请求URL

PUT
/department/${department_id}

请求参数

@分部基本数据

响应

{
    "status": 0,
    "msg": "保存成功",
    "data": null
}

3.3.4 分部信息接口

请求URL

GET
/department/${department_id}

请求参数

无

响应

{
    "status": 0,
    "msg": "保存成功",
    "data": {
        @分部信息
    }
}

3.4 订单相关接口

3.4.1 订单列表接口

请求URL

GET
/order

请求参数

status [int] 根据订单状态筛选

响应

{
    "status": 0,
    "msg": "",
    "data":{
        list: [
            @订单信息
        ],
        pagination: {
            @分页
        }
    }
}

3.4.2 订单新建

请求URL

POST
/order

请求参数

@订单数据

响应

{
    "status": 0,
    "msg": "新建成功",
    "data": null
}

3.4.3 订单编辑

请求URL

PUT
/order/${order_id}

请求参数

@订单数据

响应

{
    "status": 0,
    "msg": "保存成功",
    "data": null
}

3.4.4 订单信息接口

请求URL

GET
/order/${order_id}

请求参数

无

响应

{
    "status": 0,
    "msg": "保存成功",
    "data": {
        @订单信息
    }
}

3.4.5 批量添加订单（v2.0新增）

请求URL

POST
/order/batch_add

请求参数

[{
"courier_id": 40,
"company_id": 11,
"region_id": 18,
"bus_quarter_id": 12,
"department_id": null,
"bus_depart_id": 18,
"start_time": 1542819000, #时间戳（秒）
"end_time": 1542821000,#时间戳（秒）
"route": "sss",
"route_id": 12 #所选的路径id
}]

3.4.6 批量修改订单状态（v2.0新增）

请求URL

PUT
/order_status/import

订单模板的地址/orderStatusTemplate.xlsx，具体前端怎么弄，可以参考财务导入

请求参数

file: [string] Excel路径，参考财务导入

order_date: [string] 订单日期Y-m-d的格式

响应

{
    "status": 0,
    "msg": "",
    "data": {
        "skip": 0,
        "error": [],
        "suc": [
            "362302199509201232"
        ]
    }
}

3.5 财务相关接口

3.5.1 财务列表接口

请求URL

GET
/income

请求参数

status [int] 根据当月是否申请提现状态筛选

month_time [date] 订单完成日期

start_month [date] 订单完成起日期

end_month [date] 订单完成止日期

响应

{
    "status": 0,
    "msg": "",
    "data":{
        list: [
            @财务信息
        ],
        pagination: {
            @分页
        }
    }
}

3.5.2 财务导入

请求URL

POST
/income/import

请求参数

file [string] 文件路径

响应

{
    "status": 0,
    "msg": "导入成功",
    "data": {
        skipNum: 12,  // 累计跳过多少条记录
        saveNum: 8,  // 导入成功多少条记录
        errors: [] // 错误数据列表
    }
}

3.5.3 余额待提现提醒

请求URL

GET
/courier/notice

请求参数

无

响应

{
    "status": 0,
    "msg": "发送成功",
    "data": null
}

3.6 所有公司、大区、营业区接口

请求URL

GET
/dict/company
/dict/region?company_id=1
/dict/bus_quarter?company_id=1&region_id=1
/dict/bus_depart?company_id=1&region_id=1&bus_quarter_id=1

请求参数

分别获取公司、大区、营业部、营业区，需要带上各自参数

响应

{
    "error_code": 0,
    "data":[
        @公司、大区、营业部、营业区
    ],
    "error_message": ""
}

3.7 路径设置（v2.0新增）

3.7.1 路径列表

请求URL

get
/route

请求参数

无

{
    "status": 0,
    "data": [
        @路径信息
    ],
    "msg": ""
}

3.7.2 新增路径

请求URL

post
/route

请求参数

@路径的信息

分部管理员不需要传company_id等上级id
营业部管理员只需要传route信息

{
    "status": 0,
    "data": [
        @路径信息
    ],
    "msg": ""
}

3.7.3 编辑路径（启用禁用接口也用这个）

请求URL

put
/route/id

id为路径主键

请求参数

@路径信息

分部管理员不需要传company_id等上级id
营业部管理员只需要传route信息

{
    "status": 0,
    "data": null,
    "msg": "修改成功"
}

3.7.4 删除路径

请求URL

delete
/route/id

id为路径主键

请求参数

无

{
    "status": 0,
    "data": null,
    "msg": "删除成功"
}

3.8 列表导出

在公司、大区、营业区、分部、营业部、合作伙伴、路径列表接口中携带参数asExcel=1即可，例如导出公司的接口为/api/company?asExcel=1

3.9 批量导入包裹批次接口

请求URL

post
/route/batch

请求参数

file [string] 文件

company_id [int] 事业部id

region_id [int] 大区id

bus_quarter_id [int] 营业区id

bus_depart_id [int] 营业部id

响应

{
    "status": 0,
    "msg": "导入成功",
    "data": {
        skipNum: 12,  // 累计跳过多少条记录
        saveNum: 8,  // 导入成功多少条记录
        errors: [] // 错误数据列表
    }
}

3.10 后台用户注册类接口

3.10.1 注册信息提交

请求URL

post
/register

请求参数

company [string] 公司名称

contact_name [string] 联系人

contact_phone [string] 联系人电话

business [string] 主营业务

courier_num [int] 合作伙伴人数

{
    "status": 0,
    "data": null,
    "msg": "注册成功"
}

3.10.2 注册信息列表

请求URL

get
/register

请求参数

无

{
    "status": 0,
    "data": [
        @用户信息
    ],
    "msg": ""
}

3.11 设置签到半径（8月6日新增）

3.11.1 设置签到半径（只有admin才可以设置）

请求URL

post
/checkin/setting

请求参数

radius [number] 单位km

响应

{
    "status": 0,
    "msg": "导入成功",
    "data": {
        skipNum: 12,  // 累计跳过多少条记录
        saveNum: 8,  // 导入成功多少条记录
        errors: [] // 错误数据列表
    }
}

3.11.2 获取设置的签到半径（只有admin才可以设置）

请求URL

get
/checkin/setting

请求参数

无

响应

{
    "status": 0,
    "msg": "导入成功",
    "data": {
        "radius": 2.2
    }
}

3.11.3 获取法大大身份证照片（原来的身份证图片不需要上传了）

根据courier中下发的fdd_head_photo来获取具体的图片，

GET
/fdd_head_photo/{uuid}

请求参数

uuid : [string] 根据courier中下发的fdd_head_photo

返回图片

3.11.4 courier的注册时间改用pass_time字段

pass_time字段，审核通过的时间

快递员添加bus_type字段（必填）

bus_type字段表示业务类型，为int类型

3.12 红包相关接口（2020-05-10新增）

3.12.1 红包列表和导出

请求URL

GET
/wechatPayment

请求参数

keyword [string] 关键字搜索

startDate [date] 日期

endDate [date] 日期

asExcel [int] 为1表示导出

company_id 等字段筛选

响应

{
    "status": 0,
    "msg": "",
    "data":{
        total: 100,
        list: [
            {
             "id": 57690,
                "courier_id": 8795,
                "real_name": "", // 姓名看courier对象里的
                "openid": "",
                "amount": "1.20",
                "partner_trade_no": "13",
                "payment_no": "234", // -1表示手工导入，否则是微信提现
                "payment_time": "2012-02-02 00:12:12", // 提现时间
                "device_info": null,
                "return_code": "SUCCESS",
                "err_code": null,
                "err_code_des": null,
                "result_code": "SUCCESS",
                "return_msg": null,
                "created_at": "2020-05-10 13:11:26",
                "updated_at": "2020-05-10 13:11:26",
                "courier": {
                    "id": 8795,
                    "nick_name": "test",
                    "real_name": "123",
                }
            }
        ],
    }
}

3.12.2 红包提现导入

请求URL

POST
/wechatPayment/import

请求参数

file [string] 文件路径

响应

{
    "status": 0,
    "msg": "导入成功",
    "data": {
        skipNum: 12,  // 累计跳过多少条记录
        saveNum: 8,  // 导入成功多少条记录
        errors: [
            {
                year: 2010,
                month: 12,
                day: 10,
                amount: 120,
                id_number: 123123, // 身份证
                error_msg: "错误xinxi“”",
            }
        ] // 错误数据列表
    }
}

3.12.3 提现列表（小程序接口）

请求URL

GET
/wechatPayment

请求参数

token [string] 请求头带上

pageSize: [int] 分页大小

page: [int] 当前页数

响应

{
    "status": 0,
    "msg": "",
    "data":{
        total: 100,
        list: [{
        // 同3.12.1
        }]
    }
}

3.13 后台提现接口（2020-07-18新增）

3.13.1 提现列表和导出

请求URL

GET
/user_income

请求参数

startDate [date] 日期

endDate [date] 日期

asExcel [int] 为1表示导出

company_id 等字段筛选

real_name 姓名

phone 电话搜索

响应

{
    "status": 0,
    "msg": "",
    "data":{
        total: 100,
        list: [
        {
            'real_name',
            'courier_id',
            'income_date',
            'withdraw_amt',
            'draw_date': '2010-01-10',
            'draw_time': '12:12:12',
            'fee_type': '',
            'bus_require': '',
            'courier': {用户信息} 
            }
        ]
    }
}

3.13.2 提现导入

请求URL

POST
/user_income/import

请求参数

file [str] 文件

{
    "status": 0,
    "msg": "",
    "data": null
}

3.13.3 提现单导出

请求URL

get
/user_income/export

请求参数

startDate [date] 日期

endDate [date] 日期

asExcel [int] 为1表示导出

company_id 等字段筛选

real_name 姓名

phone 电话搜索

pdf

4、通达云接口

4.1 司机类需求（2020/06/15新增）

4.1.1 合作伙伴

禁用操作添加reject_time字段，表示禁用时间
业务类型在原有的快递业务基础上，新增司机业务，即0 快递业务， 1 司机业务

4.1.2 司机接单状态

courier表新增以下几个字段
1. accept_order_status 接单状态： 0 不接单 1 正在接单 2订单执行中
2. start_order_time 开始接单时间
3. stop_order_time 停止接单时间
司机最新状态接口同快递员接口（只需要传bus_type=1，表示司机的），新增查询字段: accept_order_status接单状态查询传0,1,2

4.1.3 快递员收入统计

请求URL

GET
/courier_income_sts

请求参数

pageSize: [int] 分页大小

page: [int] 当前页数

startTime: [date] 筛选开始日期

endTime: [date] 筛选结束

customer_id: [str] 用户编号

real_name: [str] 真实姓名

canWithdraw: [int] 传1表示可生成提现单用户

asExcel: [int] 传1导出Excel

id_number : [string] 身份证号

响应

{
    "status": 0,
    "msg": "",
    "data":{
        total: 100,
        list: [{
            not_withdrawal: "8.00",  // 不可提现金额
            can_withdrawal: "16.00", // 可提现金额
            have_withdrawal: "0.00", // 已提现金额
            total_amt: 12,           // 总金额(不可提现+可提现+已提现)
            courier: {
                // 快递员信息
            }
        }]
    }
}

4.1.4 司机收入统计

请求URL

GET
/driver_income_sts

请求参数

pageSize: [int] 分页大小

page: [int] 当前页数

startTime: [date] 筛选开始日期

endTime: [date] 筛选结束

real_name: [str] 真实姓名

canWithdraw: [int] 传1表示可生成提现单用户

asExcel: [int] 传1导出Excel

id_number: [string] 身份证号

响应

{
    "status": 0,
    "msg": "",
    "data":{
        total: 100,
        list: [{
            not_withdrawal  => 1,// 不可体现金额
            can_withdrawal  => 2,// 可体现金额
            have_withdrawal => 9,// 已体现金额
            total_amt: 12,// 总金额（不可体现+可体现+已体现）
            courier: {
                // 快递员信息
            }
        }]
    }
}

4.1.5 快递员收入统计-批量生成提现单

请求URL

post
/user_income/withdraw

请求参数

startTime: [date] 筛选开始日期

endTime: [date] 筛选结束

ids: [str] 提现用户id,用逗号分隔

withdraw_date: [date] 提现日期

bus_type: [str] 0 快递批量提现， 1 司机司机快递提现

响应

{
    "status": 0,
    "msg": "",
    "data":null
}

4.1.6 司机收入统计-批量生成提现单

同4.1.5

4.1.7 快递员单日收入统计-批量修改状态

t_income_daily_sts表status字段调整为： -1 初始状态 0 可以提现 1 已提现（原来只有0和1的）
单日收入统计status默认初始化为-1

请求URL

put
/t_income_sts/{id}/status

列表下发的id ，用逗号分隔，只能选择非已提现状态的

请求参数

status: [int] -1 初始状态 0 可以提现，

响应

{
    "status": 0,
    "msg": "",
    "data": null
}

4.1.8 司机财务列表

请求URL

GET
/d_income

请求参数

pageSize: [int] 分页大小

page: [int] 当前页数

start_date: [date] 筛选开始日期

end_date: [date] 筛选结束

real_name: [str] 真实姓名

phone: [str] 手机号

status: [int] 当前财务状态 -1 初始状态 0 可以提现 1 已提现

asExcel: [int] 传1导出Excel

响应

{
    "status": 0,
    "msg": "",
    "data":{
        total: 100,
        list: [{
            "d_id": 12313213, // 唯一的标识
             "name":  "张三",  //司机姓名
             "number_id":  "392938232",  //驾驶证号（身份证号）
             "mileage_allowance":  12,  //里程补贴
             "total_mileage_allowance":  272,  //里程总补贴
             "back_tracking":  "返程",  //是否返程
             "batch_id": "D392832392929", // 批次号
             "plate_number":  "京D12312",  //车牌号
             "car_model":  "小型车辆",  //车辆类型
             "path_name":  "线路名称",  //线路名称
             "departure_time": "2019-10-13 13:23:23", // 计划发车时间
             "arrival_time": "2019-10-13 13:23:23", // 实际到达时间
             "total_mileage":  12,  //总里程
             "path_mileage":  12,  //线路里程
             platform_award: 123,// 奖励
             liability_compensation: 123, //  有责赔偿
             status: 1, //当前财务状态-1 初始状态 0 可以提现 1 已提现
            courier: {
                // 快递员信息
            }
        }]
    }
}

4.1.7 司机财务列表-批量修改状态

请求URL

put
/d_income/{id}/status

列表下发的id ，用逗号分隔，只能选择非已提现状态的

请求参数

status: [int] -1 初始状态 0 可以提现

响应

{
    "status": 0,
    "msg": "",
    "data": null
}

4.1.8 司机财务列表-导入奖惩数据

请求URL

put
/d_income/import

修改导出的奖惩数据

请求参数

file: [file] 文件

响应

{
    "status": 0,
    "msg": "",
    "data": null
}

4.1.9 小程序接口 - 修改接单状态

请求URL

put
/courier/accept_status

请求头带上token

请求参数

accept_order_status: [int] 接单状态： 0 不接单 1 正在接单

响应

{
    "status": 0,
    "msg": "",
    "data": null
}

5、秒达云接口（2020/08/04新增）

5.1 合作伙伴编辑

请求URL

PUT
/courier/${courier_id}

请求参数
手机号不可编辑

real_name: [string] 真实姓名【必填】

courier_id: [int] 合作伙伴id 【必填】

bank_num: [string] 银行卡号【必填】

bank_name: [string] 银行名称【必填】

id_card_front: [string] 身份证正面照片url【必填】

id_card_back: [string] 身份证反面照片url【必填】

sign_photo: [string] 签字照片【必填】

company_id: [int] 快递公司id【必填】

region_id: [int] 大区id【必填】

bus_quarter_id: [int] 营业区id【必填】

bus_depart_id: [int] 营业部id【必填】

verify_status: [int] 状态更新【非必填】

id_card_issue_day: [string] 身份证签发日期

id_card_validity_day: [string] 身份证有效期结束日期
响应

{
    "status": 0,
    "msg": "保存成功",
    "data": null
}

5.2 批量修改订单为已完成状态

描述：
在excel中的用户修改为已完成，其他修改为订单未完成
请求URL

PUT
/order_status/import

订单模板的地址/orderStatusTemplate.xlsx，具体前端怎么弄，可以参考财务导入

请求参数

file: [string] Excel路径，参考财务导入

day: [string] 订单日期2020-02-02的格式

响应

{
    "status": 0,
    "msg": "",
    "data": {
        "skip": 0, //跳过的数量，通常为身份证号错误
        "error": [],
        "suc": [
            "362302199509201232"
        ]
    }
}

6、货达人接口（2020/09/07新增）

6.1 财务列表（单日收入统计）

描述 : 每个人每天的收入统计

GET
/income

请求参数

keyword: [string] 用户名称|身份证号|手机号

start_month: [string] 开始时间

end_month: [string] 结束时间

status: [int] 提现状态

pageSize: [int] 每页条数

page: [int] 页码

asExcel: [int] 传1导出Excel

响应

{
    "status": 0,
    "msg": "",
    "data": {
        "list": [
            {
                "id": 1,
                "status": -1, // 提现状态
                "remark": "", // 备注
                "courier": {
                   // 个人信息
                }
            }
        ],
        "total": 1
    }
}

6.2 改变提现状态（单日收入统计）

描述 : 每个人每天的收入统计

GET
/income/{id}/status

请求参数

ids: [string] 编号，以逗号分隔

status: [int] 提现状态 -1 不可提现 0 可提现

响应

{
    "status": 0,
    "msg": "",
    "data": null
}

6.3 收入统计

请求URL

GET
/income_sts

请求参数

pageSize: [int] 分页大小

page: [int] 当前页数

startTime: [date] 筛选开始日期

endTime: [date] 筛选结束

customer_id: [str] 用户编号

real_name: [str] 真实姓名

canWithdraw: [int] 传1表示可生成提现单用户

asExcel: [int] 传1导出Excel

id_number : [string] 身份证号

响应

{
    "status": 0,
    "msg": "",
    "data":{
        total: 100,
        list: [{
            not_withdrawal: "8.00",  // 不可提现金额
            can_withdrawal: "16.00", // 可提现金额
            have_withdrawal: "0.00", // 已提现金额
            total_amt: 12,           // 总金额(不可提现+可提现+已提现)
            courier: {
                // 用户信息
            }
        }]
    }
}

6.4 收入统计-批量生成提现单

请求URL

post
/user_income/withdraw

请求参数

startTime: [date] 筛选开始日期

endTime: [date] 筛选结束

ids: [str] 提现用户id,用逗号分隔

withdraw_date: [date] 提现日期

响应

{
    "status": 0,
    "msg": "",
    "data":null
}

6.5 提现单-列表

请求URL

GET
/user_income

请求参数

startDate [date] 开始日期

endDate [date] 结束日期

asExcel [int] 为1表示导出

company_id [int] 用户编号

real_name [string] 姓名

phone [int] 电话搜索

id_number [string] 身份证号

响应

{
    "status": 0,
    "msg": "",
    "data":{
        total: 100,
        list: [
        {
            'real_name',
            'courier_id',
            'income_date',
            'withdraw_amt',
            'draw_date': '2010-01-10',
            'draw_time': '12:12:12',
            'bus_require': '',
            'courier': {用户信息} 
            }
        ]
    }
}

秒达云快递 1.0 后台接口文档

1、项目约定

1.1 基本约定

1.1.1 API Base Url

1.1.2 鉴权字段(身份标识)

1.1.3 HTTP请求中字段要求

1.2 通用接口

1.2.1 通用接口URL

1.2.2 上传图片

1.2.3 验证码图片

1.2.4 发送短信

1.3 通用响应字段

1.3.1 状态字段

1.3.2 数据字段

1.3.3 分页字段

2、数据结构

2.1 常用字段含义

2.1.1 性别字段

2.1.2 审核状态

2.1.3 是否启用状态

2.1.3 订单状态

2.2 核心结构

2.2.1 用户基本信息 （v2.0修改）

2.2.2 订单信息

2.2.3 公司、大区、营业区等

2.2.4 分部和营业部

2.2.5 路径信息（v2.0新增）

2.2.6 财务信息（v3.0新增）

2.2.7 后台用户注册信息（v3.0新增）

3、接口列表

3.1 合作伙伴类接口

3.1.1 合作伙伴列表

3.1.2 合作伙伴编辑

3.1.3 合作伙伴信息接口

3.1.4 邀请合作伙伴

3.1.5 删除合作伙伴 （v2.0新增）

3.1.6 推荐列表（v2.0新增）

3.1.7 合作伙伴不通过接口

3.1.8 合作伙伴零钱提现记录接口

3.1.9 合作伙伴批量修改状态

3.2.0 合作伙伴详情导出协议签名

3.2 公司接口

3.2.1 公司列表接口

3.2.2 公司新建

3.2.3 公司编辑（启用弃用也用这个接口）

3.2.4 公司信息接口

3.3 大区营业区接口和公司类似

3.3 分部相关接口

3.3.1 分部列表接口

3.3.2 分部新建

3.3.3 分部编辑（启用弃用也用这个接口）

3.3.4 分部信息接口

3.4 订单相关接口

3.4.1 订单列表接口

3.4.2 订单新建

3.4.3 订单编辑

3.4.4 订单信息接口

3.4.5 批量添加订单（v2.0新增）

3.4.6 批量修改订单状态（v2.0新增）

3.5 财务相关接口

3.5.1 财务列表接口

3.5.2 财务导入

3.5.3 余额待提现提醒

3.6 所有公司、大区、营业区接口

3.7 路径设置（v2.0新增）

3.7.1 路径列表

3.7.2 新增路径

3.7.3 编辑路径（启用禁用接口也用这个）

3.7.4 删除路径

3.8 列表导出

3.9 批量导入包裹批次接口

3.10 后台用户注册类接口

3.10.1 注册信息提交

3.10.2 注册信息列表

3.11 设置签到半径（8月6日新增）

3.11.1 设置签到半径（只有admin才可以设置）

3.11.2 获取设置的签到半径（只有admin才可以设置）

3.11.3 获取法大大身份证照片（原来的身份证图片不需要上传了）

3.11.4 courier的注册时间改用pass_time字段

3.12 红包相关接口（2020-05-10新增）

2.2.1 用户基本信息（v2.0修改）

3.1.5 删除合作伙伴（v2.0新增）