Get coupon collection

GET

/rest/v1/promotion/coupon

Parameters

Query Parameters

filter[id]

Filter by coupon IDs

Type

string

filter[audienceId]

Filter by audience ID

Type

string

filter[isDefault]

Filter by default flag

Type

string

filter[couponType]

Filter by coupon type

Type

string

filter[name]

Filter by name (partial)

Type

string

filter[displayName]

Filter by display name (partial)

Type

string

sort

Sort order

Type

string

page

Page number

Type

integer

limit

Pagination limit

Type

integer

with

With relations (e.g., codes,products,vendors,rules)

Type

string

Responses

Successful operation

Content-Type

application/json

"string"

GET

/rest/v1/promotion/coupon

Playground

Variables

Key

Value

filter[id]

filter[audienceId]

filter[isDefault]

filter[couponType]

filter[name]

filter[displayName]

sort

page

limit

with

Samples

Powered by VitePress OpenAPI