API docs by Redocly

员工端api (0.0.1)

Download OpenAPI specification:Download

员工端api协议, 分页协议参考https://docs.gitlab.com/ee/api/#pagination-link-header。 如无特殊说明，金钱的单位为分，1元=100；时间为unix时间戳；id为整数型。

通知列表

Responses

Response samples

Content type
application/json
[
  • {
    }
]

获取指定通知

path Parameters
id
required
integer (Id)

活动ID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "type": 0,
  • "title": "string",
  • "content": "string",
  • "start_time": "string",
  • "end_time": "string",
  • "sort": 0,
  • "status": 0,
  • "created_at": "string",
  • "updated_at": "string"
}

短域名

query Parameters
activity_id
required
integer (Id)

id

url
required
string

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

clear
string
Value: 1

是否需要清除缓存

Responses

Response samples

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

将微信临时素材同步到七牛

query Parameters
activity_id
required
integer (Id)

id

server_id
required
string

微信临时素材的id

folder
required
string

七牛文件夹

Responses

Response samples

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

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

path Parameters
activity_id
required
integer (Id)

id

query Parameters
url
required
string

需要使用配置的网页地址

Responses

Response samples

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

微信登录

path Parameters
activity_id
required
integer (Id)

id

query Parameters
redirect
required
string

回跳地址，把cookie种入这个地址

Responses

获取用户信息

path Parameters
activity_id
required
integer (Id)

id

Responses

Response samples

Content type
application/json
{}

获取指定活动

path Parameters
activity_id
required
integer (Id)

活动ID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "hash": "string",
  • "title": "string",
  • "cover_url": "string",
  • "location": "string",
  • "start_time": 0,
  • "end_time": 0,
  • "status": "started",
  • "live_time": 0,
  • "live_days": 0,
  • "activity_post_url": [],
  • "avatar_background_url": "string",
  • "live_post_url": [],
  • "staff_invitation_post_url": "string",
  • "wechat_sharing_cover_url": "http://oolqt5gs6.bkt.clouddn.com/1571741939285.jpg",
  • "wechat_sharing_title": "string",
  • "wechat_sharing_description": "string",
  • "enable_teams": true,
  • "reward_info": {
    },
  • "enable_data_export": true,
  • "enable_manual_order": true,
  • "enable_received_amount": true,
  • "enable_visiting_shops": true,
  • "enable_hidden_live_top": false,
  • "enable_hidden_point_top": true,
  • "enable_hidden_offline_order": true,
  • "enable_prestore_card": true,
  • "enable_coupon": true,
  • "enable_house_records": true,
  • "enable_staff_invitation_for_staff": true,
  • "enable_staff_invitation_for_merchant_admin": true,
  • "enable_write_off_before_activity_ended": true,
  • "show_poster_logo": true,
  • "show_merchant_manual_order": true,
  • "enable_blind_box": true,
  • "manual_order_settlement_time": 0,
  • "disable_staff_login": false,
  • "total_merchant_number": 0,
  • "current_user": {
    }
}

获取指定活动财务信息

path Parameters
activity_id
required
integer (Id)

活动ID

Responses

Response samples

Content type
application/json
{
  • "merchant": 0,
  • "staff": 0,
  • "merchant_balance": 0,
  • "staff_balance": 0,
  • "budget": 0,
  • "budget_balance": 0,
  • "live_red_package": 0,
  • "live_red_package_balance": 0,
  • "system_deduction": 0,
  • "handling_fee": 10
}

获取指定活动直播间im信息

path Parameters
activity_id
required
integer (Id)

活动ID

Responses

Response samples

Content type
application/json
{
  • "group_id": "string",
  • "im_id": "string",
  • "im_token": "string"
}

生成小程序二维码

path Parameters
activity_id
required
integer (Id)

活动ID

query Parameters
scene
required
string

小程序码的scene

Responses

获取指定活动阶段信息

path Parameters
activity_id
required
integer (Id)

活动ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

获取当前用户指定活动的申请信息

path Parameters
activity_id
required
integer (Id)

活动ID

Responses

Response samples

Content type
application/json
{
  • "status": "waiting",
  • "reason": "string",
  • "data": {
    }
}

加入指定活动

path Parameters
activity_id
required
integer (Id)

活动ID

Request Body schema: application/json
merchant_id
integer (Id)

id

store_id
integer (Id)

id

name
required
string

当前用户在此活动中的名称

phone
required
string

当前用户在此活动中的手机号

role
string
Enum: "activity_admin" "merchant_admin" "merchant_staff"

当前用户在此活动中的角色

Responses

Request samples

Content type
application/json
{
  • "merchant_id": 0,
  • "store_id": 0,
  • "name": "string",
  • "phone": "string",
  • "role": "activity_admin"
}

导出指定活动数据

path Parameters
activity_id
required
integer (Id)

活动ID

query Parameters
from_date
string

开始日期(YYYY-MM-DD)

to_date
string

结束日期(YYYY-MM-DD)

type
required
string
Enum: "all" "signups" "live_orders" "collects_orders" "seckill_orders" "coupons" "medals" "employee_performance" "prizes" "prestore_card" "blind_boxs" "visiting_shops" "crosstab" "house_records"

导出类型

Responses

获取指定活动员工列表

path Parameters
activity_id
required
integer (Id)

活动ID

query Parameters
role
required
string
Enum: "merchant_admin" "merchant_staff"

角色

search
string

搜索参数（目前只需要支持品牌和员工名称）

storeId
number

门店id

merchantId
number

品牌id

offset_id
number

分页参数

limit
number

分页参数

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

审核活动员工申请

path Parameters
activity_id
required
integer (Id)

活动ID

Request Body schema: application/json
uids
required
Array of numbers
action
required
string
Enum: "passed" "rejected" "disabled" "enabled" "deleted"

