automaticDiscountNode - admin-graphql - QUERY

Version: 2024-07

Description:

Returns an automatic discount resource by ID.

Access Scopes

Arguments

• id: ID! - The ID of the `DiscountAutomaticNode` to return.

Returns

• automaticDiscount: DiscountAutomatic! A discount that's applied automatically when an order meets specific criteria. Learn more about [automatic discounts](https://help.shopify.com/manual/discounts/discount-types#automatic-discounts).
• id: ID! A globally-unique ID.
• metafield: Metafield A [custom field](https://shopify.dev/docs/apps/build/custom-data), including its `namespace` and `key`, that's associated with a Shopify resource for the purposes of adding and storing additional information.
• privateMetafield: PrivateMetafield Returns a private metafield by namespace and key that belongs to the resource.

Examples

• #automaticDiscountNode returns an automatic discount node for a given ID

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query { automaticDiscountNode(id: \\\"gid://shopify/DiscountAutomaticNode/299501151\\\") { ... on DiscountAutomaticNode { id } automaticDiscount { ... on DiscountAutomaticBasic { title summary customerGets { items { ... on AllDiscountItems { allItems } } } } } } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query {\n    automaticDiscountNode(id: \"gid://shopify/DiscountAutomaticNode/299501151\") {\n      ... on DiscountAutomaticNode {\n        id\n      }\n      automaticDiscount {\n        ... on DiscountAutomaticBasic {\n          title\n          summary\n          customerGets {\n            items {\n              ... on AllDiscountItems {\n                allItems\n              }\n            }\n          }\n        }\n      }\n    }\n  }`,\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query {\n    automaticDiscountNode(id: \"gid://shopify/DiscountAutomaticNode/299501151\") {\n      ... on DiscountAutomaticNode {\n        id\n      }\n      automaticDiscount {\n        ... on DiscountAutomaticBasic {\n          title\n          summary\n          customerGets {\n            items {\n              ... on AllDiscountItems {\n                allItems\n              }\n            }\n          }\n        }\n      }\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query {\n    automaticDiscountNode(id: \"gid://shopify/DiscountAutomaticNode/299501151\") {\n      ... on DiscountAutomaticNode {\n        id\n      }\n      automaticDiscount {\n        ... on DiscountAutomaticBasic {\n          title\n          summary\n          customerGets {\n            items {\n              ... on AllDiscountItems {\n                allItems\n              }\n            }\n          }\n        }\n      }\n    }\n  }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query {\n    automaticDiscountNode(id: \"gid://shopify/DiscountAutomaticNode/299501151\") {\n      ... on DiscountAutomaticNode {\n        id\n      }\n      automaticDiscount {\n        ... on DiscountAutomaticBasic {\n          title\n          summary\n          customerGets {\n            items {\n              ... on AllDiscountItems {\n                allItems\n              }\n            }\n          }\n        }\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query {\n  automaticDiscountNode(id: \"gid://shopify/DiscountAutomaticNode/299501151\") {\n    ... on DiscountAutomaticNode {\n      id\n    }\n    automaticDiscount {\n      ... on DiscountAutomaticBasic {\n        title\n        summary\n        customerGets {\n          items {\n            ... on AllDiscountItems {\n              allItems\n            }\n          }\n        }\n      }\n    }\n  }\n}"
        

  input: null

  response: {
    "data": {
      "automaticDiscountNode": {
        "id": "gid://shopify/DiscountAutomaticNode/299501151",
        "automaticDiscount": {
          "title": "My automatic discount",
          "summary": "$100.00 off entire order • Minimum quantity of 1",
          "customerGets": {
            "items": {
              "allItems": true
            }
          }
        }
      }
    }
  }