Choose a version:

discountNode

query

Returns a DiscountNode resource by ID.

Anchor to Arguments

Arguments

Anchor to idid •ID! required: The ID of the DiscountNode to return.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to DiscountNodeDiscountNode

•DiscountNode

The DiscountNode object enables you to manage discounts, which are applied at checkout or on a cart.

Discounts are a way for merchants to promote sales and special offers, or as customer loyalty rewards. Discounts can apply to orders, products, or shipping, and can be either automatic or code-based. For example, you can offer customers a buy X get Y discount that's automatically applied when purchases meet specific criteria. Or, you can offer discounts where customers have to enter a code to redeem an amount off discount on products, variants, or collections in a store.

Learn more about working with Shopify's discount model, including related mutations, limitations, and considerations.

Anchor to discountdiscount

•Discount!

non-null

A discount that's applied at checkout or on cart.

Discounts can be automatic or code-based.

Anchor to eventsevents

•EventConnection!

non-null

The paginated list of events associated with the host subject.

Arguments

Anchor to firstfirst

•Int

The first n elements from the paginated list.

Anchor to afterafter

•String

The elements that come after the specified cursor.

Anchor to lastlast

•Int

The last n elements from the paginated list.

Anchor to beforebefore

•String

The elements that come before the specified cursor.

Anchor to reversereverse

•Boolean

Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey

•EventSortKeys

Default: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 queryquery

•String

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 action •string: The action that occured.
Anchor to comments •boolean: Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events.
Anchor to created_at •time: Filter by the date and time when the event happened.
Anchor to id •id: Filter by id range.
Anchor to subject_type •string: The resource type affected by this event. See EventSubjectType for possible values.

Anchor to idid

•ID!

non-null

A globally-unique ID.

Anchor to metafieldmetafield

•Metafield

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

Anchor to namespacenamespace •String: The container the metafield belongs to. If omitted, the app-reserved namespace will be used.
Anchor to keykey •String! required: The key for the metafield.

Anchor to metafieldsmetafields

•MetafieldConnection!

non-null

A list of custom fields that a merchant associates with a Shopify resource.

Anchor to namespacenamespace •String: The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.
Anchor to keyskeys •[String!]: List of keys of metafields in the format namespace.key, will be returned in the same format.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to metafieldsByIdentifiersmetafieldsByIdentifiers

•[Metafield]!

non-null

The metafields associated with the resource matching the supplied list of namespaces and keys.

Arguments

Anchor to identifiersidentifiers

•[HasMetafieldsIdentifier!]!

required

The list of metafields to retrieve by namespace and key.

Anchor to metafieldDefinitionsmetafieldDefinitions

•MetafieldDefinitionConnection!

non-nullDeprecated

Arguments

Anchor to namespacenamespace

•String

Filter metafield definitions by namespace.

Anchor to pinnedStatuspinnedStatus

•MetafieldDefinitionPinnedStatus

Default:ANY

Filter by the definition's pinned status.

Anchor to firstfirst

•Int

The first n elements from the paginated list.

Anchor to afterafter

•String

The elements that come after the specified cursor.

Anchor to lastlast

•Int

The last n elements from the paginated list.

Anchor to beforebefore

•String

The elements that come before the specified cursor.

Anchor to reversereverse

•Boolean

Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey

•MetafieldDefinitionSortKeys

Default: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 queryquery

•String

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: Filter by a case-insensitive search of multiple fields in a document.
Anchor to created_at •time: Filter by the date and time when the metafield definition was created.
Anchor to id •id: Filter by id range.
Anchor to key •string: Filter by the metafield definition key field.
Anchor to namespace •string: Filter by the metafield definition namespace field.
Anchor to owner_type •string: Filter by the metafield definition ownerType field.
Anchor to type •string: Filter by the metafield definition type field.
Anchor to updated_at •time: Filter by the date and time when the metafield definition was last updated.

Was this section helpful?

Examples

Querying a non-existent discount returns null

Description

This example shows the response that's returned when you query a discount that doesn't exist.

Query