Responses

Request samples

Content type
application/json
{
  • "uids": [
    ],
  • "action": "passed"
}

已审核活动员工申请信息

path Parameters
activity_id
required
integer (Id)

活动ID

Responses

Response samples

Content type
application/json
{
  • "approved_merchant_admin_number": 0,
  • "approved_staff_number": 0
}

admin查询线下订单

path Parameters
activity_id
required
integer (Id)

活动ID

query Parameters
merchant_id
integer (Id)

签单品牌

status
string
Enum: "paid" "unpaid"

订单状态

start_time
number

开始时间

end_time
number

结束时间

keyword
string

搜索关键词（姓名或手机号）

offset_id
number

分页参数

limit
number

分页参数

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "self_signs_count": 0,
  • "unpaid": 0,
  • "list": [
    ]
}

查询线下订单的客户信息

path Parameters
activity_id
required
integer (Id)

活动ID

query Parameters
phone
required
string

电话

Responses

Response samples

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

查询线下订单

path Parameters
activity_id
required
integer (Id)

活动ID

query Parameters
type
string
Enum: "mine" "merchant" "relevant"

订单类型

status
string
Enum: "paid" "unpaid"

订单状态

keyword
string

搜索关键词（姓名或手机号）

offset_id
number

分页参数

limit
number

分页参数

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "self_signs_count": 0,
  • "unpaid": 0,
  • "list": [
    ]
}

创建线下订单

path Parameters
activity_id
required
integer (Id)

活动ID

Request Body schema: application/json
name
required
string

客户名称

phone
required
string

客户电话

address
required
string

客户地址

amount
required
number

订单金额

type
required
string (ManualOrderType)
Enum: "self_signs" "from_other_merchant"
from_merchant_id
integer (Id)

id

from_store_id
integer (Id)

id

from_staff_id
integer (Id)

id

attachment_keys
Array of strings
received_amount
number

已收金额

description
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "phone": "string",
  • "address": "string",
  • "amount": 0,
  • "type": "self_signs",
  • "from_merchant_id": 0,
  • "from_store_id": 0,
  • "from_staff_id": 0,
  • "attachment_keys": [
    ],
  • "received_amount": 0,
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 0
}

获取线下订单

path Parameters
activity_id
required
integer (Id)

活动ID

order_id
required
integer (Id)

活动ID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "staff_id": 0,
  • "merchant_name": "string",
  • "name": "string",
  • "phone": "string",
  • "address": "string",
  • "amount": 0,
  • "received_amount": 0,
  • "type": "self_signs",
  • "is_bought_coupons": true,
  • "is_bought_blind_box": true,
  • "from_merchant_id": 0,
  • "description": "string",
  • "attachments": [
    ],
  • "editable": true,
  • "status": "unpaid",
  • "created_at": 0,
  • "from_merchant_name": "string",
  • "from_store_name": "string",
  • "from_staff_name": "string",
  • "handling_fee": 5,
  • "payment_time": 0,
  • "recorderInfo": {
    }
}

编辑线下订单

path Parameters
activity_id
required
integer (Id)

活动ID

order_id
required
integer (Id)

订单ID

Request Body schema: application/json
name
required
string

客户名称

phone
required
string

客户电话

address
required
string

客户地址

amount
required
number

订单金额

type
required
string (ManualOrderType)
Enum: "self_signs" "from_other_merchant"
from_merchant_id
integer (Id)

id

from_store_id
integer (Id)

id

from_staff_id
integer (Id)

id

attachment_keys
Array of strings
received_amount
number

已收金额

description
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "phone": "string",
  • "address": "string",
  • "amount": 0,
  • "type": "self_signs",
  • "from_merchant_id": 0,
  • "from_store_id": 0,
  • "from_staff_id": 0,
  • "attachment_keys": [
    ],
  • "received_amount": 0,
  • "description": "string"
}

删除线下订单

path Parameters
activity_id
required
integer (Id)

活动ID

order_id
required
integer (Id)

订单ID

Responses

获取微信充值参数

path Parameters
activity_id
required
integer (Id)

活动ID

order_id
required
integer (Id)

活动ID

Responses

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "nonce_str": "string",
  • "package": "string",
  • "sign_type": "SHA1",
  • "pay_sign": "string"
}

获取指定活动设置

path Parameters
activity_id
required
integer (Id)

活动ID

Responses

Response samples

Content type
application/json
{
  • "additional_data": {
    },
  • "seckill_limit": 0,
  • "location_visible": true,
  • "recommended_merchants_visible": true,
  • "customer_phone_visible": true,
  • "enable_hidden_live_top": true,
  • "enable_hidden_point_top": true,
  • "enable_hidden_offline_order": true,
  • "merchant_phone_visible": true,
  • "store_info_visible": true,
  • "activity_contact_number": "string",
  • "manual_order_enabled": true,
  • "manual_order_settlement_time": 0,
  • "manual_self_order_fee": 0,
  • "manual_other_order_fee": 0
}

设置指定活动设置

path Parameters
activity_id
required
integer (Id)

活动ID

Request Body schema: application/json
required
object

运营附加数据

seckill_limit
required
number

秒杀支付限制数量

location_visible
required
boolean

是否显示活动地点

recommended_merchants_visible
required
boolean

是否显示推荐商户

customer_phone_visible
required
boolean

是否显示业主完整电话

enable_hidden_live_top
required
boolean

是否隐藏直播订单排行

enable_hidden_point_top
required
boolean

是否隐藏积分排行

enable_hidden_offline_order
required
boolean

是否隐藏线下订单排行

merchant_phone_visible
required
boolean

是否显示商户电话

store_info_visible
required
boolean

是否显示店铺信息

