Choose a version:

discountNode

query

Returns a discount resource by ID.

Arguments

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

Was this section helpful?

Anchor to Possible returnsPossible returns

DiscountNode

•

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.

discount• Discount! non-null: A discount that's applied at checkout or on cart.

Discounts can be automatic or code-based.
events • EventConnection! non-null: The paginated list of events associated with the host subject.
id• ID! non-null: A globally-unique ID.
metafield• 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.
metafields • MetafieldConnection! non-null: A list of custom fields that a merchant associates with a Shopify resource.
metafieldDefinitions • MetafieldDefinitionConnection! non-nullDeprecated: List of metafield definitions. This field will be removed in a future version. Use the root metafieldDefinitions field instead.
privateMetafield• PrivateMetafield Deprecated: Returns a private metafield by namespace and key that belongs to the resource. Metafields created using a reserved namespace are private by default. See our guide for migrating private metafields.
privateMetafields • PrivateMetafieldConnection! non-nullDeprecated: List of private metafields that belong to the resource. Metafields created using a reserved namespace are private by default. See our guide for migrating private metafields.

Was this section helpful?

Querying a non-existent discount returns null
Retrieve a discount by its ID

Examples

Open in GraphiQL

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

const response = await admin.graphql(

`#graphql

query {

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

}

}`,

);

const data = await response.json();

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

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

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

const response = await admin.graphql(
  `#graphql
  query {
    discountNode(id: "gid://shopify/DiscountNode/999999999") {
      id
    }
  }`,
);

const data = await response.json();

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

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

}