IconCreated with Sketch.

YAPI 接口文档

YApi
  • 点位管理
    • 查询区域列表
    • 查询点位列表
    • 重置合作商密码
  • 设备管理
    • 查询设备类型
    • 根据售货机编号查询货道列表
    • 货道关联商品
  • 工单管理
    • 取消工单
    • 新增工单
    • 查看工单列表
    • 查看工单补货详情
    • 根据售货机获取维修人员列表
    • 根据售货机获取运营人员列表
  • 商品管理
    • 批量导入
    • 查询商品列表

帝可得

点位管理

查询区域列表

基本信息

Path: /manage/region/list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
pageNum 是 1 当前页
pageSize 是 10 每页个数
name 否 海淀区 区域名称

返回数据

名称类型是否必须默认值备注其他信息
totalnumber必须

mock: 3

rowsobject []必须

item 类型: object

├─ remarkstring必须备注说明
├─ idnumber必须区域ID
├─ namestring必须区域名称
├─ nodeCountnumber必须点位数量
codenumber必须

mock: 200

msgstring必须

mock: 查询成功

查询点位列表

基本信息

Path: /manage/node/list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
pageNum 是 1 当前页
pageSize 是 10 每页个数
name 否 点位名称
regionId 否 区域ID

返回数据

名称类型是否必须默认值备注其他信息
totalnumber必须

mock: 10

rowsobject []必须

item 类型: object

├─ idnumber必须点位ID
├─ namestring必须点位名称
├─ addrstring必须点位地址
├─ areaCodestring必须区域编号
├─ regionIdnumber必须区域ID
├─ regionNamestring必须区域名称
├─ businessIdnumber必须商圈ID
├─ ownerIdnumber必须合作商ID
├─ ownerNamestring必须合作商名称
├─ vmCountnumber必须设备数量
codenumber必须

mock: 查询成功

msgstring必须

mock: 200

重置合作商密码

基本信息

Path: /manage/partner/resetPwd/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 1 合作商ID

返回数据

名称类型是否必须默认值备注其他信息
msgstring必须返回内容

mock: 操作成功

codenumber必须状态码

mock: 200

设备管理

查询设备类型

基本信息

Path: /manage/vmType/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id 设备类型id

返回数据

名称类型是否必须默认值备注其他信息
msgstring非必须
codenumber非必须
dataobject非必须
├─ idnumber非必须
├─ namestring非必须
├─ modelstring非必须
├─ imagestring非必须
├─ vmRownumber非必须货道行数
├─ vmColnumber非必须货道列数
├─ channelMaxCapacitynumber非必须货道容量(个)

根据售货机编号查询货道列表

基本信息

Path: /manage/channel/list/:innerCode

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
innerCode A1000001 设备编号

返回数据

名称类型是否必须默认值备注其他信息
msgstring必须返回内容

mock: 操作成功

codenumber必须状态码

mock: 200

dataobject []必须

item 类型: object

├─ idnumber必须货道ID
├─ channelCodestring必须货道编号
├─ skuIdnumber必须商品ID
├─ innerCodestring必须设备编号
├─ maxCapacitynumber必须最大容量
├─ currentCapacitynumber必须当前容量
├─ skuobject必须商品
├─ skuIdnumber非必须商品ID
├─ skuNamestring非必须商品名称
├─ skuImagestring非必须商品图片

货道关联商品

基本信息

Path: /manage/channel/config

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
innerCodestring必须设备号
channelListobject []必须货道配置集合

item 类型: object

├─ innerCodestring必须设备编号
├─ channelCodestring必须货道编号
├─ skuIdnumber必须商品ID

返回数据

名称类型是否必须默认值备注其他信息
msgstring必须

mock: 操作成功

codenumber必须

mock: 200

工单管理

取消工单

基本信息

Path: /manage/task/cancel

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
taskIdnumber必须工单Id
descstring必须拒绝理由

返回数据

名称类型是否必须默认值备注其他信息
msgstring必须
codenumber必须

新增工单

基本信息

Path: /manage/task

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
createTypenumber必须创建类型,传1
innerCodestring必须设备编号
userIdnumber必须执行人Id
assignorIdnumber非必须指派人Id
productTypeIdnumber必须工单类型Id 1,投放工单 2,补货工单 3,维修工单 4,撤机工单
descstring必须描述信息
detailsobject []非必须补货信息(补货工单才有)

item 类型: object