activity_contact_number
required
string

活动联系信息（注：可设置一个统一的联系电话，如400电话，比较适用于工厂活动）

manual_order_enabled
required
boolean

是否开启线下订单

manual_order_settlement_time
required
number

线下订单结算时间（秒）

manual_self_order_fee
required
number

线下自签单订单提单费

manual_other_order_fee
required
number

线下带单订单提单费

Responses

Request samples

Content type
application/json
{
  • "additional_data": {
    },
  • "seckill_limit": 0,
  • "location_visible": true,
  • "recommended_merchants_visible": true,
  • "customer_phone_visible": true,
  • "enable_hidden_live_top": true,
  • "enable_hidden_point_top": true,
  • "enable_hidden_offline_order": true,
  • "merchant_phone_visible": true,
  • "store_info_visible": true,
  • "activity_contact_number": "string",
  • "manual_order_enabled": true,
  • "manual_order_settlement_time": 0,
  • "manual_self_order_fee": 0,
  • "manual_other_order_fee": 0
}

获取指定活动充值设置

path Parameters
activity_id
required
integer (Id)

活动ID

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "detail": {
    }
}

设置指定活动充值信息（只有活动负责人可设置，只可设置一次，设置后不可修改） 如果设置的值为0，无需充值，则直接把 /staff/v1/activities 接口中的 currentUser.inited 设为 true，可让其跳过充值

path Parameters
activity_id
required
integer (Id)

活动ID

Request Body schema: application/json
user_recharge
required
integer

员工充值奖金池：设置员工注册审核通过后每个人需充值的金额（单位：分）

merchant_recharge
required
integer

品牌充值员工奖金池：每个品牌为员工奖金池赞助的奖金（单位：分）

merchant_reward
required
integer

品牌奖金池：用于品牌的任务设定，督促员工完成任务（单位：分）

not_finish_deduct
required
integer

纪律任务考核金：用于处罚未完成任务的品牌（单位：分）

budget
required
integer

推广费预算：用于发放设置的浏览、裂变奖励（单位：分）

Responses

Request samples

Content type
application/json
{
  • "user_recharge": 0,
  • "merchant_recharge": 0,
  • "merchant_reward": 0,
  • "not_finish_deduct": 0,
  • "budget": 0
}

获取指定活动奖励豆设置

path Parameters
activity_id
required
integer (Id)

活动ID

Responses

Response samples

Content type
application/json
{
  • "views": 0,
  • "fissions": 0,
  • "collects": 0,
  • "coupons": 0,
  • "self_signs": 0,
  • "contribute_signs": 0,
  • "live_nums": 0,
  • "blind_boxs": 0,
  • "seckills": 0,
  • "signups": 0
}

设置指定活动奖励豆信息

path Parameters
activity_id
required
integer (Id)

活动ID

Request Body schema: application/json
views
required
integer

浏览

fissions
required
integer

裂变

collects
required
integer

集赞

coupons
required
integer

售卡

self_signs
required
integer

签单

contribute_signs
required
integer

贡献签单

live_nums
required
integer

直播间/人

blind_boxs
required
integer

盲盒

seckills
required
integer

秒杀

signups
required
integer

报名

Responses

Request samples

Content type
application/json
{
  • "views": 0,
  • "fissions": 0,
  • "collects": 0,
  • "coupons": 0,
  • "self_signs": 0,
  • "contribute_signs": 0,
  • "live_nums": 0,
  • "blind_boxs": 0,
  • "seckills": 0,
  • "signups": 0
}

指定活动增加一个阶段

path Parameters
activity_id
required
integer (Id)

活动ID

Request Body schema: application/json
name
required
string
start_time
required
integer
end_time
required
integer
merchant_recharge
required
integer
staff_reward
required
integer

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "start_time": 0,
  • "end_time": 0,
  • "merchant_recharge": 0,
  • "staff_reward": 0
}

编辑阶段

未开始阶段才可以编辑

path Parameters
activity_id
required
integer (Id)

活动ID

stage_id
required
integer (Id)

活动ID

Request Body schema: application/json
name
required
string
start_time
required
integer
end_time
required
integer
merchant_recharge
required
integer
staff_reward
required
integer

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "start_time": 0,
  • "end_time": 0,
  • "merchant_recharge": 0,
  • "staff_reward": 0
}

删除阶段

未开始阶段才可以删除

path Parameters
activity_id
required
integer (Id)

活动ID

stage_id
required
integer (Id)

活动ID

Responses

获取活动的某个阶段的任务

path Parameters
activity_id
required
integer (Id)

活动ID

stage_id
required
integer (Id)

阶段Id

Responses

Response samples

Content type
application/json
{
  • "staff": {
    },
  • "merchant_common": {
    },
  • "merchant": [
    ]
}

设置活动的某个阶段的员工任务

path Parameters
activity_id
required
integer (Id)

活动ID

stage_id
required
integer (Id)

阶段Id

Request Body schema: application/json
views
required
integer

浏览

fissions
required
integer

裂变

collects
required
integer

集赞

coupons
required
integer

售卡

self_signs
required
integer

签单

contribute_signs
required
integer

贡献签单

live_nums
required
integer

直播间人数

live_orders
required
integer

直播间订单数

signups
required
integer

报名

forwards
required
integer

转发

prestore_cards
required
integer

预存卡

blind_boxs
required
integer

盲盒人数

Responses

Request samples

Content type
application/json
{
  • "views": 0,
  • "fissions": 0,
  • "collects": 0,
  • "coupons": 0,
  • "self_signs": 0,
  • "contribute_signs": 0,
  • "live_nums": 0,
  • "live_orders": 0,
  • "signups": 0,
  • "forwards": 0,
  • "prestore_cards": 0,
  • "blind_boxs": 0
}

