Get gift card order collection

GET

/rest/v1/order/gift-card-order

Parameters

Query Parameters

filter[id]

Filter by gift card order IDs

Type

string

filter[customerId]

Filter by customer ID

Type

string

filter[currencyId]

Filter by currency ID

Type

string

filter[giftCardStatus]

Filter by gift card status

Type

string

filter[couponId]

Filter by linked coupon code ID

Type

string

filter[payway]

Filter by payment method

Type

string

filter[emailSent]

Filter by email sent status

Type

string

filter[smsSent]

Filter by SMS sent status

Type

string

filter[sendToEmail]

Filter by recipient email (partial)

Type

string

filter[sendToName]

Filter by recipient name (partial)

Type

string

filter[orderSerial]

Filter by order serial (partial)

Type

string

sort

Sort order

Type

string

page

Page number

Type

integer

limit

Pagination limit

Type

integer

Responses

Successful operation

Content-Type

application/json

"string"

GET

/rest/v1/order/gift-card-order

Playground

Variables

Key

Value

filter[id]

filter[customerId]

filter[currencyId]

filter[giftCardStatus]

filter[couponId]

filter[payway]

filter[emailSent]

filter[smsSent]

filter[sendToEmail]

filter[sendToName]

filter[orderSerial]

sort

page

limit

Samples

Powered by VitePress OpenAPI