Choose a version:

automaticDiscountNode

query

Returns an automatic discount resource by ID.

Arguments

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

Was this section helpful?

Anchor to Possible returnsPossible returns

DiscountAutomaticNode

•

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.

automaticDiscount• DiscountAutomatic! non-null: A discount that's applied automatically when an order meets specific criteria. Learn more about automatic discounts.
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-null: List of metafield definitions.
privateMetafield• PrivateMetafield: Returns a private metafield by namespace and key that belongs to the resource.
privateMetafields • PrivateMetafieldConnection! non-null: List of private metafields that belong to the resource.

Was this section helpful?

Retrieve a buy X get Y automatic discount by its ID
Retrieve an automatic discount by its ID

Examples

Open in GraphiQL

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 data = await response.json();

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

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-07/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 } } } }"
}'

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 data = await response.json();

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
        }
      }
    }
  }`,
});

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"

}