设置活动的某个阶段的单个的品牌任务

path Parameters
activity_id
required
integer (Id)

活动ID

stage_id
required
integer (Id)

阶段Id

merchant_id
required
integer (Id)

品牌Id

Request Body schema: application/json
views
required
integer

浏览

fissions
required
integer

裂变

collects
required
integer

集赞

coupons
required
integer

售卡

self_signs
required
integer

签单

contribute_signs
required
integer

贡献签单

live_nums
required
integer

直播间人数

live_orders
required
integer

直播间订单数

signups
required
integer

报名

forwards
required
integer

转发

prestore_cards
required
integer

预存卡

blind_boxs
required
integer

盲盒人数

Responses

Request samples

Content type
application/json
{
  • "views": 0,
  • "fissions": 0,
  • "collects": 0,
  • "coupons": 0,
  • "self_signs": 0,
  • "contribute_signs": 0,
  • "live_nums": 0,
  • "live_orders": 0,
  • "signups": 0,
  • "forwards": 0,
  • "prestore_cards": 0,
  • "blind_boxs": 0
}

设置活动的某个阶段的品牌通用任务

path Parameters
activity_id
required
integer (Id)

活动ID

stage_id
required
integer (Id)

阶段Id

Request Body schema: application/json
views
required
integer

浏览

fissions
required
integer

裂变

collects
required
integer

集赞

coupons
required
integer

售卡

self_signs
required
integer

签单

contribute_signs
required
integer

贡献签单

live_nums
required
integer

直播间人数

live_orders
required
integer

直播间订单数

signups
required
integer

报名

forwards
required
integer

转发

prestore_cards
required
integer

预存卡

blind_boxs
required
integer

盲盒人数

Responses

Request samples

Content type
application/json
{
  • "views": 0,
  • "fissions": 0,
  • "collects": 0,
  • "coupons": 0,
  • "self_signs": 0,
  • "contribute_signs": 0,
  • "live_nums": 0,
  • "live_orders": 0,
  • "signups": 0,
  • "forwards": 0,
  • "prestore_cards": 0,
  • "blind_boxs": 0
}

同步奖励豆任务都惩罚金任务

path Parameters
activity_id
required
integer (Id)

活动ID

stage_id
required
integer (Id)

阶段Id

Responses

获取活动的全局惩罚设置

path Parameters
activity_id
required
integer (Id)

活动ID

stage_id
required
integer (Id)

阶段Id

Responses

Response samples

Content type
application/json
{
  • "viewpunishs": 0,
  • "fissionpunishs": 0,
  • "collectpunishs": 0,
  • "couponpunishs": 0,
  • "prestorecardpunishs": 0,
  • "selfsignpunishs": 0,
  • "contributesignpunishs": 0,
  • "livenumpunishs": 0,
  • "liveorderpunishs": 0,
  • "signuppunishs": 0,
  • "forwardpunishs": 0,
  • "blindboxpunishs": 0,
  • "views_punish": 0,
  • "fissions_punish": 0,
  • "collects_punish": 0,
  • "coupons_punish": 0,
  • "prestore_cards_punish": 0,
  • "self_signs_punish": 0,
  • "contribute_signs_punish": 0,
  • "live_nums_punish": 0,
  • "live_orders_punish": 0,
  • "signups_punish": 0,
  • "forwards_punish": 0,
  • "blind_boxs_punish": 0
}

设置活动的全局惩罚设置

path Parameters
activity_id
required
integer (Id)

活动ID

stage_id
required
integer (Id)

阶段Id

Request Body schema: application/json
viewpunishs
integer

浏览数量

fissionpunishs
integer

裂变数量

collectpunishs
integer

集赞数量

couponpunishs
integer

售卡数量

prestorecardpunishs
integer

预存卡数量

selfsignpunishs
integer

签单数量

contributesignpunishs
integer

贡献签单数量

livenumpunishs
integer

直播间人数数量

liveorderpunishs
integer

直播间订单数数量

signuppunishs
integer

报名数量

forwardpunishs
integer

转发数量

blindboxpunishs
integer

盲盒数量

views_punish
integer

浏览惩罚金

fissions_punish
integer

裂变惩罚金

collects_punish
integer

集赞惩罚金

coupons_punish
integer

售卡惩罚金

prestore_cards_punish
integer

预存卡惩罚金

self_signs_punish
integer

签单惩罚金

contribute_signs_punish
integer

贡献签单惩罚金

live_nums_punish
integer

直播间人数惩罚金

live_orders_punish
integer

直播间订单数惩罚金

signups_punish
integer

报名惩罚金

forwards_punish
integer

转发惩罚金

blind_boxs_punish
integer

盲盒惩罚金

Responses

Request samples

Content type
application/json
{
  • "viewpunishs": 0,
  • "fissionpunishs": 0,
  • "collectpunishs": 0,
  • "couponpunishs": 0,
  • "prestorecardpunishs": 0,
  • "selfsignpunishs": 0,
  • "contributesignpunishs": 0,
  • "livenumpunishs": 0,
  • "liveorderpunishs": 0,
  • "signuppunishs": 0,
  • "forwardpunishs": 0,
  • "blindboxpunishs": 0,
  • "views_punish": 0,
  • "fissions_punish": 0,
  • "collects_punish": 0,
  • "coupons_punish": 0,
  • "prestore_cards_punish": 0,
  • "self_signs_punish": 0,
  • "contribute_signs_punish": 0,
  • "live_nums_punish": 0,
  • "live_orders_punish": 0,
  • "signups_punish": 0,
  • "forwards_punish": 0,
  • "blind_boxs_punish": 0
}

获取活动的商户惩罚设置

path Parameters
activity_id
required
integer (Id)

活动ID