query {
  discountNode(id: "gid://shopify/DiscountNode/999999999") {
    id
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { discountNode(id: \"gid://shopify/DiscountNode/999999999\") { id } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query {
    discountNode(id: "gid://shopify/DiscountNode/999999999") {
      id
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Ruby

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 {
    discountNode(id: "gid://shopify/DiscountNode/999999999") {
      id
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    discountNode(id: "gid://shopify/DiscountNode/999999999") {
      id
    }
  }`,
});

Response

{
  "discountNode": null
}

Retrieve a discount by its ID

Description

Retrieve a [discount](https://help.shopify.com/manual/discounts) that's applied on a cart and at checkout when an order meets specific criteria.

Query

query {
  discountNode(id: "gid://shopify/DiscountAutomaticNode/299501151") {
    id
    discount {
      ... on DiscountCodeBasic {
        title
        summary
        status
        codes(first: 1) {
          nodes {
            code
          }
        }
      }
      ... on DiscountAutomaticBasic {
        title
        summary
        status
      }
      ... on DiscountCodeBxgy {
        title
        summary
        status
        codes(first: 1) {
          nodes {
            code
          }
        }
      }
      ... on DiscountAutomaticBxgy {
        title
        summary
        status
      }
      ... on DiscountCodeFreeShipping {
        title
        summary
        status
        codes(first: 1) {
          nodes {
            code
          }
        }
      }
      ... on DiscountCodeApp {
        title
        status
        appDiscountType {
          title
        }
        codes(first: 1) {
          nodes {
            code
          }
        }
      }
      ... on DiscountAutomaticApp {
        title
        status
        appDiscountType {
          title
        }
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { discountNode(id: \"gid://shopify/DiscountAutomaticNode/299501151\") { id discount { ... on DiscountCodeBasic { title summary status codes(first: 1) { nodes { code } } } ... on DiscountAutomaticBasic { title summary status } ... on DiscountCodeBxgy { title summary status codes(first: 1) { nodes { code } } } ... on DiscountAutomaticBxgy { title summary status } ... on DiscountCodeFreeShipping { title summary status codes(first: 1) { nodes { code } } } ... on DiscountCodeApp { title status appDiscountType { title } codes(first: 1) { nodes { code } } } ... on DiscountAutomaticApp { title status appDiscountType { title } } } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query {
    discountNode(id: "gid://shopify/DiscountAutomaticNode/299501151") {
      id
      discount {
        ... on DiscountCodeBasic {
          title
          summary
          status
          codes(first: 1) {
            nodes {
              code
            }
          }
        }
        ... on DiscountAutomaticBasic {
          title
          summary
          status
        }
        ... on DiscountCodeBxgy {
          title
          summary
          status
          codes(first: 1) {
            nodes {
              code
            }
          }
        }
        ... on DiscountAutomaticBxgy {
          title
          summary
          status
        }
        ... on DiscountCodeFreeShipping {
          title
          summary
          status
          codes(first: 1) {
            nodes {
              code
            }
          }
        }
        ... on DiscountCodeApp {
          title
          status
          appDiscountType {
            title
          }
          codes(first: 1) {
            nodes {
              code
            }
          }
        }
        ... on DiscountAutomaticApp {
          title
          status
          appDiscountType {
            title
          }
        }
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Ruby

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 {
    discountNode(id: "gid://shopify/DiscountAutomaticNode/299501151") {
      id
      discount {
        ... on DiscountCodeBasic {
          title
          summary
          status
          codes(first: 1) {
            nodes {
              code
            }
          }
        }
        ... on DiscountAutomaticBasic {
          title
          summary
          status
        }
        ... on DiscountCodeBxgy {
          title
          summary
          status
          codes(first: 1) {
            nodes {
              code
            }
          }
        }
        ... on DiscountAutomaticBxgy {
          title
          summary
          status
        }
        ... on DiscountCodeFreeShipping {
          title
          summary
          status
          codes(first: 1) {
            nodes {
              code
            }
          }
        }
        ... on DiscountCodeApp {
          title
          status
          appDiscountType {
            title
          }
          codes(first: 1) {
            nodes {
              code
            }
          }
        }
        ... on DiscountAutomaticApp {
          title
          status
          appDiscountType {
            title
          }
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    discountNode(id: "gid://shopify/DiscountAutomaticNode/299501151") {
      id
      discount {
        ... on DiscountCodeBasic {
          title
          summary
          status
          codes(first: 1) {
            nodes {
              code
            }
          }
        }
        ... on DiscountAutomaticBasic {
          title
          summary
          status
        }
        ... on DiscountCodeBxgy {
          title
          summary
          status
          codes(first: 1) {
            nodes {
              code
            }
          }
        }
        ... on DiscountAutomaticBxgy {
          title
          summary
          status
        }
        ... on DiscountCodeFreeShipping {
          title
          summary
          status
          codes(first: 1) {
            nodes {
              code
            }
          }
        }
        ... on DiscountCodeApp {
          title
          status
          appDiscountType {
            title
          }
          codes(first: 1) {
            nodes {
              code
            }
          }
        }
        ... on DiscountAutomaticApp {
          title
          status
          appDiscountType {
            title
          }
        }
      }
    }
  }`,
});

Response

{
  "discountNode": {
    "id": "gid://shopify/DiscountAutomaticNode/299501151",
    "discount": {
      "title": "My automatic discount",
      "summary": "$100.00 off entire order • Minimum quantity of 1",
      "status": "SCHEDULED"
    }
  }
}

Examples

Open in GraphiQL

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

query {

discountNode(id: "gid://shopify/DiscountNode/999999999") {

}

}`,

);

const json = await response.json();

return json.data;

}

GQL

query {
  discountNode(id: "gid://shopify/DiscountNode/999999999") {
    id
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { discountNode(id: \"gid://shopify/DiscountNode/999999999\") { id } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query {
    discountNode(id: "gid://shopify/DiscountNode/999999999") {
      id
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    discountNode(id: "gid://shopify/DiscountNode/999999999") {
      id
    }
  }`,
});

Ruby

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 {
    discountNode(id: "gid://shopify/DiscountNode/999999999") {
      id
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

{

"discountNode": null

}