gift Cards
Requires access scope.
Returns a list of gift cards.
GiftCardConnection arguments
- Anchor to afterafter•
The elements that come after the specified cursor.
- Anchor to beforebefore•
The elements that come before the specified cursor.
- Anchor to firstfirst•
The first
n
elements from the paginated list.- Anchor to lastlast•
The last
n
elements from the paginated list.- Anchor to queryquery•
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 reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to savedSearchIdsaved•
Search Id The ID of a saved search. The search’s query string is used as the query argument.
- Anchor to sortKeysort•
Key GiftCard Sort KeysDefault:ID 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.
Anchor to Possible returnsPossible returns
- Anchor to edgesedges•[Gift
Card Edge!]!non-null The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.
- Anchor to nodesnodes•[Gift
Card!]!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.
- Anchor to pageInfopage•
Info PageInfo!non-null An object that’s used to retrieve cursor information about the current page.
Examples
1const { admin } = await authenticate.admin(request);23const response = await admin.graphql(4 `#graphql5 query {6 giftCards(first: 5, query: "status:enabled") {7 edges {8 node {9 id10 enabled11 }12 }13 }14 }`,15);1617const data = await response.json();18
query {
giftCards(first: 5, query: "status:enabled") {
edges {
node {
id
enabled
}
}
}
}
curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { giftCards(first: 5, query: \"status:enabled\") { edges { node { id enabled } } } }"
}'
const { admin } = await authenticate.admin(request);
const response = await admin.graphql(
`#graphql
query {
giftCards(first: 5, query: "status:enabled") {
edges {
node {
id
enabled
}
}
}
}`,
);
const data = await response.json();
const client = new shopify.clients.Graphql({session});
const data = await client.query({
data: `query {
giftCards(first: 5, query: "status:enabled") {
edges {
node {
id
enabled
}
}
}
}`,
});
session = ShopifyAPI::Auth::Session.new(
shop: "your-development-store.myshopify.com",
access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
session: session
)
query = <<~QUERY
query {
giftCards(first: 5, query: "status:enabled") {
edges {
node {
id
enabled
}
}
}
}
QUERY
response = client.query(query: query)
Response
JSON1{2 "giftCards": {3 "edges": [4 {5 "node": {6 "id": "gid://shopify/GiftCard/63396415",7 "enabled": true8 }9 },10 {11 "node": {12 "id": "gid://shopify/GiftCard/292935194",13 "enabled": true14 }15 },16 {17 "node": {18 "id": "gid://shopify/GiftCard/411106674",19 "enabled": true20 }21 },22 {23 "node": {24 "id": "gid://shopify/GiftCard/566141102",25 "enabled": true26 }27 },28 {29 "node": {30 "id": "gid://shopify/GiftCard/636946744",31 "enabled": true32 }33 }34 ]35 }36}