stage_id
required
integer (Id)

阶段Id

merchant_id
required
integer (Id)

阶段Id

Responses

Response samples

Content type
application/json
{
  • "viewpunishs": 0,
  • "fissionpunishs": 0,
  • "collectpunishs": 0,
  • "couponpunishs": 0,
  • "prestorecardpunishs": 0,
  • "selfsignpunishs": 0,
  • "contributesignpunishs": 0,
  • "livenumpunishs": 0,
  • "liveorderpunishs": 0,
  • "signuppunishs": 0,
  • "forwardpunishs": 0,
  • "blindboxpunishs": 0,
  • "views_punish": 0,
  • "fissions_punish": 0,
  • "collects_punish": 0,
  • "coupons_punish": 0,
  • "prestore_cards_punish": 0,
  • "self_signs_punish": 0,
  • "contribute_signs_punish": 0,
  • "live_nums_punish": 0,
  • "live_orders_punish": 0,
  • "signups_punish": 0,
  • "forwards_punish": 0,
  • "blind_boxs_punish": 0
}

设置活动的商户惩罚设置

path Parameters
activity_id
required
integer (Id)

活动ID

stage_id
required
integer (Id)

阶段Id

merchant_id
required
integer (Id)

阶段Id

Request Body schema: application/json
viewpunishs
integer

浏览数量

fissionpunishs
integer

裂变数量

collectpunishs
integer

集赞数量

couponpunishs
integer

售卡数量

prestorecardpunishs
integer

预存卡数量

selfsignpunishs
integer

签单数量

contributesignpunishs
integer

贡献签单数量

livenumpunishs
integer

直播间人数数量

liveorderpunishs
integer

直播间订单数数量

signuppunishs
integer

报名数量

forwardpunishs
integer

转发数量

blindboxpunishs
integer

盲盒数量

views_punish
integer

浏览惩罚金

fissions_punish
integer

裂变惩罚金

collects_punish
integer

集赞惩罚金

coupons_punish
integer

售卡惩罚金

prestore_cards_punish
integer

预存卡惩罚金

self_signs_punish
integer

签单惩罚金

contribute_signs_punish
integer

贡献签单惩罚金

live_nums_punish
integer

直播间人数惩罚金

live_orders_punish
integer

直播间订单数惩罚金

signups_punish
integer

报名惩罚金

forwards_punish
integer

转发惩罚金

blind_boxs_punish
integer

盲盒惩罚金

Responses

Request samples

Content type
application/json
{
  • "viewpunishs": 0,
  • "fissionpunishs": 0,
  • "collectpunishs": 0,
  • "couponpunishs": 0,
  • "prestorecardpunishs": 0,
  • "selfsignpunishs": 0,
  • "contributesignpunishs": 0,
  • "livenumpunishs": 0,
  • "liveorderpunishs": 0,
  • "signuppunishs": 0,
  • "forwardpunishs": 0,
  • "blindboxpunishs": 0,
  • "views_punish": 0,
  • "fissions_punish": 0,
  • "collects_punish": 0,
  • "coupons_punish": 0,
  • "prestore_cards_punish": 0,
  • "self_signs_punish": 0,
  • "contribute_signs_punish": 0,
  • "live_nums_punish": 0,
  • "live_orders_punish": 0,
  • "signups_punish": 0,
  • "forwards_punish": 0,
  • "blind_boxs_punish": 0
}

手动惩罚某品牌

path Parameters
activity_id
required
integer (Id)

活动ID

Request Body schema: application/json
kind
required
any
Enum: "punishment" "reward"

操作类型

merchant_id
required
integer (Id)

id

points
required
integer

奖惩积分数量

money
integer

奖惩金额数量（目前奖励无现金，可不处理）

reason
required
string

奖惩原因

Responses

Request samples

Content type
application/json
{
  • "kind": "punishment",
  • "merchant_id": 0,
  • "points": 0,
  • "money": 0,
  • "reason": "string"
}

业主查询

path Parameters
activity_id
required
integer (Id)

活动ID

query Parameters
keyword
required
string

搜索关键词

Responses

Response samples

Content type
application/json
{
  • "avatar_url": "string",
  • "nickname": "string",
  • "real_name": "string",
  • "phone": "string",
  • "first_view": {
    },
  • "signup_at": 0,
  • "data": {
    },
  • "write_off_data": {
    },
  • "orders": [
    ],
  • "live_orders": [
    ]
}

获取某个阶段的奖金信息

path Parameters
activity_id
required
integer (Id)

活动ID

stage_id
required
integer (Id)

阶段ID

Responses

Response samples

Content type
application/json
{
  • "merchant": {
    },
  • "staff": {
    }
}

获取阶段奖金池排行榜数据

path Parameters
activity_id
required
integer (Id)

活动ID

stage_id
required
integer (Id)

阶段ID

query Parameters
ranking_role
required
string (RankingRole)
Enum: "staff" "merchant"

排行榜角色

is_finished
boolean

列出已完成 or 未完成的数据

search
string

搜索参数（目前只需支持品牌和员工名称）

offset
number

分页参数

limit
number

分页参数

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

获取当前阶段奖金池中，当前个人（或品牌）的数据，根据ranking_role的不同，返回个人或者品牌的数据

path Parameters
activity_id
required
integer (Id)

活动ID

stage_id
required
integer (Id)

阶段ID

query Parameters
ranking_role
required
string (RankingRole)
Enum: "staff" "merchant"

排行榜角色

Responses

Response samples

Content type
application/json
{
  • "ranking": 0,
  • "data": {
    }
}

获取某个活动的品牌信息

path Parameters
activity_id
required
integer (Id)

活动ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

获取某个活动的门店信息

path Parameters
activity_id
required
integer (Id)

活动ID

