codeDiscountNodeByCode - admin-graphql - QUERY

Version: 2024-10

Description:

Returns a code discount identified by its discount code.

Access Scopes

Apps must have `read_discounts` access scope.

Arguments

• code: String! - The case-insensitive code of the `DiscountCodeNode` to return.

Returns

• codeDiscount: DiscountCode! The underlying code discount object.
• 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

• Search for a code discount by discount code

          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 codeDiscountNodeByCode($code: String!) { codeDiscountNodeByCode(code: $code) { codeDiscount { __typename ... on DiscountCodeBasic { codesCount { count } shortSummary } } id } }\",\n \"variables\": {\n    \"code\": \"DISCOUNTAPPLICATIONSROCKS\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `query codeDiscountNodeByCode($code: String!) {\n      codeDiscountNodeByCode(code: $code) {\n        codeDiscount {\n          __typename\n          ... on DiscountCodeBasic {\n            codesCount {\n              count\n            }\n            shortSummary\n          }\n        }\n        id\n      }\n    }`,\n    \"variables\": {\n      \"code\": \"DISCOUNTAPPLICATIONSROCKS\"\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 codeDiscountNodeByCode($code: String!) {\n    codeDiscountNodeByCode(code: $code) {\n      codeDiscount {\n        __typename\n        ... on DiscountCodeBasic {\n          codesCount {\n            count\n          }\n          shortSummary\n        }\n      }\n      id\n    }\n  }\nQUERY\n\nvariables = {\n  \"code\": \"DISCOUNTAPPLICATIONSROCKS\"\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 = << \"DISCOUNTAPPLICATIONSROCKS\",\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 codeDiscountNodeByCode($code: String!) {\n    codeDiscountNodeByCode(code: $code) {\n      codeDiscount {\n        __typename\n        ... on DiscountCodeBasic {\n          codesCount {\n            count\n          }\n          shortSummary\n        }\n      }\n      id\n    }\n  }`,\n  {\n    variables: {\n      \"code\": \"DISCOUNTAPPLICATIONSROCKS\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "query codeDiscountNodeByCode($code: String!) {\n  codeDiscountNodeByCode(code: $code) {\n    codeDiscount {\n      __typename\n      ... on DiscountCodeBasic {\n        codesCount {\n          count\n        }\n        shortSummary\n      }\n    }\n    id\n  }\n}"
        

  input: {
    "code": "DISCOUNTAPPLICATIONSROCKS"
  }

  response: {
    "data": {
      "codeDiscountNodeByCode": {
        "codeDiscount": {
          "__typename": "DiscountCodeBasic",
          "codesCount": {
            "count": 1
          },
          "shortSummary": "$10.00 off Element (151cm)"
        },
        "id": "gid://shopify/DiscountCodeNode/573794601"
      }
    }
  }