Files
jx-callback/swagger/swagger.yml
2025-11-21 09:13:51 +08:00

3946 lines
100 KiB
YAML
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
swagger: "2.0"
info:
title: web Test API
description: web has a very cool tools to autogenerate documents for your API
version: 1.0.0
termsOfService: http://web.me/
contact:
email: astaxie@gmail.com
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
basePath: /v2
paths:
/auth2/AddAuthBind:
post:
tags:
- auth2
description: 绑定认证方式
operationId: Auth2Controller.绑定认证方式
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: formData
name: authToken
description: 之前通过login得到的新认证TOKEN
required: true
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/auth2/AddAuthBindWithMobile:
post:
tags:
- auth2
description: 绑定认证方式
operationId: Auth2Controller.绑定认证方式
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: formData
name: authToken
description: 之前通过login得到的新认证TOKEN
required: true
type: string
- in: formData
name: mobile
description: 之前通过getuserbyminiinfo得到的
required: true
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/auth2/ChangePassword:
put:
tags:
- auth2
description: 修改(或初始化)密码
operationId: Auth2Controller.修改(或初始化)密码
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: query
name: oldPwd
description: 原密码md5如果是重置或新设为空
type: string
- in: query
name: newPwd
description: 新密码md5
required: true
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/auth2/CreateCaptcha:
post:
tags:
- auth2
description: 生成captcha
operationId: Auth2Controller.生成captcha
parameters:
- in: formData
name: width
description: 图片宽
required: true
type: integer
format: int64
- in: formData
name: height
description: 图片高
required: true
type: integer
format: int64
- in: formData
name: captchaLen
description: captcha码长度
type: integer
format: int64
responses:
"200":
description: '{object} controllers.CallResult'
/auth2/DeletedTokenInfoWithoutParam:
put:
tags:
- auth2
description: 清除除参数token以外的这个人的token
operationId: Auth2Controller.清除除参数token以外的这个人的token
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/auth2/DingDingOAuth2:
get:
tags:
- auth2
description: 钉钉认证回调接口,自己不能直接调用
operationId: Auth2Controller.钉钉认证回调接口
parameters:
- in: query
name: code
description: 客户同意后得到的code
required: true
type: string
- in: query
name: block
description: 回调地址
type: string
- in: query
name: state
description: 微信回调的登录状态
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/auth2/GetTokenInfo:
get:
tags:
- auth2
description: 得到自己登录token的信息
operationId: Auth2Controller.得到自己登录token的信息
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/auth2/Login:
post:
tags:
- auth2
description: 登录接口(微信与公众号登录不能直接调用此接口)
operationId: Auth2Controller.登录接口
parameters:
- in: formData
name: authType
description: 登录类型,当前支持[localpass本地账号密码mobile手机短信wxqrcode:微信登录weixinsns微信公众号weixinmini小程序wxnative微信APPddstaff钉钉企业ddqrcode钉钉扫码alipaycode支付宝小程序]
required: true
type: string
- in: formData
name: authSecret
description: 不同登录类型的登录秘密如果是localpass登录类型是md5后的值空串不要md5
required: true
type: string
- in: formData
name: authID
description: 登录ID登录类型为localpass时依赖于authIDType其它为相应登录类型的id
type: string
- in: formData
name: authIDType
description: 只有在登录类型为localpass时才有意义分别为userid2用户名emailmobile
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/auth2/Logout:
delete:
tags:
- auth2
description: 登出接口此接口兼容V1的TOKEN
operationId: Auth2Controller.登出接口
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/auth2/RemoveAuthBind:
delete:
tags:
- auth2
description: 删除认证方式
operationId: Auth2Controller.删除认证方式
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: query
name: authType
description: 登录类型参见Login的描述
required: true
type: string
- in: query
name: authTypeID
description: 登录类型标识
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/auth2/SendVerifyCode:
post:
tags:
- auth2
description: 发送验证码captcha码与authToken二者必须至少有一个
operationId: Auth2Controller.发送验证码
parameters:
- in: formData
name: captchaID
description: captcha码ID
type: string
- in: formData
name: captchaValue
description: captcha码值
type: string
- in: formData
name: authToken
description: 之前的认证信息
type: string
- in: formData
name: authID
description: 手机号或邮件
required: true
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/auth2/WeixinMPOAuth2:
get:
tags:
- auth2
description: 微信公众号认证回调接口,自己不能直接调用
operationId: Auth2Controller.微信公众号认证回调接口
parameters:
- in: query
name: code
description: 客户同意后得到的code
required: true
type: string
- in: query
name: block
description: 回调地址
required: true
type: string
- in: query
name: state
description: 微信回调的登录状态
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/auth2/WeixinOAuth2:
get:
tags:
- auth2
description: 微信扫码认证回调接口,自己不能直接调用
operationId: Auth2Controller.微信扫码认证回调接口
parameters:
- in: query
name: code
description: 客户同意后得到的code
required: true
type: string
- in: query
name: block
description: 回调地址
required: true
type: string
- in: query
name: state
description: 微信回调的登录状态
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/balance/UpdateUserBalance:
post:
tags:
- balance
description: 用户余额
operationId: UserBalanceController.修改用户账户余额
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: formData
name: phone
description: 发起修改人电话
required: true
type: string
- in: formData
name: userID
description: 被修用户Id
required: true
type: string
- in: formData
name: money
description: 修改后金额
type: integer
format: int64
responses:
"200":
description: '{object} controllers.CallResult'
/bill/GetUserBillDetail:
get:
tags:
- bill
description: 查看用户账户收支明细
operationId: BillController.查看用户账户收支明细
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: query
name: userID
description: 用户ID
required: true
type: string
- in: query
name: fromTime
description: 开始时间
type: string
- in: query
name: toTime
description: 结束时间
type: string
- in: query
name: offset
description: 列表起始序号以0开始缺省为0
type: integer
format: int64
- in: query
name: pageSize
description: 列表页大小缺省为50-1表示全部
type: integer
format: int64
responses:
"200":
description: '{object} controllers.CallResult'
/cms/DeleteConfig:
delete:
tags:
- cms
description: 删除配置
operationId: CmsController.删除配置
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: query
name: type
description: 配置类型当前只支持PricePack
required: true
type: string
- in: query
name: key
description: 配置名
required: true
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/cms/GetPlaces:
get:
tags:
- cms
description: 得到地点(省,城市,区)信息。
operationId: CmsController.得到地点(省,城市,区)信息
parameters:
- in: header
name: token
description: 认证token
type: string
- in: query
name: keyword
description: 查询关键字(可以为空,为空表示不限制)
type: string
- in: query
name: parentCode
description: 上级地点code这个指的是国家标准CODE中国为100000北京为110000北京市为110100不是数据库中的ID
type: integer
format: int64
- in: query
name: level
description: 地点级别省为1市为2区为3注意直辖市也要分省与市级
type: integer
format: int64
- in: query
name: includeDisabled
description: 是否包括禁用的城市(缺省不包括)
type: boolean
responses:
"200":
description: '{object} controllers.CallResult'
/cms/GetQiniuUploadToken:
get:
tags:
- cms
description: 得到七牛上传服务临时token当前设置为5分钟内有效。正常使用场景为每次上传资源前实时获取而不是保存下来一直使用如果hashCode有值且本地有可能直接返回URL
operationId: CmsController.得到七牛上传服务临时token
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: query
name: suffix
description: 前缀
required: true
type: string
- in: query
name: hashCode
description: 图片hash
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/cms/GetServiceInfo:
get:
tags:
- cms
description: 得到服务相关的一些基础信息,包括版本,及一些元数据信息
operationId: CmsController.得到服务相关的一些基础信息
parameters:
- in: header
name: token
description: 认证token
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/cms/InitPlace:
post:
tags:
- cms
description: init place
operationId: CmsController.init place
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/cms/InitStation:
post:
tags:
- cms
description: init station
operationId: CmsController.init station
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/cms/NewConfig:
post:
tags:
- cms
description: 新增配置
operationId: CmsController.新增配置
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: formData
name: type
description: 配置类型当前只支持PricePack
required: true
type: string
- in: formData
name: key
description: 配置名
required: true
type: string
- in: formData
name: value
description: 配置值
required: true
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/cms/QueryConfigs:
get:
tags:
- cms
description: 查询配置
operationId: CmsController.查询配置
parameters:
- in: header
name: token
description: 认证token
type: string
- in: query
name: type
description: 配置类型当前只支持PricePack
type: string
- in: query
name: key
description: 配置名
type: string
- in: query
name: keyword
description: 关键字
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/cms/UpdateConfig:
put:
tags:
- cms
description: 修改配置
operationId: CmsController.修改配置
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: formData
name: type
description: 配置类型当前只支持PricePack
required: true
type: string
- in: formData
name: key
description: 配置名
required: true
type: string
- in: formData
name: value
description: 配置值
required: true
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/cms/UpdatePlace:
put:
tags:
- cms
description: 只支持修改enabled, jd_code和mtps_price这三个属性
operationId: CmsController.修改地点信息
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: formData
name: code
description: 地点编号注意是code不是ID
required: true
type: integer
format: int64
responses:
"200":
description: '{object} controllers.CallResult'
/event/AddMessageGroup:
post:
tags:
- event
description: 加入用户组
operationId: EventController.加入用户组
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: formData
name: groupID
description: 组号
required: true
type: integer
format: int64
- in: formData
name: userID
description: 被邀请人ID
required: true
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/event/CreateMessageGroup:
post:
tags:
- event
description: 创建聊天组
operationId: EventController.创建聊天组
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: formData
name: userID
description: 创建者id
required: true
type: string
- in: formData
name: userID2
description: 被拉的id 如果userID2为空就默认为是创建的群聊
type: string
- in: formData
name: name
description: 如果是群聊,则要传入群名
type: string
- in: formData
name: dividePercentage
description: 如果是群聊,则要传入分成比例
type: integer
format: int64
- in: formData
name: quitPrice
description: 如果是群聊,则要传入退团金额
type: integer
format: int64
responses:
"200":
description: '{object} controllers.CallResult'
/event/DeleteMessageGroup:
post:
tags:
- event
description: 退出用户组(踢人)
operationId: EventController.退出用户组(踢人)
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: formData
name: groupID
description: 组号
required: true
type: integer
format: int64
- in: formData
name: userID
description: userID
required: true
type: string
- in: formData
name: flag
description: 是否是解散群
type: boolean
responses:
"200":
description: '{object} controllers.CallResult'
/event/GetImMessageRecord:
get:
tags:
- event
description: 查询聊天记录
operationId: EventController.查询聊天记录
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: query
name: groupID
description: 组ID
required: true
type: integer
format: int64
- in: query
name: fromTime
description: 开始时间
type: string
- in: query
name: toTime
description: 结束时间
type: string
- in: query
name: offset
description: 门店列表起始序号以0开始缺省为0
type: integer
format: int64
- in: query
name: pageSize
description: 门店列表页大小缺省为50-1表示全部
type: integer
format: int64
responses:
"200":
description: '{object} controllers.CallResult'
/event/GetMessageGroupByUser:
get:
tags:
- event
description: 查询某个用户所有聊天组
operationId: EventController.查询某个用户所有聊天组
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: query
name: userID
description: userid
required: true
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/event/GetMessageGroups:
get:
tags:
- event
description: 查询聊天组
operationId: EventController.查询聊天组
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: query
name: groupID
description: groupID
required: true
type: integer
format: int64
- in: query
name: isMember
description: 是否查询组员
required: true
type: boolean
responses:
"200":
description: '{object} controllers.CallResult'
/event/GetUserStatistics:
get:
tags:
- event
description: 得到用户统计数据
operationId: EventController.得到用户统计数据
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/event/SendSysMessage:
post:
tags:
- event
description: 发送聊天消息(限定系统消息)
operationId: EventController.发送聊天消息(限定系统消息)
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: formData
name: payload
description: immessageRecord 类型
required: true
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/event/TestWebsocket:
get:
tags:
- event
description: 测试websocket
operationId: EventController.测试websocket
responses:
"200":
description: '{object} controllers.CallResult'
/event/TransferMessageGroupMaster:
post:
tags:
- event
description: 转让群主
operationId: EventController.转让群主
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: formData
name: groupID
description: 组号
required: true
type: integer
format: int64
- in: formData
name: userID
description: userID
required: true
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/event/UpdateMessageGroup:
put:
tags:
- event
description: 修改群组信息
operationId: EventController.修改群组信息
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: formData
name: groupID
description: 组号
required: true
type: integer
format: int64
- in: formData
name: payload
description: 群组 payload
required: true
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/event/UpdateUserMessageGroupRead:
post:
tags:
- event
description: 用户未读消息设置用户在退出登录ws关闭以及关闭小程序或app时调用
operationId: EventController.用户未读消息设置
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: query
name: payload
description: messageGroupRead 格式[{groupID:,unReadCount:}]
required: true
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/event/UploadAudio:
post:
tags:
- event
description: 上传音频
operationId: EventController.上传音频
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/event/UploadImg:
post:
tags:
- event
description: 上传图片
operationId: EventController.上传图片
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/express/CancelWayVendorOrder:
post:
tags:
- express
description: 取消运单
operationId: QBiDaExpressController.Q必达
parameters:
- in: header
name: token
description: 管理员token
required: true
type: string
- in: formData
name: genre
description: 1取消2关闭
required: true
type: integer
format: int64
- in: formData
name: orderNo
description: 订单编号
required: true
type: string
- in: formData
name: type
description: 快递公司
required: true
type: integer
format: int64
responses:
"200":
description: '{object} controllers.CallResult'
/express/CreateWayOrder:
post:
tags:
- express
description: 下单
operationId: QBiDaExpressController.Q必达
parameters:
- in: header
name: token
description: 管理员token
required: true
type: string
- in: formData
name: promiseTimeType
description: 快递时效产品
type: integer
format: int64
- in: formData
name: deliveryType
description: 产品类型
type: integer
format: int64
- in: formData
name: goods
description: 商品名称
required: true
type: string
- in: formData
name: guaranteeValueAmount
description: 保价金额
type: number
format: double
- in: formData
name: weight
description: 重量kg
required: true
type: integer
format: int64
- in: formData
name: length
description: 所有包裹累计长
type: integer
format: int64
- in: formData
name: width
description: 所有包裹累计宽
type: integer
format: int64
- in: formData
name: height
description: 所有包裹累计高
type: integer
format: int64
- in: formData
name: orderSendTime
description: 预约时间
type: string
- in: formData
name: packageNum
description: 包裹数量
required: true
type: integer
format: int64
- in: formData
name: receiveAddress
description: 收件人地址
required: true
type: string
- in: formData
name: receiveName
description: 收件人姓名
required: true
type: string
- in: formData
name: receivePhone
description: 收件人手机号
required: true
type: string
- in: formData
name: remark
description: 运单备注
type: string
- in: formData
name: senderAddress
description: 寄件人地址
required: true
type: string
- in: formData
name: senderName
description: 寄件人姓名
required: true
type: string
- in: formData
name: senderPhone
description: 寄件人手机号
required: true
type: string
- in: formData
name: thirdPlatform
description: 第三方平台
type: integer
format: int64
- in: formData
name: type
description: 快递公司
required: true
type: integer
format: int64
- in: formData
name: receiveAddressId
description: 收件人地址Id
required: true
type: integer
format: int64
- in: formData
name: senderAddressId
description: 寄件人地址Id
required: true
type: integer
format: int64
- in: formData
name: channelType
description: 渠道类型1-快递2-物流3-国际物流4-整车)
required: true
type: integer
format: int64
- in: formData
name: images
description: 物品图片多个用逗号隔开
type: string
- in: formData
name: channelFee
description: 渠道价
required: true
type: number
format: double
- in: formData
name: bulk
description: 泡比
type: integer
format: int64
- in: formData
name: serviceCharge
description: 服务费
type: number
format: double
- in: formData
name: guarantFee
description: 保价
type: number
format: double
- in: formData
name: originalFee
description: 原价
type: number
format: double
- in: formData
name: increment
description: 物流
type: number
format: double
responses:
"200":
description: '{object} controllers.CallResult'
/express/DeleteOrder:
post:
tags:
- express
description: 删除未支付订单,已支付订单一个星期后才能删除
operationId: QBiDaExpressController.Q必达
parameters:
- in: header
name: token
description: 管理员token
required: true
type: string
- in: formData
name: localOrderId
description: 本地订单
required: true
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/express/GetOrderDetail:
post:
tags:
- express
description: 获取订单详情
operationId: QBiDaExpressController.Q必达
parameters:
- in: header
name: token
description: 管理员token
required: true
type: string
- in: formData
name: expressType
description: 就是type快递公司
required: true
type: integer
format: int64
- in: formData
name: orderNo
description: 订单Id三方Id
required: true
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/express/GetOrderList:
post:
tags:
- express
description: 管理系统获取订单详情
operationId: QBiDaExpressController.Q必达
parameters:
- in: header
name: token
description: 管理员token
required: true
type: string
- in: formData
name: expressType
description: 就是type快递公司
type: integer
format: int64
- in: formData
name: orderNo
description: 订单Id三方Id
type: string
- in: formData
name: orderStatus
description: 订单状态
type: integer
format: int64
- in: formData
name: pageNum
description: 页码
required: true
type: integer
format: int64
- in: formData
name: pageSize
description: 页数
required: true
type: integer
format: int64
- in: formData
name: startTime
description: 开始时间
required: true
type: string
- in: formData
name: endTime
description: 结束时间
required: true
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/express/QueryExpressPrice:
post:
tags:
- express
description: 查询快递费
operationId: QBiDaExpressController.Q必达
parameters:
- in: header
name: token
description: 管理员token
required: true
type: string
- in: formData
name: promiseTimeType
description: 快递时效产品
type: integer
format: int64
- in: formData
name: deliveryType
description: 产品类型
type: integer
format: int64
- in: formData
name: goodsValue
description: 保价金额
type: number
format: double
- in: formData
name: receiveAddress
description: 收件人地址
required: true
type: string
- in: formData
name: sendAddress
description: 寄件人地址
required: true
type: string
- in: formData
name: type
description: 快递公司
type: integer
format: int64
- in: formData
name: weight
description: 重量kg
required: true
type: integer
format: int64
- in: formData
name: length
description: 所有包裹累计长
type: integer
format: int64
- in: formData
name: width
description: 所有包裹累计宽
type: integer
format: int64
- in: formData
name: height
description: 所有包裹累计高
type: integer
format: int64
- in: formData
name: sendPhone
description: 寄件人手机号
required: true
type: string
- in: formData
name: channelType
description: 渠道类型1-快递2-物流3-国际物流4-整车)
required: true
type: integer
format: int64
responses:
"200":
description: '{object} controllers.CallResult'
/express/QueryUserOrderList:
post:
tags:
- express
description: 获取用户订单列表
operationId: QBiDaExpressController.Q必达
parameters:
- in: header
name: token
description: 管理员token
required: true
type: string
- in: formData
name: expressType
description: 就是type快递公司
type: integer
format: int64
- in: formData
name: orderStatus
description: 订单状态
type: integer
format: int64
- in: formData
name: orderNo
description: 订单号码
type: string
- in: formData
name: pageNum
description: 页码
required: true
type: integer
format: int64
- in: formData
name: pageSize
description: 页数
required: true
type: integer
format: int64
responses:
"200":
description: '{object} controllers.CallResult'
/express/TryAgainOrderByOldOrder:
post:
tags:
- express
description: 再来一单
operationId: QBiDaExpressController.Q必达
parameters:
- in: header
name: token
description: 用户token
required: true
type: string
- in: formData
name: oldNo
description: 旧的订单Id
required: true
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/job/AcceptJob:
post:
tags:
- job
description: 接任务
operationId: JobController.接任务
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: formData
name: jobID
description: jobID
required: true
type: integer
format: int64
- in: formData
name: dropShippingDeliveryID
description: 一件代发地址id
type: integer
format: int64
- in: formData
name: dropShippingCount
description: 一件代发商品数量
type: integer
format: int64
responses:
"200":
description: '{object} controllers.CallResult'
/job/AddressDistinguish:
post:
tags:
- job
description: 地址识别
operationId: JobController.地址识别 txcloud购买
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: query
name: address
description: 完整地址
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/job/AuditJob:
post:
tags:
- job
description: 审核任务
operationId: JobController.审核任务
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: formData
name: jobOrderID
description: jobOrderID
required: true
type: integer
format: int64
- in: formData
name: status
description: 审核标志15 是通过20是不通过
required: true
type: integer
format: int64
- in: formData
name: comment
description: 审核理由
type: string
- in: formData
name: vendorWaybillID
description: 运单号(一件代发)
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/job/CancelAcceptJob:
post:
tags:
- job
description: 用户取消接受的任务
operationId: JobController.用户取消接受的任务
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: formData
name: jobID
description: jobID
required: true
type: integer
format: int64
- in: formData
name: jobOrderID
description: jobOrderID
required: true
type: integer
format: int64
responses:
"200":
description: '{object} controllers.CallResult'
/job/CancelJdDelivery:
post:
tags:
- job
description: 取消京东快递
operationId: JobController.取消京东快递
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: formData
name: vendorWaybillID
description: 运单号
required: true
type: string
- in: formData
name: reason
description: 取消原因
required: true
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/job/CancelPublishJob:
post:
tags:
- job
description: 用户取消发布的任务
operationId: JobController.用户取消发布的任务
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: formData
name: jobID
description: jobID
required: true
type: integer
format: int64
responses:
"200":
description: '{object} controllers.CallResult'
/job/CheckJdDeliveryWeight:
post:
tags:
- job
description: 京东快递物流超重验证
operationId: JobController.京东快递物流超重验证
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/job/ConfirmDropShippingJob:
post:
tags:
- job
description: 确认收货(一件代发)
operationId: JobController.确认收货(一件代发)
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: formData
name: jobOrderID
description: jobOrderID
required: true
type: integer
format: int64
responses:
"200":
description: '{object} controllers.CallResult'
/job/CreateJobSpan:
post:
tags:
- job
description: 设置任务标签
operationId: JobController.设置任务标签
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: formData
name: jobIDs
description: 任务IDs
required: true
type: string
- in: formData
name: endAt
description: 截止日期
required: true
type: string
- in: formData
name: span
description: 标签1为置顶2为推荐
required: true
type: integer
format: int64
responses:
"200":
description: '{object} controllers.CallResult'
/job/GetAllDeliveryDetail:
get:
tags:
- job
description: 查询所有快递物流信息
operationId: JobController.查询所有快递物流信息 txcloud购买
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: query
name: vendorWaybillID
description: 运单号
type: string
- in: query
name: comType
description: 快递公司编码
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/job/GetCoordinateFromAddress:
get:
tags:
- job
description: 根据地址查坐标
operationId: JobController.根据地址查坐标
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: formData
name: address
description: 地址
required: true
type: string
- in: formData
name: cityCode
description: cityCode
required: true
type: integer
format: int64
responses:
"200":
description: '{object} controllers.CallResult'
/job/GetDeliveryDetail:
get:
tags:
- job
description: 查询京东快递物流信息
operationId: JobController.查询京东快递物流信息
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: query
name: vendorWaybillID
description: 运单号
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/job/GetEjyOrders:
get:
tags:
- job
description: 查询用户个人订单
operationId: JobController.查询用户个人订单易加油
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: query
name: offset
description: 门店列表起始序号以0开始缺省为0
type: integer
format: int64
responses:
"200":
description: '{object} controllers.CallResult'
/job/GetJdDelivery:
get:
tags:
- job
description: 查询用户的京东快递
operationId: JobController.查询用户的京东快递
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: query
name: status
description: 订单状态
type: integer
format: int64
- in: query
name: fromTime
description: 开始时间
type: string
- in: query
name: toTime
description: 结束时间
type: string
- in: query
name: offset
description: 门店列表起始序号以0开始缺省为0
type: integer
format: int64
- in: query
name: pageSize
description: 门店列表页大小缺省为50-1表示全部
type: integer
format: int64
responses:
"200":
description: '{object} controllers.CallResult'
/job/GetJobCategories:
get:
tags:
- job
description: 查看任务类型
operationId: JobController.查看任务类型
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: query
name: name
description: 分类名
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/job/GetJobDetail:
get:
tags:
- job
description: 查看任务
operationId: JobController.查看任务
parameters:
- in: header
name: token
description: 认证token
type: string
- in: query
name: jobID
description: 任务ID
type: integer
format: int64
- in: query
name: lng
description: 经度
type: number
format: double
- in: query
name: lat
description: 维度
type: number
format: double
responses:
"200":
description: '{object} controllers.CallResult'
/job/GetJobOrders:
get:
tags:
- job
description: 查看接受的任务列表
operationId: JobController.查看接受的任务列表
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: query
name: userID
description: 用户ID
type: string
- in: query
name: jobUserID
description: 发起任务的用户ID
type: string
- in: query
name: jobOrderID
description: 任务订单ID
type: integer
format: int64
- in: query
name: categoryID
description: 分类ID
type: string
- in: query
name: statuss
description: 状态s
type: string
- in: query
name: fromTime
description: 开始时间
type: string
- in: query
name: toTime
description: 结束时间
type: string
- in: query
name: offset
description: 门店列表起始序号以0开始缺省为0
type: integer
format: int64
- in: query
name: pageSize
description: 门店列表页大小缺省为50-1表示全部
type: integer
format: int64
responses:
"200":
description: '{object} controllers.CallResult'
/job/GetJobs:
get:
tags:
- job
description: 查看任务列表
operationId: JobController.查看任务列表
parameters:
- in: header
name: token
description: 认证token
type: string
- in: query
name: userIDs
description: 用户IDs
type: string
- in: query
name: categoryIDs
description: 分类IDs
type: string
- in: query
name: statuss
description: 状态s
type: string
- in: query
name: vendorIDs
description: 平台IDs
type: string
- in: query
name: cityCodes
description: CityIDs
type: string
- in: query
name: includeStep
description: 是否查询步骤,默认否
type: boolean
- in: query
name: fromTime
description: 开始时间
type: string
- in: query
name: toTime
description: 结束时间
type: string
- in: query
name: lng
description: 经度
type: number
format: double
- in: query
name: lat
description: 维度
type: number
format: double
- in: query
name: span
description: 标签1为置顶2为推荐
type: integer
format: int64
- in: query
name: keyword
description: 关键字
type: string
- in: query
name: sortType
description: 排序类型, 1距离2新店优先3今日热门4奖励高低
type: integer
format: int64
- in: query
name: offset
description: 门店列表起始序号以0开始缺省为0
type: integer
format: int64
- in: query
name: pageSize
description: 门店列表页大小缺省为50-1表示全部
type: integer
format: int64
responses:
"200":
description: '{object} controllers.CallResult'
/job/GetMtMembers:
get:
tags:
- job
description: 查看美团会员
operationId: JobController.查看美团会员
parameters:
- in: header
name: token
description: 认证token
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/job/GetStationList:
get:
tags:
- job
description: 获取油站列表
operationId: JobController.获取油站列表
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: query
name: stationName
description: 油站名
type: string
- in: query
name: cityCode
description: 城市ID
type: integer
format: int64
- in: query
name: lat
description: 用户坐标
type: number
format: double
- in: query
name: lng
description: 用户坐标
type: number
format: double
- in: query
name: oilCode
description: 油号
type: string
- in: query
name: sortType
description: 排序, 1为距离2为评分,3为油价
type: integer
format: int64
- in: query
name: offset
description: 门店列表起始序号以0开始缺省为0
type: integer
format: int64
- in: query
name: pageSize
description: 门店列表页大小缺省为50-1表示全部
type: integer
format: int64
responses:
"200":
description: '{object} controllers.CallResult'
/job/ImprotMtMembers:
post:
tags:
- job
description: 导入美团会员
operationId: JobController.导入美团会员
parameters:
- in: header
name: token
description: 认证token
type: string
- in: formData
name: payload
description: mtmembers struct
required: true
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/job/PublishJob:
post:
tags:
- job
description: 发布任务
operationId: JobController.发布任务
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: formData
name: payload
description: job+step+img 类型
required: true
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/job/RechargeMtMembers:
post:
tags:
- job
description: 充值美团会员
operationId: JobController.充值美团会员
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: formData
name: phone
description: 电话
required: true
type: integer
format: int64
responses:
"200":
description: '{object} controllers.CallResult'
/job/RefreshJdDelivery:
post:
tags:
- job
description: 手动刷新京东快递任务
operationId: JobController.手动刷新京东快递任务
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/job/RefreshJobStatus:
post:
tags:
- job
description: 刷新任务状态
operationId: JobController.刷新任务状态
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/job/ReloadJobSpan:
post:
tags:
- job
description: 置顶任务重排序
operationId: JobController.置顶任务重排序
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: formData
name: jobIDs
description: 任务IDs按顺序
required: true
type: string
- in: formData
name: span
description: 标签1为置顶2为推荐
required: true
type: integer
format: int64
responses:
"200":
description: '{object} controllers.CallResult'
/job/SendJdDelivery:
post:
tags:
- job
description: 发送京东快递
operationId: JobController.发送京东快递
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: formData
name: payload
description: delivery order 类型
required: true
type: string
- in: formData
name: pickUpStartTime
description: 预约取件开始时间
type: string
- in: formData
name: pickUpEndTime
description: 预约取件结束时间
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/job/SubmitJob:
post:
tags:
- job
description: 提交任务
operationId: JobController.提交任务
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: formData
name: payload
description: joborder type
required: true
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/job/TempJob:
post:
tags:
- job
description: 测试接口
operationId: JobController.测试接口
parameters:
- in: header
name: token
description: 认证token
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/job/TempJobTest:
post:
tags:
- job
description: 测试接口2
operationId: JobController.测试接口2
parameters:
- in: header
name: token
description: 认证token
type: string
- in: formData
name: data
description: data
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/job/UpdateJob:
post:
tags:
- job
description: 修改任务
operationId: JobController.修改任务
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: formData
name: payload
description: job+step+img 类型
required: true
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/job/UserRefundEjy:
get:
tags:
- job
description: 用户申请退款,易加油
operationId: JobController.用户申请退款,易加油
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: query
name: vendorOrderID
description: 易加油订单号
required: true
type: string
- in: query
name: reason
description: 退款原因
required: true
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/openapi/CallOpenAPI:
post:
tags:
- openapi
description: api调用入口
operationId: ApiController.api调用入口
parameters:
- in: formData
name: app_id
description: 应用ID
type: string
- in: formData
name: timestamp
description: unix时间戳
type: integer
format: int64
- in: formData
name: sign
description: 签名
type: string
- in: formData
name: method
description: 接口名
type: string
responses:
"200":
description: '{object} controllers.CallResult2'
/order/Cash:
post:
tags:
- order
description: 提现
operationId: OrderController.提现
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: formData
name: orderID
description: 订单号
required: true
type: string
- in: formData
name: payType
description: 支付平台类型
required: true
type: integer
format: int64
- in: formData
name: vendorPayType
description: 平台支付类型
required: true
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/order/CreateOrder:
post:
tags:
- order
description: 创建订单
operationId: OrderController.创建订单
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: formData
name: type
description: 支付类型/账单类型
required: true
type: integer
format: int64
- in: formData
name: orderType
description: 订单类型1为发任务2为冲会员3为发快递6-需要充值到余额购买的方式,7-话费充值
required: true
type: integer
format: int64
- in: formData
name: way
description: 认证方式
required: true
type: string
- in: formData
name: price
description: 支付金额
required: true
type: integer
format: int64
- in: formData
name: lng
description: 经纬度
required: true
type: number
format: double
- in: formData
name: lat
description: 经纬度
required: true
type: number
format: double
- in: formData
name: mobile
description: 充值电话
type: string
- in: formData
name: flowCode
description: 业务代码
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/order/FinishedCashOrders:
post:
tags:
- order
description: 完成提现订单
operationId: OrderController.完成提现订单
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: formData
name: orderIDs
description: 订单号列表
required: true
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/order/GetManageStatisticsImg:
get:
tags:
- order
description: 经营分析图表
operationId: OrderController.经营分析图表
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: query
name: cityCodes
description: 城市id列表
type: string
- in: query
name: fromTime
description: 开始时间
required: true
type: string
- in: query
name: toTime
description: 结束时间
required: true
type: string
- in: query
name: jobIDs
description: 任务IDs
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/order/GetManageStatisticsJob:
get:
tags:
- order
description: 经营分析任务列表
operationId: OrderController.经营分析任务列表
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: query
name: cityCodes
description: 城市id列表
type: string
- in: query
name: fromTime
description: 开始时间
type: string
- in: query
name: toTime
description: 结束时间
type: string
- in: query
name: jobIDs
description: 任务IDs
type: string
- in: query
name: offset
description: 门店列表起始序号以0开始缺省为0
type: integer
format: int64
- in: query
name: pageSize
description: 门店列表页大小缺省为50-1表示全部
type: integer
format: int64
responses:
"200":
description: '{object} controllers.CallResult'
/order/GetMyUnionOrders:
get:
tags:
- order
description: 查询我的推广订单
operationId: OrderController.查询我的推广订单
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: query
name: statuss
description: 状态s
type: string
- in: query
name: vendorID
description: -1 全部
type: integer
format: int64
- in: query
name: offset
description: 列表起始序号以0开始缺省为0
type: integer
format: int64
- in: query
name: pageSize
description: 列表页大小缺省为50-1表示全部
type: integer
format: int64
responses:
"200":
description: '{object} controllers.CallResult'
/order/GetOrders:
get:
tags:
- order
description: 查询订单提现申请
operationId: OrderController.查询订单提现申请
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: query
name: orderID
description: 订单号
type: string
- in: query
name: userID
description: 用户ID
type: string
- in: query
name: orderType
description: 订单类型1为支付2为提现
type: integer
format: int64
- in: query
name: cityCodes
description: 城市code列表
type: string
- in: query
name: fromTime
description: 开始时间
type: string
- in: query
name: toTime
description: 结束时间
type: string
- in: query
name: keyword
description: 关键字
type: string
- in: query
name: offset
description: 门店列表起始序号以0开始缺省为0
type: integer
format: int64
- in: query
name: pageSize
description: 门店列表页大小缺省为50-1表示全部
type: integer
format: int64
responses:
"200":
description: '{object} controllers.CallResult'
/order/GetPayStatistics:
get:
tags:
- order
description: 支付统计
operationId: OrderController.支付统计
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: query
name: userID
description: 用户id
type: string
- in: query
name: pop
description: 1为你邀请的0为全部
type: integer
format: int64
- in: query
name: cityCodes
description: 城市id列表
type: string
- in: query
name: mobile
description: 用户手机,必须全匹配
type: string
- in: query
name: fromTime
description: 消费开始时间
type: string
- in: query
name: toTime
description: 消费结束时间
type: string
- in: query
name: orderTypes
description: 1为发任务2为冲会员3为发快递,4为一件代发支付
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/order/Pay:
post:
tags:
- order
description: 支付
operationId: OrderController.支付
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: formData
name: orderID
description: 订单号
required: true
type: string
- in: formData
name: payType
description: 支付平台类型
required: true
type: integer
format: int64
- in: formData
name: vendorPayType
description: 平台支付类型
required: true
type: string
- in: formData
name: orderType
description: 订单类型member会员express快递recharge充值,telephoneBill充话费
required: true
type: string
- in: formData
name: appId
description: appId
required: true
type: string
- in: formData
name: isChoose
description: -1:未选中余额抵消 1余额抵消
required: true
type: integer
format: int64
responses:
"200":
description: '{object} controllers.CallResult'
/order/PayByBalance:
post:
tags:
- order
description: 支付
operationId: OrderController.余额支付
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: formData
name: orderID
description: 订单号
required: true
type: string
- in: formData
name: payType
description: 支付平台类型
required: true
type: integer
format: int64
- in: formData
name: vendorPayType
description: 平台支付类型
required: true
type: string
- in: formData
name: orderType
description: 订单类型member会员express快递recharge充值
required: true
type: string
- in: formData
name: appId
description: appId
required: true
type: string
- in: formData
name: isChoose
description: -1:未选中余额抵消 1余额抵消
required: true
type: integer
format: int64
responses:
"200":
description: '{object} controllers.CallResult'
/order/SettleUnionOrders:
post:
tags:
- order
description: 联盟订单结算
operationId: OrderController.联盟订单结算
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: query
name: vendorIDs
description: 平台IDs
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/recharge/GetRechargeOrderDetail:
get:
tags:
- recharge
description: 订单详情查询
operationId: RechargeManagerController.订单详情查询
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: formData
name: orderId
description: 订单号
required: true
type: string
- in: formData
name: mobile
description: 手机号
required: true
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/recharge/GetUserRecharge:
post:
tags:
- recharge
description: 分页查询用户充值列表
operationId: RechargeManagerController.分页查询用户充值列表
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: formData
name: page
description: 页码
required: true
type: integer
format: int64
- in: formData
name: pageSize
description: 页数
required: true
type: integer
format: int64
- in: formData
name: mobile
description: 电话
type: string
- in: formData
name: orderId
description: 订单号
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/recharge/QueryAccountBill:
get:
tags:
- recharge
description: 查询当前账号余额
operationId: RechargeManagerController.查询当前账号余额
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/recharge/SystemQueryRechargeList:
post:
tags:
- recharge
description: 管理系统获取订单详情
operationId: RechargeManagerController.管理系统获取订单详情
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: formData
name: orderId
description: 订单号
type: string
- in: formData
name: mobile
description: 手机号
type: string
- in: formData
name: rechargeStatus
description: 充值状态 0-未提交,3-等待待充值(本地) 1充值中(三方)2已充值-1失败(三方)
type: integer
format: int64
- in: formData
name: page
description: 页码
required: true
type: integer
format: int64
- in: formData
name: pageSize
description: 页数
required: true
type: integer
format: int64
- in: formData
name: startTime
description: 开始时间
required: true
type: string
- in: formData
name: endTime
description: 结束时间
required: true
type: string
- in: formData
name: userName
description: 用户名
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/task/CancelTask:
put:
tags:
- task
description: 取消长时间运行任务
operationId: TaskController.取消长时间运行任务
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: query
name: taskID
description: 任务ID
required: true
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/task/GetTasks:
get:
tags:
- task
description: 查询长时间运行任务
operationId: TaskController.查询长时间运行任务
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: query
name: taskID
description: 任务ID
type: string
- in: query
name: fromStatus
description: 起始状态
type: integer
format: int64
- in: query
name: toStatus
description: 结束状态
type: integer
format: int64
- in: query
name: lastHours
description: 多少小时以内的
type: integer
format: int64
- in: query
name: createdBy
description: 创建人
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/task/UnmanageTasks:
put:
tags:
- task
description: 取消管理任务
operationId: TaskController.取消管理任务
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: query
name: taskIDs
description: 任务ID列表
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/union/GetPddBindInfo:
get:
tags:
- union
description: 查询拼多多分享前,推广位有没有绑定授权
operationId: UnionController.查询拼多多分享前,推广位有没有绑定授权
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/union/GetUnionActList:
get:
tags:
- union
description: 查询联盟活动
operationId: UnionController.查询联盟活动
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: query
name: vendorID
description: 平台ID
required: true
type: integer
format: int64
- in: query
name: actType
description: 活动类型ID
required: true
type: integer
format: int64
responses:
"200":
description: '{object} controllers.CallResult'
/union/GetUnionJobOrderInfo:
get:
tags:
- union
description: 查看接取的联盟任务执行情况
operationId: UnionController.查看接取的联盟任务执行情况
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: query
name: jobOrderID
description: 接取任务ID
required: true
type: integer
format: int64
responses:
"200":
description: '{object} controllers.CallResult'
/union/GetUnionOrders:
get:
tags:
- union
description: 查询联盟订单
operationId: UnionController.查询联盟订单
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: query
name: vendorIDs
description: 平台IDs
type: string
- in: query
name: statuss
description: 订单状态s
type: string
- in: query
name: beginTime
description: 开始时间
type: string
- in: query
name: endTime
description: 结束时间
type: string
- in: query
name: keyword
description: 关键字
type: string
- in: query
name: offset
description: 页码
type: integer
format: int64
- in: query
name: pageSize
description: 页大小
type: integer
format: int64
responses:
"200":
description: '{object} controllers.CallResult'
/union/GetVendorMatterCategory:
get:
tags:
- union
description: 查询平台物料分类
operationId: UnionController.查询平台物料分类
parameters:
- in: header
name: token
description: 认证token
type: string
- in: query
name: vendorID
description: 平台ID
required: true
type: integer
format: int64
responses:
"200":
description: '{object} controllers.CallResult'
/union/GetVendorMatterDetail:
get:
tags:
- union
description: 查询平台物料详情
operationId: UnionController.查询平台物料详情
parameters:
- in: header
name: token
description: 认证token
type: string
- in: query
name: vendorID
description: 平台ID
required: true
type: integer
format: int64
- in: query
name: goodsID
description: 平台商品ID
required: true
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/union/GetVendorMatterRcmmd:
get:
tags:
- union
description: 查询平台物料推荐
operationId: UnionController.查询平台物料推荐
parameters:
- in: header
name: token
description: 认证token
type: string
- in: query
name: vendorID
description: 平台ID
required: true
type: integer
format: int64
- in: query
name: goodsID
description: 平台商品ID
required: true
type: string
- in: query
name: rcmmdType
description: 推荐类型1为今日销量榜3为相似商品5为实时热销榜
required: true
type: integer
format: int64
- in: query
name: offset
description: 页码
type: integer
format: int64
- in: query
name: pageSize
description: 页大小
type: integer
format: int64
responses:
"200":
description: '{object} controllers.CallResult'
/union/GetVendorMatters:
get:
tags:
- union
description: 查询平台物料
operationId: UnionController.查询平台物料
parameters:
- in: header
name: token
description: 认证token
type: string
- in: query
name: vendorID
description: 平台ID
required: true
type: integer
format: int64
- in: query
name: vendorCatID
description: 平台分类ID
type: string
- in: query
name: keyword
description: 关键字
type: string
- in: query
name: offset
description: 页码
type: integer
format: int64
- in: query
name: pageSize
description: 页大小
type: integer
format: int64
- in: query
name: listID
description: 分页用
type: string
- in: query
name: sortType
description: 排序类型
type: integer
format: int64
responses:
"200":
description: '{object} controllers.CallResult'
/union/ShareUnionLink:
post:
tags:
- union
description: 分享联盟链接
operationId: UnionController.分享联盟链接
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: formData
name: jobID
description: 任务ID
required: true
type: integer
format: int64
- in: formData
name: shareType
description: 分享类型1为当前用户分享给别人2为当前用户自己领取
required: true
type: integer
format: int64
- in: formData
name: resourceType
description: 资源类型
type: integer
format: int64
- in: formData
name: linkType
description: 链接类型1 h5链接 2 deeplink(唤起)链接 3 中间页唤起链接 4 微信小程序唤起路径, 5为小程序二维码
required: true
type: integer
format: int64
- in: formData
name: goodsID
description: 分享商品时的商品ID
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/user2/AcceptAddGroup:
post:
tags:
- user2
description: 被邀请用户达到4人时同意或拒绝入群
operationId: User2Controller.被邀请用户达到4人时同意或拒绝入群
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: formData
name: flag
description: 1为同意0为拒绝
required: true
type: integer
format: int64
responses:
"200":
description: '{object} controllers.CallResult'
/user2/AddMyDeliveryAddress:
post:
tags:
- user2
description: 用户自己增加配送地址
operationId: User2Controller.用户自己增加配送地址
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: formData
name: consigneeName
description: 收货人
required: true
type: string
- in: formData
name: consigneeMobile
description: 收货人手机
required: true
type: string
- in: formData
name: address
description: 地址(区县以下,门牌号以上的地址信息)
type: string
- in: formData
name: detailAddress
description: 门牌号
type: string
- in: formData
name: lng
description: 经度
type: number
format: double
- in: formData
name: lat
description: 纬度
type: number
format: double
- in: formData
name: tag
description: 标签
type: string
- in: formData
name: remark
description: 备注
type: string
- in: formData
name: isDefault
description: 是否是默认
type: integer
format: int64
- in: formData
name: type
description: 1为寄件人2为取件人收货人
type: integer
format: int64
- in: formData
name: autoAddress
description: 详细地址
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/user2/AddUserCityManager:
post:
tags:
- user2
description: 增加用户管理城市
operationId: User2Controller.增加用户管理城市
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: formData
name: userID
description: userID
required: true
type: string
- in: formData
name: cityCode
description: cityCode
required: true
type: integer
format: int64
responses:
"200":
description: '{object} controllers.CallResult'
/user2/DeleteMyDeliveryAddress:
delete:
tags:
- user2
description: 用户自己删除送地址
operationId: User2Controller.用户自己删除配送地址
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: query
name: id
description: 地址ID
required: true
type: integer
format: int64
responses:
"200":
description: '{object} controllers.CallResult'
/user2/DeleteUserCityManager:
post:
tags:
- user2
description: 删除用户管理城市
operationId: User2Controller.删除用户管理城市
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: formData
name: userID
description: userID
required: true
type: string
- in: formData
name: cityCode
description: cityCode
required: true
type: integer
format: int64
responses:
"200":
description: '{object} controllers.CallResult'
/user2/GetBindAuthInfo:
get:
tags:
- user2
description: 得到用户已经成功绑定的认证信息
operationId: User2Controller.得到用户已经成功绑定的认证信息
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/user2/GetSelfInfo:
get:
tags:
- user2
description: 得到用户自己的信息
operationId: User2Controller.得到用户自己的信息
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/user2/GetUser:
get:
tags:
- user2
description: 得到用户
operationId: User2Controller.得到用户
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: query
name: userID
description: 用户id
required: true
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/user2/GetUserByMiniInfo:
post:
tags:
- user2
description: 根据小程序jsCode查询用户信息
operationId: User2Controller.根据小程序jsCode查询用户信息
parameters:
- in: header
name: token
description: 认证token
type: string
- in: formData
name: data
description: 加密数据
required: true
type: string
- in: formData
name: iv
description: iv
required: true
type: string
- in: formData
name: jsCode
description: 小程序jsCode
type: string
- in: formData
name: authType
description: authType
type: string
- in: formData
name: appID
description: appID
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/user2/GetUserCityManager:
get:
tags:
- user2
description: 获取用户管理城市
operationId: User2Controller.获取用户管理城市
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: query
name: userID
description: userID
type: string
- in: query
name: cityCode
description: cityCode
type: integer
format: int64
responses:
"200":
description: '{object} controllers.CallResult'
/user2/GetUserSerachKeyword:
get:
tags:
- user2
description: 得到搜索关键词
operationId: User2Controller.得到搜索关键词
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/user2/GetUsers:
get:
tags:
- user2
description: 得到用户列表
operationId: User2Controller.得到用户列表
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: query
name: keyword
description: 关键字,可以部分匹配
type: string
- in: query
name: userID
description: 用户id
type: string
- in: query
name: pop
description: 1为你邀请的0为全部
type: integer
format: int64
- in: query
name: cityCodes
description: 城市id列表
type: string
- in: query
name: mobile
description: 用户手机,必须全匹配
type: string
- in: query
name: fromTime
description: 开始时间
type: string
- in: query
name: toTime
description: 结束时间
type: string
- in: query
name: timeType
description: 1为注册时间2为消费时间
type: integer
format: int64
- in: query
name: consumeTypes
description: 1为发任务2为冲会员3为发快递
type: string
- in: query
name: offset
description: 门店列表起始序号以0开始缺省为0
type: integer
format: int64
- in: query
name: pageSize
description: 门店列表页大小缺省为50-1表示全部
type: integer
format: int64
responses:
"200":
description: '{object} controllers.CallResult'
/user2/InvestMember:
post:
tags:
- user2
description: 会员充值
operationId: User2Controller.会员充值
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: formData
name: memberID
description: 会员ID
required: true
type: integer
format: int64
responses:
"200":
description: '{object} controllers.CallResult'
/user2/LoadMyCart:
get:
tags:
- user2
description: 得到用户指定门店的购物车信息
operationId: User2Controller.得到用户指定门店的购物车信息
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: query
name: storeIDs
description: 门店ID
required: true
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/user2/QueryMyDeliveryAddress:
get:
tags:
- user2
description: 用户查询自己的配送地址
operationId: User2Controller.用户查询自己的配送地址
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: query
name: type
description: 地址类型1是寄件人2是收货人
type: integer
format: int64
responses:
"200":
description: '{object} controllers.CallResult'
/user2/RegisterUser:
post:
tags:
- user2
description: 用户注册
operationId: User2Controller.用户注册
parameters:
- in: header
name: token
description: 管理员token
type: string
- in: formData
name: payload
description: json数据User对象(手机号必填)
required: true
type: string
- in: formData
name: mobileVerifyCode
description: 手机验证码通过auth2.SendVerifyCode获得mobileVerifyCode与authToken不能同时为空
type: string
- in: formData
name: authToken
description: 之前通过login得到的认证TOKENmobileVerifyCode与authToken不能同时为空
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/user2/SaveMyCart:
post:
tags:
- user2
description: 存储用户指定门店的购物车信息
operationId: User2Controller.存储用户指定门店的购物车信息
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: formData
name: storeID
description: 门店ID
required: true
type: integer
format: int64
- in: formData
name: payload
description: 完整的购物车商品列表
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/user2/UpdateMyDeliveryAddress:
put:
tags:
- user2
description: 用户自己修改配送地址
operationId: User2Controller.用户自己修改配送地址
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: formData
name: id
description: 地址ID
required: true
type: integer
format: int64
- in: formData
name: consigneeName
description: 收货人
type: string
- in: formData
name: consigneeMobile
description: 收货人手机
type: string
- in: formData
name: address
description: 地址(区县以下,门牌号以上的地址信息)
type: string
- in: formData
name: detailAddress
description: 门牌号
type: string
- in: formData
name: lng
description: 经度
type: number
format: double
- in: formData
name: lat
description: 纬度
type: number
format: double
- in: formData
name: tag
description: 标签
type: string
- in: formData
name: remark
description: 备注
type: string
- in: formData
name: isDefault
description: 是否是默认01
type: integer
format: int64
responses:
"200":
description: '{object} controllers.CallResult'
/user2/UpdateUser:
put:
tags:
- user2
description: 修改用户信息
operationId: User2Controller.修改用户信息
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: formData
name: payload
description: user payload
required: true
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/user2/UpdateUserByMiniInfo:
post:
tags:
- user2
description: 根据小程序jsCode修改用户信息
operationId: User2Controller.根据小程序jsCode修改用户信息
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: formData
name: data
description: 加密数据
required: true
type: string
- in: formData
name: iv
description: iv
required: true
type: string
- in: formData
name: jsCode
description: 小程序jsCode
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/withdrawal/AddWithdrawalRecord:
post:
tags:
- withdrawal
description: 提现申请
operationId: WithdrawalRecordController.用户发起提现申请
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: formData
name: withdrawalMoney
description: 提现金额
required: true
type: integer
format: int64
- in: formData
name: alipayAccount
description: 支付宝绑定账号[邮箱/电话]
required: true
type: string
- in: formData
name: alipayName
description: 真是姓名
required: true
type: string
- in: formData
name: lng
description: 经度
required: true
type: number
format: double
- in: formData
name: lat
description: 纬度
required: true
type: number
format: double
- in: formData
name: cityCode
description: 城市code
required: true
type: integer
format: int64
- in: formData
name: districtCode
description: 省code
required: true
type: integer
format: int64
responses:
"200":
description: '{object} controllers.CallResult'
/withdrawal/DeleteWithdrawalRecord:
post:
tags:
- withdrawal
description: 提现申请
operationId: WithdrawalRecordController.取消或者删除提现生情
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: formData
name: id
description: 数据主键Id
required: true
type: integer
format: int64
responses:
"200":
description: '{object} controllers.CallResult'
/withdrawal/ExamineWithdrawalOrder:
post:
tags:
- withdrawal
description: 审核提现申请
operationId: WithdrawalRecordController.审核提现申请
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: formData
name: phone
description: 当前审核人员电话号码
required: true
type: string
- in: formData
name: orderId
description: 被审核订单Id
required: true
type: string
- in: formData
name: examineStatus
description: 1-通过
required: true
type: integer
format: int64
- in: formData
name: remark
description: 不通过原因
type: string
- in: formData
name: userId
description: 提现人员Id
type: string
responses:
"200":
description: '{object} controllers.CallResult'
/withdrawal/GetWithdrawalList:
post:
tags:
- withdrawal
description: 提现申请
operationId: WithdrawalRecordController.查询申请列表
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: formData
name: pageSize
description: 页数
required: true
type: integer
format: int64
- in: formData
name: pageNum
description: 页码
required: true
type: integer
format: int64
- in: formData
name: userName
description: 用户昵称
type: string
- in: formData
name: userId
description: 用户id
type: string
- in: formData
name: orderId
description: 订单Id
type: string
- in: formData
name: startTime
description: 开始时间
type: string
- in: formData
name: endTime
description: 结束时间
type: string
- in: formData
name: phone
description: 电话
type: string
- in: formData
name: orderStatus
description: 订单状态
type: integer
format: int64
responses:
"200":
description: '{object} controllers.CallResult'
/withdrawal/GetWithdrawalRecord:
post:
tags:
- withdrawal
description: 提现申请
operationId: WithdrawalRecordController.查询申请列表
parameters:
- in: header
name: token
description: 认证token
required: true
type: string
- in: formData
name: status
description: 申请订单状态
required: true
type: integer
format: int64
- in: formData
name: pageSize
description: 页数
required: true
type: integer
format: int64
- in: formData
name: pageNum
description: 页码
required: true
type: integer
format: int64
responses:
"200":
description: '{object} controllers.CallResult'
definitions:
.false:
type: object
controllers.CallResult:
title: CallResult
type: object
properties:
code:
type: string
data:
type: string
desc:
type: string
controllers.CallResult2:
title: CallResult2
type: object
properties:
code:
type: string
data:
$ref: '#/definitions/13611.0xc000aceab0.false'
desc:
type: string
tags:
- name: event
description: |
操作事件明细相关API