Get coupon code collection

GET

/rest/v1/promotion/coupon-code

Parameters

Query Parameters

filter[id]

Filter by coupon code IDs

Type

string

filter[couponId]

Filter by coupon definition ID

Type

string

filter[code]

Filter by coupon code string (partial)

Type

string

filter[isSent]

Filter by sent status

Type

string

filter[isUsed]

Filter by used status

Type

string

sort

Sort order

Type

string

page

Page number

Type

integer

limit

Pagination limit

Type

integer

with

With relations (e.g., coupon)

Type

string

Responses

Successful operation

Content-Type

application/json

"string"

GET

/rest/v1/promotion/coupon-code

Playground

Variables

Key

Value

filter[id]

filter[couponId]

filter[code]

filter[isSent]

filter[isUsed]

sort

page

limit

with

Samples

Powered by VitePress OpenAPI