Skip to main content
View Markdown

vouchers Query

List of the shop's vouchers.

Requires the MANAGE_DISCOUNTSpermission.
vouchers(
  filter: VoucherFilterInput
  sortBy: VoucherSortingInput
  query: String
  channel: String
  before: String
  after: String
  first: Int
  last: Int
): VoucherCountableConnection
Details
type VoucherCountableConnection {
  pageInfo: PageInfo!
  edges: [VoucherCountableEdge!]!
  totalCount: Int
}

Arguments​

filter ● VoucherFilterInput​

Filtering options for vouchers.

sortBy ● VoucherSortingInput​

Sort voucher.

channel ● String​

Slug of a channel for which the data should be returned.

before ● String​

Return the elements in the list that come before the specified cursor.

after ● String​

Return the elements in the list that come after the specified cursor.

first ● Int​

Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.

last ● Int​

Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.

Show deprecatedHide deprecated

query ● String​

DEPRECATED

Use filter.search input instead.

Search vouchers by name or code.

Type​

VoucherCountableConnection​