Skip to main content
Log inSign up
query

Requires read_gift_cards access scope.

Returns a list of gift cards.

Anchor to Arguments

GiftCardConnection arguments

GiftCardConnection!

The elements that come after the specified cursor.

The elements that come before the specified cursor.

The first n elements from the paginated list.

The last n elements from the paginated list.

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default
string

Searched fields: code.

Example:

  • query=Bob Norman

  • query=title:green hoodie

Anchor to balance_status
string

Example:

  • balance_status:full

Anchor to created_at
time

Example:

  • created_at:>=2020-01-01T12:00:00Z

Anchor to expires_on
date

Example:

  • expires_on:>=2020-01-01

id

Filter by id range.

Example:

  • id:1234

  • id:>=1234

  • id:<=1234

Anchor to initial_value
string

Example:

  • initial_value:>=100

string

Example:

  • source:manual

string

Example:

  • status:disabled OR status:expired

BooleanDefault:false

Reverse the order of the underlying list.

The ID of a saved search. The search’s query string is used as the query argument.

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.


Was this section helpful?

The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.

[GiftCard!]!non-null

A list of nodes that are contained in GiftCardEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve.

PageInfo!non-null

An object that’s used to retrieve cursor information about the current page.


Was this section helpful?