# discountNode - admin - QUERY Version: 2024-10 ## Description Returns a discount resource by ID. ### Access Scopes ## Arguments * [id](/docs/api/admin/2024-10/scalars/ID): ID! - The ID of the `DiscountNode` to return. ## Returns * [discount](/docs/api/admin/2024-10/unions/Discount): Discount! A discount that's applied at checkout or on cart. Discounts can be [automatic or code-based](https://shopify.dev/docs/apps/build/discounts#discount-methods). * [id](/docs/api/admin/2024-10/scalars/ID): ID! A globally-unique ID. * [metafield](/docs/api/admin/2024-10/objects/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](/docs/api/admin/2024-10/objects/PrivateMetafield): PrivateMetafield Returns a private metafield by namespace and key that belongs to the resource. ## Examples ### Querying a non-existent discount returns null Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query { discountNode(id: \\\"gid://shopify/DiscountNode/999999999\\\") { id } }\"\n}'\n" Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: `query {\n discountNode(id: \"gid://shopify/DiscountNode/999999999\") {\n id\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 discountNode(id: \"gid://shopify/DiscountNode/999999999\") {\n id\n }\n }\nQUERY\n\nresponse = client.query(query: query)\n" Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n query {\n discountNode(id: \"gid://shopify/DiscountNode/999999999\") {\n id\n }\n }`,\n);\n\nconst data = await response.json();\n" Graphql query: "query {\n discountNode(id: \"gid://shopify/DiscountNode/999999999\") {\n id\n }\n}" #### Graphql Input null #### Graphql Response { "data": { "discountNode": null } } ### Retrieve a discount by its ID Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"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 } } } } }\"\n}'\n" Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: `query {\n discountNode(id: \"gid://shopify/DiscountAutomaticNode/299501151\") {\n id\n discount {\n ... on DiscountCodeBasic {\n title\n summary\n status\n codes(first: 1) {\n nodes {\n code\n }\n }\n }\n ... on DiscountAutomaticBasic {\n title\n summary\n status\n }\n ... on DiscountCodeBxgy {\n title\n summary\n status\n codes(first: 1) {\n nodes {\n code\n }\n }\n }\n ... on DiscountAutomaticBxgy {\n title\n summary\n status\n }\n ... on DiscountCodeFreeShipping {\n title\n summary\n status\n codes(first: 1) {\n nodes {\n code\n }\n }\n }\n ... on DiscountCodeApp {\n title\n status\n appDiscountType {\n title\n }\n codes(first: 1) {\n nodes {\n code\n }\n }\n }\n ... on DiscountAutomaticApp {\n title\n status\n appDiscountType {\n title\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 discountNode(id: \"gid://shopify/DiscountAutomaticNode/299501151\") {\n id\n discount {\n ... on DiscountCodeBasic {\n title\n summary\n status\n codes(first: 1) {\n nodes {\n code\n }\n }\n }\n ... on DiscountAutomaticBasic {\n title\n summary\n status\n }\n ... on DiscountCodeBxgy {\n title\n summary\n status\n codes(first: 1) {\n nodes {\n code\n }\n }\n }\n ... on DiscountAutomaticBxgy {\n title\n summary\n status\n }\n ... on DiscountCodeFreeShipping {\n title\n summary\n status\n codes(first: 1) {\n nodes {\n code\n }\n }\n }\n ... on DiscountCodeApp {\n title\n status\n appDiscountType {\n title\n }\n codes(first: 1) {\n nodes {\n code\n }\n }\n }\n ... on DiscountAutomaticApp {\n title\n status\n appDiscountType {\n title\n }\n }\n }\n }\n }\nQUERY\n\nresponse = client.query(query: query)\n" Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n query {\n discountNode(id: \"gid://shopify/DiscountAutomaticNode/299501151\") {\n id\n discount {\n ... on DiscountCodeBasic {\n title\n summary\n status\n codes(first: 1) {\n nodes {\n code\n }\n }\n }\n ... on DiscountAutomaticBasic {\n title\n summary\n status\n }\n ... on DiscountCodeBxgy {\n title\n summary\n status\n codes(first: 1) {\n nodes {\n code\n }\n }\n }\n ... on DiscountAutomaticBxgy {\n title\n summary\n status\n }\n ... on DiscountCodeFreeShipping {\n title\n summary\n status\n codes(first: 1) {\n nodes {\n code\n }\n }\n }\n ... on DiscountCodeApp {\n title\n status\n appDiscountType {\n title\n }\n codes(first: 1) {\n nodes {\n code\n }\n }\n }\n ... on DiscountAutomaticApp {\n title\n status\n appDiscountType {\n title\n }\n }\n }\n }\n }`,\n);\n\nconst data = await response.json();\n" Graphql query: "query {\n discountNode(id: \"gid://shopify/DiscountAutomaticNode/299501151\") {\n id\n discount {\n ... on DiscountCodeBasic {\n title\n summary\n status\n codes(first: 1) {\n nodes {\n code\n }\n }\n }\n ... on DiscountAutomaticBasic {\n title\n summary\n status\n }\n ... on DiscountCodeBxgy {\n title\n summary\n status\n codes(first: 1) {\n nodes {\n code\n }\n }\n }\n ... on DiscountAutomaticBxgy {\n title\n summary\n status\n }\n ... on DiscountCodeFreeShipping {\n title\n summary\n status\n codes(first: 1) {\n nodes {\n code\n }\n }\n }\n ... on DiscountCodeApp {\n title\n status\n appDiscountType {\n title\n }\n codes(first: 1) {\n nodes {\n code\n }\n }\n }\n ... on DiscountAutomaticApp {\n title\n status\n appDiscountType {\n title\n }\n }\n }\n }\n}" #### Graphql Input null #### Graphql Response { "data": { "discountNode": { "id": "gid://shopify/DiscountAutomaticNode/299501151", "discount": { "title": "My automatic discount", "summary": "$100.00 off entire order • Minimum quantity of 1", "status": "SCHEDULED" } } } }