merchant_id
required
integer (Id)

商户ID

query Parameters
city
string

按城市模糊匹配，比如传“上海”，搜索出上海市的所有店

offset
number

分页参数

limit
number

分页参数

Responses

Response samples

Content type
application/json
[
  • {
    }
]

获取单个门店信息

path Parameters
activity_id
required
integer (Id)

活动ID

merchant_id
required
integer (Id)

商户ID

store_id
required
integer (Id)

门店ID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "province": "string",
  • "city": "string",
  • "address": "string"
}

获取此活动当前用户的微信充值参数(当前用户为品牌)

path Parameters
activity_id
required
integer (Id)

活动ID

Responses

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "nonce_str": "string",
  • "package": "string",
  • "sign_type": "SHA1",
  • "pay_sign": "string"
}

获取此活动当前用户的微信充值参数(当前用户为员工)

path Parameters
activity_id
required
integer (Id)

活动ID

Responses

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "nonce_str": "string",
  • "package": "string",
  • "sign_type": "SHA1",
  • "pay_sign": "string"
}

获取手动充值的微信充值参数

path Parameters
activity_id
required
integer (Id)

活动ID

Request Body schema: application/json
role
required
any
Enum: "activity_admin" "merchant_admin"

角色

type
required
any
Enum: "merchant" "staff" "budget" "live_red_package"

充值类型

money
required
integer

充值金额

Responses

Request samples

Content type
application/json
{
  • "role": "activity_admin",
  • "type": "merchant",
  • "money": 0
}

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "nonce_str": "string",
  • "package": "string",
  • "sign_type": "SHA1",
  • "pay_sign": "string"
}

获取当前用户在某个活动中某个阶段数据的汇总

path Parameters
activity_id
required
integer (Id)

活动ID

stage_id
required
integer (Id)

阶段ID

Responses

Response samples

Content type
application/json
{
  • "self": {
    },
  • "merchant": {
    }
}

获取当前用户的业绩数据

path Parameters
activity_id
required
integer (Id)

活动ID

Responses

Response samples

Content type
application/json
{
  • "view": 0,
  • "fission": 0,
  • "signup": 0,
  • "coupon": 0,
  • "sign": 0,
  • "live": 0,
  • "collect": 0,
  • "live_invitation": 0,
  • "prestore_card": 0,
  • "visiting_shops": 0,
  • "seckill": 0,
  • "blind_box": 0
}

获取当前用户的浏览业绩

path Parameters
activity_id
required
integer (Id)

活动ID

query Parameters
offset_id
number

分页参数

limit
number

分页参数

Responses

Response samples

Content type
application/json
[
  • {
    }
]

获取当前用户的裂变业绩

path Parameters
activity_id
required
integer (Id)

活动ID

query Parameters
offset_id
number

分页参数

limit
number

分页参数

Responses

Response samples

Content type
application/json
{
  • "count": {
    },
  • "items": [
    ]
}

获取裂变业绩中某个业主的裂变信息

path Parameters
activity_id
required
integer (Id)

活动ID

user_id
required
integer (Id)

业主ID

Responses

Response samples

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

获取当前用户的秒杀业绩

path Parameters
activity_id
required
integer (Id)

活动ID

query Parameters
other_customers_from_merchant
boolean

（筛选）本品牌除我的客户外的其他客户

offset_id
number

分页参数

limit
number

分页参数

Responses

Response samples

Content type
application/json
{
  • "count": {
    },
  • "items": [
    ]
}

获取秒杀业绩中某个业主的秒杀信息

path Parameters
activity_id
required
integer (Id)

活动ID

order_id
required
integer (Id)

业主ID

Responses

Response samples

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

获取当前用户的报名业绩

path Parameters
activity_id
required
integer (Id)

活动ID

query Parameters
search
string

客户手机号搜索

offset
number

分页参数

limit
number

分页参数

Responses

Response samples

Content type
application/json
[
  • {
    }
]

获取当前用户的售卡业绩

path Parameters
activity_id
required
integer (Id)

活动ID

query Parameters
offset_id
number

分页参数

limit
number

分页参数

Responses

Response samples

Content type
application/json
[
  • {
    }
]

获取当前用户的盲盒业绩

path Parameters
activity_id
required
integer (Id)

活动ID

query Parameters
offset_id
number

分页参数

limit
number

分页参数

Responses

Response samples

Content type
application/json
[
  • {
    }
]

获取当前用户的预存卡业绩

path Parameters
activity_id
required
integer (Id)

活动ID

query Parameters
offset_id
number

分页参数

limit
number

分页参数

Responses

Response samples

Content type
application/json
[
  • {
    }
]

获取当前用户的逛店客户业绩

path Parameters
activity_id
required
integer (Id)

活动ID

query Parameters
offset_id
number

分页参数

limit
number

分页参数

Responses

Response samples

Content type
application/json
[
  • {
    }
]

获取当前用户的签单业绩

path Parameters
activity_id
required
integer (Id)

活动ID

query Parameters
offset_id
number

分页参数

limit
number

分页参数

Responses

Response samples

Content type
application/json
[
  • {
    }
]

获取当前用户的直播签单业绩

path Parameters
activity_id
required
integer (Id)

活动ID

query Parameters
offset_id
number

分页参数

limit
number

分页参数

Responses

Response samples

Content type
application/json
[
  • {
    }
]

获取当前用户的集赞业绩

path Parameters
activity_id
required
integer (Id)

活动ID

query Parameters
offset_id
number

分页参数

limit
number

分页参数

Responses

Response samples

Content type
application/json
{
  • "participated_number": 0,
  • "finished_number": 0,
  • "items": [
    ]
}

获取集赞订单详情

path Parameters
activity_id
required
integer (Id)

活动ID

