Choose a version:

automaticDiscountNode

query

Returns a DiscountAutomaticNode resource by ID.

Anchor to Arguments

Arguments

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

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to DiscountAutomaticNodeDiscountAutomaticNode

•DiscountAutomaticNode

The DiscountAutomaticNode object enables you to manage automatic discounts that are applied when an order meets specific criteria. You can create amount off, free shipping, or buy X get Y automatic discounts. For example, you can offer customers a free shipping discount that applies when conditions are met. Or you can offer customers a buy X get Y discount that's automatically applied when customers spend a specified amount of money, or a specified quantity of products.

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

Anchor to automaticDiscountautomaticDiscount

•DiscountAutomatic!

non-null

A discount that's applied automatically when an order meets specific criteria. Learn more about automatic discounts.

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, all metafields are returned.
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 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

Retrieve a buy X get Y automatic discount by its ID

Description

Retrieve a [buy X get Y](https://help.shopify.com/manual/discounts/discount-types/buy-x-get-y) discount that's automatically applied on a cart and at checkout when an order meets specific criteria.

Query

query {
  automaticDiscountNode(id: "gid://shopify/DiscountAutomaticNode/1057371284") {
    id
    automaticDiscount {
      ... on DiscountAutomaticBxgy {
        title
        status
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { automaticDiscountNode(id: \"gid://shopify/DiscountAutomaticNode/1057371284\") { id automaticDiscount { ... on DiscountAutomaticBxgy { title status } } } }"
}'

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 {
    automaticDiscountNode(id: "gid://shopify/DiscountAutomaticNode/1057371284") {
      id
      automaticDiscount {
        ... on DiscountAutomaticBxgy {
          title
          status
        }
      }
    }
  }`,
  );
  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 {
    automaticDiscountNode(id: "gid://shopify/DiscountAutomaticNode/1057371284") {
      id
      automaticDiscount {
        ... on DiscountAutomaticBxgy {
          title
          status
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    automaticDiscountNode(id: "gid://shopify/DiscountAutomaticNode/1057371284") {
      id
      automaticDiscount {
        ... on DiscountAutomaticBxgy {
          title
          status
        }
      }
    }
  }`,
});

Response

{
  "automaticDiscountNode": {
    "id": "gid://shopify/DiscountAutomaticNode/1057371284",
    "automaticDiscount": {
      "title": "An automatic bogo discount",
      "status": "SCHEDULED"
    }
  }
}

Retrieve an automatic discount by its ID

Description

Retrieve an automatic discount that's managed by an app using [Shopify Functions](https://shopify.dev/docs/apps/build/functions).

Query

query {
  automaticDiscountNode(id: "gid://shopify/DiscountAutomaticNode/1057371285") {
    id
    automaticDiscount {
      ... on DiscountAutomaticApp {
        title
        status
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { automaticDiscountNode(id: \"gid://shopify/DiscountAutomaticNode/1057371285\") { id automaticDiscount { ... on DiscountAutomaticApp { title status } } } }"
}'

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 {
    automaticDiscountNode(id: "gid://shopify/DiscountAutomaticNode/1057371285") {
      id
      automaticDiscount {
        ... on DiscountAutomaticApp {
          title
          status
        }
      }
    }
  }`,
  );
  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 {
    automaticDiscountNode(id: "gid://shopify/DiscountAutomaticNode/1057371285") {
      id
      automaticDiscount {
        ... on DiscountAutomaticApp {
          title
          status
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    automaticDiscountNode(id: "gid://shopify/DiscountAutomaticNode/1057371285") {
      id
      automaticDiscount {
        ... on DiscountAutomaticApp {
          title
          status
        }
      }
    }
  }`,
});

Response

{
  "automaticDiscountNode": {
    "id": "gid://shopify/DiscountAutomaticNode/1057371285",
    "automaticDiscount": {
      "title": "An automatic app discount",
      "status": "ACTIVE"
    }
  }
}

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 {

automaticDiscountNode(id: "gid://shopify/DiscountAutomaticNode/1057371284") {

automaticDiscount {

... on DiscountAutomaticBxgy {

title

status

}

}`,

);

const json = await response.json();

return json.data;

}

GQL

query {
  automaticDiscountNode(id: "gid://shopify/DiscountAutomaticNode/1057371284") {
    id
    automaticDiscount {
      ... on DiscountAutomaticBxgy {
        title
        status
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { automaticDiscountNode(id: \"gid://shopify/DiscountAutomaticNode/1057371284\") { id automaticDiscount { ... on DiscountAutomaticBxgy { title status } } } }"
}'

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 {
    automaticDiscountNode(id: "gid://shopify/DiscountAutomaticNode/1057371284") {
      id
      automaticDiscount {
        ... on DiscountAutomaticBxgy {
          title
          status
        }
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    automaticDiscountNode(id: "gid://shopify/DiscountAutomaticNode/1057371284") {
      id
      automaticDiscount {
        ... on DiscountAutomaticBxgy {
          title
          status
        }
      }
    }
  }`,
});

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 {
    automaticDiscountNode(id: "gid://shopify/DiscountAutomaticNode/1057371284") {
      id
      automaticDiscount {
        ... on DiscountAutomaticBxgy {
          title
          status
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

{

"automaticDiscountNode": {

"id": "gid://shopify/DiscountAutomaticNode/1057371284",

"automaticDiscount": {

"title": "An automatic bogo discount",

"status": "SCHEDULED"

}