券统计 - 掌东家

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Query 参数

clientId

string

clientId

必需

franchiseeId

string

必需

franchiseeId

userId

string

userId

必需

Header 参数

Authorization

string

必需

Body 参数application/json

cert

boolean

只显示认证店

可选

client_id

string

商户Id

可选

coupon_ids

array[string]

多个券种ID

可选

dept_ids

array[string]

多个部门ID

可选

end_date

integer <int64>

截止日期

可选

order_by

array[object (BaseOrderVO) {2}]

排序

可选

key

string

排序字段

可选

type

enum<string>

排序方式

可选

枚举值:

ASCDESC

page_no

integer <int32>

页次

可选

page_size

integer <int32>

每页记录数

可选

pivot_table

boolean

截止日期

可选

start_date

integer <int64>

起始日期

可选

user_id

string

用户Id

可选

示例

{
    "cert": true,
    "client_id": "string",
    "coupon_ids": [
        "string"
    ],
    "dept_ids": [
        "string"
    ],
    "end_date": 0,
    "order_by": [
        {
            "key": "string",
            "type": "ASC"
        }
    ],
    "page_no": 0,
    "page_size": 0,
    "pivot_table": true,
    "start_date": 0,
    "user_id": "string"
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/fcm/crmCouponReport/summary?clientId=&franchiseeId=&userId=' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "cert": true,
    "client_id": "string",
    "coupon_ids": [
        "string"
    ],
    "dept_ids": [
        "string"
    ],
    "end_date": 0,
    "order_by": [
        {
            "key": "string",
            "type": "ASC"
        }
    ],
    "page_no": 0,
    "page_size": 0,
    "pivot_table": true,
    "start_date": 0,
    "user_id": "string"
}'

返回响应

🟢200OK

application/json

Body

code

string

可选

data

array[object (CrmCouponSummaryVO) {13}]

可选

coupon_id

string

券种ID

可选

coupon_name

string

券种ID

可选

coupon_show_name

string

券种展示名

可选

dept_code

string

部门号

可选

dept_id

string

部门ID

可选

dept_name

string

部门名

可选

gift_amt

number <double>

赠送金额

可选

gift_qty

integer <int32>

赠送数量

可选

net_value

number <double>

实收金额

可选

sale_amt

number <double>

发售金额

可选

sale_qty

integer <int32>

发售数量

可选

use_amt

number <double>

使用金额

可选

use_qty

integer <int32>

使用数量

可选

message

string

可选

示例

{
    "code": "string",
    "data": [
        {
            "coupon_id": "string",
            "coupon_name": "string",
            "coupon_show_name": "string",
            "dept_code": "string",
            "dept_id": "string",
            "dept_name": "string",
            "gift_amt": 0,
            "gift_qty": 0,
            "net_value": 0,
            "sale_amt": 0,
            "sale_qty": 0,
            "use_amt": 0,
            "use_qty": 0
        }
    ],
    "message": "string"
}

🟢201Created

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found