跳转到主要内容
GET
列出折扣

授权

Authorization
string
header
必填

Bearer API Key 鉴权。格式:Authorization: Bearer {your_api_key}

请求头

Request-Id
string
默认值:008e3967-a1b5-48bb-be14-d5bff5092e61
必填

请求的唯一标识符

查询参数

ids
string[]

按折扣 ID 筛选。数组大小限制:[0,100]

status
string

折扣状态:

  • draft:折扣已创建但尚未激活或对用户可见
  • ongoing:折扣当前处于活动状态并可供使用
  • not_started:折扣已定义,但其开始时间尚未到达
  • completed:折扣已结束,不再可供使用
discount_codes
string[]

按折扣代码筛选。数组大小限制:[0,100]

starting_after
string

用于分页的游标。starting_after 是定义您在列表中位置的对象 ID。例如,如果想获取下一页,可以在第一次获取对象列表之后,使用最后一个对象的 id 作为参数值。不能和 ending_before 同时使用

ending_before
string

用于分页的游标。ending_before 是定义您在列表中位置的对象 ID。例如,如果想获取上一页,可以在第一次获取对象列表之后,使用第一个对象的 id 作为参数值。不能和 starting_after 同时使用

limit
integer<int32>

分页参数,每页数量,默认:10,接口默认按创建时间倒序排序。限制:[1, 100]

created_at.gt
string

用于过滤的最小值(不包含,RFC3339格式的UTC时间,例如'2025-01-01T00:00:00Z')

created_at.gte
string

用于过滤的最小值(包含,RFC3339格式的UTC时间,例如'2025-01-01T00:00:00Z')

created_at.lt
string

用于过滤的最大值(不包含,RFC3339格式的UTC时间,例如'2025-01-01T00:00:00Z')

created_at.lte
string

用于过滤的最大值(包含,RFC3339格式的UTC时间,例如'2025-01-01T00:00:00Z')

响应

200 - application/json

OK

code
string

error code

message
string

error message

data
object