查询可添加礼品卡

分页查询可添加礼品卡资料

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

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

Query 参数

clientId

string

clientId

必需

userId

string

userId

必需

Header 参数

Authorization

string

必需

Body 参数application/json

查询条件

auto_number

boolean

自动生成卡号

可选

channels

array[string]

可使用渠道

可选

client_id

string

商户Id

可选

excludes

array[string]

排除礼品卡条件

可选

give

boolean

可转赠

可选

member_login

boolean

可用于会员登录

可选

memo

string

备注

可选

name

string

礼品卡名称

可选

order_by

array[object (BaseOrderVO) {2}]

排序

可选

key

string

排序字段

可选

type

enum<string>

排序方式

可选

枚举值:

ASCDESC

overdrawn

boolean

可选

允许一次超额支付(仅售卖机)

page_no

integer <int32>

页次

可选

page_size

integer <int32>

每页记录数

可选

physical

boolean

排除礼品卡条件

可选

pos_store_menu_group_id

string

分组Id

可选

redeem_code

boolean

启用兑换码

可选

reload

boolean

可储值

可选

sales_auto_active

boolean

发售时自动激活

可选

states

array[string]

多个状态

可选

store_id

string

门店Id

可选

student_card

boolean

校园卡

可选

transfer_from_balance

boolean

可从会员钱包转入

可选

transfer_to_balance

boolean

可选

卡余额可转入会员钱包

user_id

string

用户Id

可选

示例

{
    "auto_number": true,
    "channels": [
        "string"
    ],
    "client_id": "string",
    "excludes": [
        "string"
    ],
    "give": true,
    "member_login": true,
    "memo": "string",
    "name": "string",
    "order_by": [
        {
            "key": "string",
            "type": "ASC"
        }
    ],
    "overdrawn": true,
    "page_no": 0,
    "page_size": 0,
    "physical": true,
    "pos_store_menu_group_id": "string",
    "redeem_code": true,
    "reload": true,
    "sales_auto_active": true,
    "states": [
        "string"
    ],
    "store_id": "string",
    "student_card": true,
    "transfer_from_balance": true,
    "transfer_to_balance": true,
    "user_id": "string"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200OK

application/json

Body

code

string

可选

data

object (FluxData«CrmCardVO»)

可选

items

array[object (CrmCardVO) {49}]

可选

page_count

integer <int32>

可选

page_no

integer <int32>

可选

page_size

integer <int32>

可选

total_count

integer <int32>

可选

message

string

可选

示例

{
    "code": "string",
    "data": {
        "items": [
            {
                "auto_number": true,
                "card_covers": [
                    {
                        "card_cover": "string",
                        "card_cover_url": "string"
                    }
                ],
                "card_value_type": "FIXED",
                "card_values": [
                    {
                        "card_value": 0,
                        "id": "string",
                        "price": 0
                    }
                ],
                "category_exclude": [
                    {
                        "barcode": "string",
                        "icon_url": "string",
                        "merchandise_category_id": "string",
                        "merchandise_category_name": "string",
                        "merchandise_code": "string",
                        "merchandise_id": "string",
                        "merchandise_name": "string",
                        "price": 0,
                        "sku_id": "string",
                        "sku_name": "string",
                        "thumbnail_url": "string",
                        "unit": "string"
                    }
                ],
                "category_include": [
                    {
                        "barcode": "string",
                        "icon_url": "string",
                        "merchandise_category_id": "string",
                        "merchandise_category_name": "string",
                        "merchandise_code": "string",
                        "merchandise_id": "string",
                        "merchandise_name": "string",
                        "price": 0,
                        "sku_id": "string",
                        "sku_name": "string",
                        "thumbnail_url": "string",
                        "unit": "string"
                    }
                ],
                "channels": [
                    "string"
                ],
                "client_id": "string",
                "close_qty": 0,
                "create_time": "2019-08-24T14:15:22Z",
                "creator": "string",
                "creator_name": "string",
                "desc": "string",
                "edit_time": "2019-08-24T14:15:22Z",
                "editer": "string",
                "editer_name": "string",
                "gift_qty": 0,
                "give": true,
                "id": "string",
                "in_stock_qty": 0,
                "lock_qty": 0,
                "lost_qty": 0,
                "member_login": true,
                "memo": "string",
                "name": "string",
                "no_exclude": [
                    {
                        "nos": [
                            0
                        ],
                        "type": "ANY"
                    }
                ],
                "overdrawn": true,
                "pattern": [
                    {
                        "prefix": "string",
                        "seq_digit": 0
                    }
                ],
                "pattern_type": "STYLE",
                "physical": true,
                "redeem_code": true,
                "register_qty": 0,
                "reload": true,
                "sale_qty": 0,
                "sales_auto_active": true,
                "sales_store_exclude": [
                    {
                        "store_id": "string",
                        "store_name": "string"
                    }
                ],
                "sales_store_include": [
                    {
                        "store_id": "string",
                        "store_name": "string"
                    }
                ],
                "show_name": "string",
                "sku_exclude": [
                    {
                        "barcode": "string",
                        "icon_url": "string",
                        "merchandise_category_id": "string",
                        "merchandise_category_name": "string",
                        "merchandise_code": "string",
                        "merchandise_id": "string",
                        "merchandise_name": "string",
                        "price": 0,
                        "sku_id": "string",
                        "sku_name": "string",
                        "thumbnail_url": "string",
                        "unit": "string"
                    }
                ],
                "sku_include": [
                    {
                        "barcode": "string",
                        "icon_url": "string",
                        "merchandise_category_id": "string",
                        "merchandise_category_name": "string",
                        "merchandise_code": "string",
                        "merchandise_id": "string",
                        "merchandise_name": "string",
                        "price": 0,
                        "sku_id": "string",
                        "sku_name": "string",
                        "thumbnail_url": "string",
                        "unit": "string"
                    }
                ],
                "state": "OPEN",
                "student_card": true,
                "theme_img": "string",
                "theme_img_url": "string",
                "transfer_from_balance": true,
                "transfer_to_balance": true,
                "use_store_exclude": [
                    {
                        "store_id": "string",
                        "store_name": "string"
                    }
                ],
                "use_store_include": [
                    {
                        "store_id": "string",
                        "store_name": "string"
                    }
                ],
                "void_qty": 0
            }
        ],
        "page_count": 0,
        "page_no": 0,
        "page_size": 0,
        "total_count": 0
    },
    "message": "string"
}

🟢201Created

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found