order_id
required
integer (Id)

集赞订单ID

Responses

Response samples

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

获取当前用户直播邀请业绩

path Parameters
activity_id
required
integer (Id)

活动ID

query Parameters
offset_id
number

分页参数

limit
number

分页参数

Responses

Response samples

Content type
application/json
[
  • {
    }
]

获取活动排行榜数据

path Parameters
activity_id
required
integer (Id)

活动ID

query Parameters
ranking_role
required
string (RankingRole)
Enum: "staff" "merchant"

排行榜角色

ranking_type
required
string (RankingType)
Enum: "views" "fissions" "forwards" "signups" "coupons" "self_signs" "contributed_signs" "from_other_merchant_signs" "points" "live_invitations" "live_reservations" "collects" "reward_beans" "signs_total" "money" "seckills" "sales_total" "prestore_card" "visiting_shops" "offline_orders" "offline_contributed_orders" "offline_owed_orders" "ordered_customers" "blind_boxs"

排行榜类型

staff_name
string

筛选条件：员工名称

merchant_id
integer (Id)

筛选条件：商户

period
required
string

周期

offset
number

分页参数

limit
number

分页参数

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

获取活动排行榜汇总数据

path Parameters
activity_id
required
integer (Id)

活动ID

query Parameters
ranking_role
required
string (RankingRole)
Enum: "staff" "merchant"

排行榜角色

ranking_type
required
string (RankingType)
Enum: "views" "fissions" "forwards" "signups" "coupons" "self_signs" "contributed_signs" "from_other_merchant_signs" "points" "live_invitations" "live_reservations" "collects" "reward_beans" "signs_total" "money" "seckills" "sales_total" "prestore_card" "visiting_shops" "offline_orders" "offline_contributed_orders" "offline_owed_orders" "ordered_customers" "blind_boxs"

排行榜类型

staff_name
string

筛选条件：员工类型

merchant_id
integer (Id)

筛选条件：商户

period
required
string

周期

Responses

Response samples

Content type
application/json
{
  • "total": 0
}

获取活动排行榜当前个人（或品牌）的数据，根据ranking_role的不同，返回个人或者品牌的数据

path Parameters
activity_id
required
integer (Id)

活动ID

query Parameters
ranking_role
required
string (RankingRole)
Enum: "staff" "merchant"

排行榜角色

ranking_type
required
string (RankingType)
Enum: "views" "fissions" "forwards" "signups" "coupons" "self_signs" "contributed_signs" "from_other_merchant_signs" "points" "live_invitations" "live_reservations" "collects" "reward_beans" "signs_total" "money" "seckills" "sales_total" "prestore_card" "visiting_shops" "offline_orders" "offline_contributed_orders" "offline_owed_orders" "ordered_customers" "blind_boxs"

排行榜类型

period
required
string

周期

Responses

Response samples

Content type
application/json
{
  • "ranking": 0,
  • "data": {
    }
}

获取被贡献签单品牌明细

path Parameters
activity_id
required
integer (Id)

活动Id

merchant_id
required
integer (Id)

被贡献签单的商户Id

query Parameters
period
required
string

周期

offset
number

分页参数

limit
number

分页参数

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "merchant_name": "string",
  • "list": [
    ]
}

获取被贡献签单员工明细

path Parameters
activity_id
required
integer (Id)

活动Id

merchant_id
required
integer (Id)

被贡献签单的商户Id

from_merchant_id
required
integer (Id)

贡献签单的商户Id

query Parameters
period
required
string

周期

offset
number

分页参数

limit
number

分页参数

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "merchant_name": "string",
  • "list": [
    ]
}

获取员工给品牌贡献签单

path Parameters
activity_id
required
integer (Id)

活动Id

staff_id
required
integer (Id)

贡献签单的员工Id

query Parameters
period
required
string

周期

offset
number

分页参数

limit
number

分页参数

Responses

Response samples

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

获取线下欠单详情

path Parameters
activity_id
required
integer (Id)

活动Id

merchant_id
required
integer (Id)

被贡献签单的商户Id

query Parameters
period
required
string

周期

offset
number

分页参数

limit
number

分页参数

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "merchant_name": "string",
  • "list": [
    ]
}

获取活动排行榜积分数据

path Parameters
activity_id
required
integer (Id)

活动ID

query Parameters
merchant_id
required
integer (Id)

id

offset
number

分页参数

limit
number

分页参数

Responses

Response samples

Content type
application/json
[
  • {
    }
]

获取区域排行榜数据

path Parameters
activity_id
required
integer (Id)

活动ID

query Parameters
ranking_type
required
string (RankingType)
Enum: "views" "fissions" "forwards" "signups" "coupons" "self_signs" "contributed_signs" "from_other_merchant_signs" "points" "live_invitations" "live_reservations" "collects" "reward_beans" "signs_total" "money" "seckills" "sales_total" "prestore_card" "visiting_shops" "offline_orders" "offline_contributed_orders" "offline_owed_orders" "ordered_customers" "blind_boxs"

排行榜类型

team_id
integer (Id)

战区id

province_id
integer (Id)

省份id

store_id
integer (Id)

店面id

period
required
string

周期

offset
number

分页参数

limit
number

分页参数

Responses

Response samples

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

获取总览排行榜数据

path Parameters
activity_id
required
integer (Id)

活动ID

query Parameters
dimensions
required
string

纬度，用逗号分隔，有views,fissions,forwards,signups,coupons,blind_boxs,collects,signs_total(直播签单),ordered_customers(签单客户),live_reservations(直播预约),from_other_merchant_signs(被贡献签单),self_signs(自签单),sales_total(签单收款),contributed_signs(贡献签单),live_invitations(直播邀请)

period
required
string

周期

offset
number

分页参数

limit
number

