员工端api (0.0.1)

Download OpenAPI specification:Download

员工端api协议

获取微信sdk配置,参见:https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/JS-SDK.html#4

query Parameters
url
required
string

需要使用配置的网页地址

Responses

Response samples

Content type
application/json
{
  • "app_id": "string",
  • "timestamp": 0,
  • "nonce_str": "string",
  • "signature": "string"
}

短域名

query Parameters
url
required
string

需要转换成短网址的网页地址

clear
string
Value: 1

是否需要清除缓存

Responses

Response samples

Content type
application/json
{
  • "key": "string",
  • "short_url": "string",
  • "url": "string"
}

当前用户请求发送手机验证码(接口需登录,被攻击的话,可以把用户加入黑名单)

Request Body schema: application/json
phone
required
string

手机号

scene
string
Value: "bind_mobile"

发送短信的场景

Responses

Request samples

Content type
application/json
{
  • "phone": "string",
  • "scene": "bind_mobile"
}

获取用户信息

Responses

Response samples

Content type
application/json
{}

获取当前用户在商户下的信息

path Parameters
merchant_hash
required
string (Hash)

商户hash

Responses

Response samples

Content type
application/json
{
  • "name": "我叫杜晓峰",
  • "staff_hash": "string",
  • "phone": "string",
  • "is_disabled": false,
  • "is_verification_clerk": true,
  • "is_admin": false
}

根据hash获取商户信息

path Parameters
merchant_hash
required
string (Hash)

商户hash

Responses

Response samples

Content type
application/json
{
  • "hash": "string",
  • "region_id": 0,
  • "name": "string",
  • "logo_url": "string",
  • "banners": [],
  • "phone": [
    ],
  • "address": "string",
  • "address_description": "string",
  • "longitude": 39.07151,
  • "latitude": 117.190091,
  • "business_hours": [
    ],
  • "tags": [
    ]
}

获取当前用户的申请信息

path Parameters
merchant_hash
required
string (Hash)

商户hash

Responses

Response samples

Content type
application/json
{
  • "status": "passed",
  • "reason": "string",
  • "name": "string",
  • "phone": "string"
}

加入商户

path Parameters
merchant_hash
required
string (Hash)

商户hash

Request Body schema: application/json
name
required
string

名称

phone
required
string

手机号

code
required
string

验证码

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "phone": "string",
  • "code": "string"
}

核销订单

path Parameters
merchant_hash
required
string (Hash)

商户hash

Request Body schema: application/json
order_no_or_verification_code
required
string

订单号或核销码

Responses

Request samples

Content type
application/json
{
  • "order_no_or_verification_code": "string"
}

获取员工汇总数据

path Parameters
merchant_hash
required
string (Hash)

商户hash

Responses

Response samples

Content type
application/json
{
  • "today_fission_number": 0,
  • "today_order_number": 0,
  • "total_order_number": 0
}

推荐推广产品

path Parameters
merchant_hash
required
string (Hash)

商户hash

query Parameters
offset
number

分页参数

limit
number

分页参数

Responses

Response samples

Content type
application/json
{
  • "list": [
    ]
}

获取当前员工的核销记录

path Parameters
merchant_hash
required
string (Hash)

商户hash

query Parameters
offset
number

分页参数

limit
number

分页参数

Responses

Response samples

Content type
application/json
{
  • "list": [
    ]
}

排行榜数据

path Parameters
merchant_hash
required
string (Hash)

商户hash

query Parameters
ranking_type
required
string (RankingType)
Enum: "browse" "order" "fission"

排行榜类型

period
required
string

周期

Responses

Response samples

Content type
application/json
{
  • "list": [
    ]
}

获取当前用户的业绩数据

path Parameters
merchant_hash
required
string (Hash)

商户hash

Responses

Response samples

Content type
application/json
{
  • "browse": 0,
  • "order": 0
}

获取业绩浏览明细

path Parameters
merchant_hash
required
string (Hash)

商户hash

query Parameters
offset
number

分页参数

limit
number

分页参数

Responses

Response samples

Content type
application/json
{
  • "list": [
    ]
}

获取业绩订单明细

path Parameters
merchant_hash
required
string (Hash)

商户hash

query Parameters
offset
number

分页参数

limit
number

分页参数

Responses

Response samples

Content type
application/json
{
  • "list": [
    ]
}

与商户解绑

path Parameters
merchant_hash
required
string (Hash)

商户hash

Responses

分销收入

path Parameters
merchant_hash
required
string (Hash)

商户hash

Responses

Response samples

Content type
application/json
{
  • "cumulative_income": 1,
  • "unsettled_income": 1,
  • "withdrawable_income": 1,
  • "number_of_customers": 1
}

分销提现信息

path Parameters
merchant_hash
required
string (Hash)

商户hash

Responses

Response samples

Content type
application/json
{
  • "maximum_daily_withdrawable_amount": 0,
  • "remaining_withdrawable_amount": 0,
  • "withdraw_amount": 0,
  • "actual_amount_received": 1,
  • "fee": 1,
  • "rate": "19%"
}

商品分销明细

path Parameters
merchant_hash
required
string (Hash)

商户hash

query Parameters
offset
number

分页参数

limit
number

分页参数

Responses

Response samples

Content type
application/json
{
  • "list": [
    ]
}

会员分销明细

path Parameters
merchant_hash
required
string (Hash)

商户hash

query Parameters
offset
number

分页参数

limit
number

分页参数

Responses

Response samples

Content type
application/json
{
  • "list": [
    ]
}

分销客户明细

path Parameters
merchant_hash
required
string (Hash)

商户hash

query Parameters
keyword
string

搜索关键字(客户姓名,手机号,微信昵称)

offset
number

分页参数

limit
number

分页参数

Responses

Response samples

Content type
application/json
{
  • "list": [
    ]
}

分销提现记录

path Parameters
merchant_hash
required
string (Hash)

商户hash

query Parameters
offset
number

分页参数

limit
number

分页参数

Responses

Response samples

Content type
application/json
{
  • "list": [
    ]
}

分销提现

path Parameters
merchant_hash
required
string (Hash)

商户hash

Responses

纪律分数据

path Parameters
merchant_hash
required
string (Hash)

商户hash

Responses

Response samples

Content type
application/json
{
  • "cumulative_points": 0,
  • "reset_at": 0,
  • "allow_to_distribute": true,
  • "allow_to_withdraw": true
}

纪律分变更详情

path Parameters
merchant_hash
required
string (Hash)

商户hash

query Parameters
offset_id
number

分页参数

limit
number

分页参数

Responses

Response samples

Content type
application/json
{
  • "list": [
    ]
}

生成尾款收款码

path Parameters
merchant_hash
required
string (Hash)

商户hash

query Parameters
order_no_or_verification_code
required
string

订单号

money
number

收款金额

Responses

Response samples

Content type
application/json
{
  • "qrcode_url": "string",
  • "money": 0
}