├─ channelCodestring非必须货道编号
├─ expectCapacitynumber非必须补货数量
├─ skuIdnumber非必须商品Id
├─ skuNamestring非必须商品名称
├─ skuImagestring非必须商品图片

返回数据

名称类型是否必须默认值备注其他信息
msgstring必须
codenumber必须

查看工单列表

基本信息

Path: /manage/task/list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
pageNum 是
pageSize 是
taskCode 否 工单编号
taskStatus 否 工单状态
productTypeId 否 工单类型
params[isRepair] 是 true true 运维工单 false运营工单

返回数据

名称类型是否必须默认值备注其他信息
totalnumber必须
rowsobject []必须

item 类型: object

├─ createTimestring必须
├─ taskIdnumber必须
├─ taskCodestring必须
├─ taskStatusnumber必须
├─ createTypenumber必须
├─ innerCodestring必须
├─ userIdnumber必须
├─ userNamestring必须
├─ regionIdnumber必须
├─ descstring必须
├─ productTypeIdnumber必须
├─ assignorIdnumber必须
├─ addrstring必须
├─ taskTypeobject必须工单类型
├─ typeIdnumber必须
├─ typeNamestring必须
├─ typenumber必须
codenumber必须
msgstring必须

查看工单补货详情

基本信息

Path: /manage/taskDetails/byTaskId/:taskId

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
taskId 工单id

返回数据

名称类型是否必须默认值备注其他信息
msgstring必须
codenumber必须
dataobject []必须

item 类型: object

├─ createTimenull必须
├─ updateTimenull必须
├─ detailsIdnumber必须
├─ taskIdnumber必须
├─ channelCodestring必须
├─ expectCapacitynumber必须
├─ skuIdnull必须
├─ skuNamestring必须
├─ skuImagestring必须

根据售货机获取维修人员列表

基本信息

Path: /manage/emp/operationList/:innerCode

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
innerCode 设备编号

返回数据

名称类型是否必须默认值备注其他信息
msgstring必须
codenumber必须
dataobject []必须

item 类型: object

├─ createBynull必须
├─ createTimenull必须
├─ updateBynull必须
├─ updateTimenull必须
├─ remarknull必须
├─ idnumber必须
├─ userNamestring必须
├─ regionIdnumber必须
├─ regionNamestring必须
├─ roleIdnumber必须
├─ roleCodestring必须
├─ roleNamestring必须
├─ mobilestring必须
├─ imagestring必须
├─ statusnumber必须

根据售货机获取运营人员列表

基本信息

Path: /manage/emp/businessList/:innerCode

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
innerCode 设备编号

返回数据

名称类型是否必须默认值备注其他信息
msgstring必须
codenumber必须
dataobject []必须

item 类型: object

├─ createBynull必须
├─ createTimenull必须
├─ updateBynull必须
├─ updateTimenull必须
├─ remarknull必须
├─ idnumber必须
├─ userNamestring必须
├─ regionIdnumber必须
├─ regionNamestring必须
├─ roleIdnumber必须
├─ roleCodestring必须
├─ roleNamestring必须
├─ mobilestring必须
├─ imagestring必须
├─ statusnumber必须

商品管理

批量导入

基本信息

Path: /manage/sku/import

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type multipart/form-data 是
Authorization Bearer eyJhbGciOiJIUzUxMiJ9.eyJsb2dpbl91c2VyX2tleSI6ImNlNGU5MWZhLTBhYTItNGZjMy05N2E3LThkNTc0ZjczMGNjNyJ9.m8Ez4tmOb-jxAD9lQYFXQdmXUT-beKbrnu7EdqfFF9CUawkAlQsE5wWCYhqVzIVQn0KqrQa2x2o6my94i5UaDA 是 身份令牌

Body

参数名称 参数类型 是否必须 示例 备注
file file 是 excel上传文件

返回数据

名称类型是否必须默认值备注其他信息
msgstring必须操作成功
codenumber必须200

查询商品列表

基本信息

Path: /manage/sku/list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
skuName 否 商品名称
pageIndex 是 1 当前页
pageSize 是 10 每页个数

返回数据

名称类型是否必须默认值备注其他信息
totalnumber非必须
rowsobject []非必须

item 类型: object

├─ skuIdnumber非必须
├─ skuNamestring非必须
├─ skuImagestring非必须
├─ brandNamestring非必须
├─ unitstring非必须
├─ pricenumber非必须
├─ classIdnumber非必须
codenumber非必须
msgstring非必须

Build by YMFE.