分页参数

Responses

Response samples

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

获取总览排行榜汇总数据

path Parameters
activity_id
required
integer (Id)

活动ID

Responses

Response samples

Content type
application/json
{
  • "views": 0,
  • "fissions": 0,
  • "forwards": 0,
  • "signups": 0,
  • "coupons": 0,
  • "blind_boxs": 0,
  • "collects": 0,
  • "signs_total": 0,
  • "ordered_customers": 0,
  • "live_reservations": 0,
  • "from_other_merchant_signs": 0,
  • "self_signs": 0,
  • "sales_total": 0,
  • "contributed_signs": 0,
  • "live_invitations": 0
}

获取活动分析数据

path Parameters
activity_id
required
integer (Id)

活动ID

Responses

Response samples

Content type
application/json
{
  • "total": {
    },
  • "average": {
    },
  • "seckill_orders_source": [
    ],
  • "orders_source": [
    ],
  • "views_source": [
    ],
  • "signups_source": [
    ],
  • "signups_conversion": [
    ],
  • "prestore_card_order_source": [
    ],
  • "coupons_conversion": [
    ],
  • "prestore_card_conversion": [
    ]
}

获取当前用户的财务信息

path Parameters
activity_id
required
integer (Id)

活动ID

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "withdrawable": 0,
  • "withdrawn": 0,
  • "others": 0
}

个人财务流水记录

path Parameters
activity_id
required
integer (Id)

活动ID

query Parameters
offset_id
number

分页参数

limit
number

分页参数

Responses

Response samples

Content type
application/json
[
  • {
    }
]

当前用户提现到微信钱包

path Parameters
activity_id
required
integer (Id)

活动ID

Responses

获取当前商户的财务信息（当前用户是品牌负责人，获取负责的对应品牌财务信息）

path Parameters
activity_id
required
integer (Id)

活动ID

Responses

Response samples

Content type
application/json
{
  • "coupons": {
    },
  • "blind_boxs": {
    },
  • "live_orders": {
    },
  • "seckill_orders": {
    },
  • "stage_rewards": [
    ],
  • "total_reward": 0,
  • "withdrawable_reward": 0,
  • "not_finish_deduct_balance": 0,
  • "budget_balance": {
    },
  • "live_red_package_balance": 0
}

品牌奖金提现

path Parameters
activity_id
required
integer (Id)

活动ID

Responses

惩罚记录

path Parameters
activity_id
required
integer (Id)

活动ID

query Parameters
offset_id
number

分页参数

limit
number

分页参数

Responses

Response samples

Content type
application/json
[
  • {
    }
]

获取直播订单信息

path Parameters
activity_id
required
integer (Id)

活动ID

order_code
required
string

订单code

Responses

Response samples

Content type
application/json
{
  • "earnest": 0,
  • "status": "paying",
  • "related_product": {
    }
}

核销直播订单

path Parameters
activity_id
required
integer (Id)

活动ID

order_code
required
string

订单code

Responses

获取抽奖订单信息

path Parameters
activity_id
required
integer (Id)

活动ID

prize_order_code
required
string

订单id

Responses

Response samples

Content type
application/json
{
  • "prize_name": "string",
  • "prize_img_url": "string",
  • "merchant_id": 0,
  • "user_name": "string",
  • "user_phone": "string",
  • "status": "drawn"
}

核销抽奖订单

path Parameters
activity_id
required
integer (Id)

活动ID

prize_order_code
required
string

订单id

Responses

获取预存卡订单信息

path Parameters
activity_id
required
integer (Id)

活动ID

prestore_card_order_code
required
string

预存卡订单id

Responses

Response samples

Content type
application/json
{
  • "gift_title": "string",
  • "gift_cover_url": "string",
  • "description": "string",
  • "status": "paying"
}

核销预存卡订单

path Parameters
activity_id
required
integer (Id)

活动ID

prestore_card_order_code
required
string

预存卡订单id

Responses

获取扫楼登记记录

path Parameters
activity_id
required
integer (Id)

活动ID

Responses

Response samples

Content type
application/json
{
  • "community_name": "string",
  • "room_no": "string",
  • "progress": "string",
  • "company": "string",
  • "materials": "string",
  • "description": "string"
}

录入扫楼登记记录

path Parameters
activity_id
required
integer (Id)

活动ID

Request Body schema: application/json
community_name
required
string

小区名称

room_no
required
string

房号

progress
string

装修进度

company
string

装修公司

materials
string

装修材料

description
required
string

备注

Responses

Request samples

Content type
application/json
{
  • "community_name": "string",
  • "room_no": "string",
  • "progress": "string",
  • "company": "string",
  • "materials": "string",
  • "description": "string"
}

获取当前活动的省市信息

path Parameters
activity_id
required
integer (Id)

活动ID

Responses

Response samples

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

获取直播间设置

path Parameters
activity_id
required
integer (Id)

活动ID

Responses

Response samples

Content type
application/json
{
  • "enable_staff_buy": true,
  • "enable_product_sales": true,
  • "enable_withdrawable_status": true,
  • "enable_order_status": true,
  • "thermodynamic_value": 0
}

修改直播间设置

path Parameters
activity_id
required
integer (Id)

活动ID

Request Body schema: application/json
enable_staff_buy
required
boolean

是否开启员工下单

enable_product_sales
required
boolean

是否显示产品销量

enable_withdrawable_status
required
boolean

是否展示红包提现状态

enable_order_status
required
boolean

是否展示下单状态

thermodynamic_value
required
number

热力值

Responses

Request samples

Content type
application/json
{
  • "enable_staff_buy": true,
  • "enable_product_sales": true,
  • "enable_withdrawable_status": true,
  • "enable_order_status": true,
  • "thermodynamic_value": 0
}