DiscountNode - admin-graphql - OBJECT

Version: 2024-10

Description:

The `DiscountNode` object enables you to manage [discounts](https://help.shopify.com/manual/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](https://shopify.dev/docs/apps/build/discounts#discount-classes), 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](https://shopify.dev/docs/apps/build/discounts), including related mutations, limitations, and considerations.

Access Scopes

Apps must have `read_discounts` access scope.

Fields

• 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: 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.

Connections

• events: EventConnection!
• metafieldDefinitions: MetafieldDefinitionConnection!
• metafields: MetafieldConnection!
• privateMetafields: PrivateMetafieldConnection!

Related queries

• discountNode Returns a discount resource by ID.
• discountNodes Returns a list of discounts.

Related mutations

Related Unions

• MetafieldReferencer Types of resources that may use metafields to reference other resources.

Examples

• 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 } ... on DiscountCodeBxgy { title } ... on DiscountCodeFreeShipping { title } ... on DiscountAutomaticApp { title } ... on DiscountAutomaticBasic { title } ... on DiscountAutomaticBxgy { title } ... on DiscountAutomaticFreeShipping { 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        }\n        ... on DiscountCodeBxgy {\n          title\n        }\n        ... on DiscountCodeFreeShipping {\n          title\n        }\n        ... on DiscountAutomaticApp {\n          title\n        }\n        ... on DiscountAutomaticBasic {\n          title\n        }\n        ... on DiscountAutomaticBxgy {\n          title\n        }\n        ... on DiscountAutomaticFreeShipping {\n          title\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        }\n        ... on DiscountCodeBxgy {\n          title\n        }\n        ... on DiscountCodeFreeShipping {\n          title\n        }\n        ... on DiscountAutomaticApp {\n          title\n        }\n        ... on DiscountAutomaticBasic {\n          title\n        }\n        ... on DiscountAutomaticBxgy {\n          title\n        }\n        ... on DiscountAutomaticFreeShipping {\n          title\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    discountNode(id: \"gid://shopify/DiscountAutomaticNode/299501151\") {\n      id\n      discount {\n        ... on DiscountCodeBasic {\n          title\n        }\n        ... on DiscountCodeBxgy {\n          title\n        }\n        ... on DiscountCodeFreeShipping {\n          title\n        }\n        ... on DiscountAutomaticApp {\n          title\n        }\n        ... on DiscountAutomaticBasic {\n          title\n        }\n        ... on DiscountAutomaticBxgy {\n          title\n        }\n        ... on DiscountAutomaticFreeShipping {\n          title\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    discountNode(id: \"gid://shopify/DiscountAutomaticNode/299501151\") {\n      id\n      discount {\n        ... on DiscountCodeBasic {\n          title\n        }\n        ... on DiscountCodeBxgy {\n          title\n        }\n        ... on DiscountCodeFreeShipping {\n          title\n        }\n        ... on DiscountAutomaticApp {\n          title\n        }\n        ... on DiscountAutomaticBasic {\n          title\n        }\n        ... on DiscountAutomaticBxgy {\n          title\n        }\n        ... on DiscountAutomaticFreeShipping {\n          title\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      }\n      ... on DiscountCodeBxgy {\n        title\n      }\n      ... on DiscountCodeFreeShipping {\n        title\n      }\n      ... on DiscountAutomaticApp {\n        title\n      }\n      ... on DiscountAutomaticBasic {\n        title\n      }\n      ... on DiscountAutomaticBxgy {\n        title\n      }\n      ... on DiscountAutomaticFreeShipping {\n        title\n      }\n    }\n  }\n}"
        

  input: null

  response: {
    "data": {
      "discountNode": {
        "id": "gid://shopify/DiscountAutomaticNode/299501151",
        "discount": {
          "title": "My automatic discount"
        }
      }
    }
  }

  Retrieves a single price rule

          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 DiscountShow($id: ID!) { discountNode(id: $id) { 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 \"variables\": {\n    \"id\": \"gid://shopify/DiscountNode/299501151\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `query DiscountShow($id: ID!) {\n      discountNode(id: $id) {\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    \"variables\": {\n      \"id\": \"gid://shopify/DiscountNode/299501151\"\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 DiscountShow($id: ID!) {\n    discountNode(id: $id) {\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\nvariables = {\n  \"id\": \"gid://shopify/DiscountNode/299501151\"\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query DiscountShow($id: ID!) {\n    discountNode(id: $id) {\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\n$variables = [\n  \"id\" => \"gid://shopify/DiscountNode/299501151\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query DiscountShow($id: ID!) {\n    discountNode(id: $id) {\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    variables: {\n      \"id\": \"gid://shopify/DiscountNode/299501151\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "query DiscountShow($id: ID!) {\n  discountNode(id: $id) {\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}"
        

  input: {
    "id": "gid://shopify/DiscountNode/299501151"
  }

  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"
        }
      }
    }
  }