code Discount Node By Codequery
query
2024-10latest
Requires Apps must have read
access scope.
Returns a code discount identified by its discount code.
Arguments
The case-insensitive code of the
Discount
to return.Code Node
Was this section helpful?
DiscountCodeNode possible returns
A node containing a code discount and its related events.
Was this section helpful?
Code examples for QUERY: codeDiscountNodeByCode
Query Reference for QUERY: codeDiscountNodeByCode
"{\n codeDiscountNodeByCode(code) {\n # DiscountCodeNode fields\n }\n}"
Input Reference for QUERY: codeDiscountNodeByCode
Schema Reference for QUERY: codeDiscountNodeByCode
Display Examples for QUERY: codeDiscountNodeByCode
[ { "example": { "type_name": "codediscountnodebycode", "title": "Search for a code discount by discount code", "description": "Searching for a code discount by a valid discount code will return the code discount.", "query_string": "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}", "variables": { "code": "DISCOUNTAPPLICATIONSROCKS" }, "response": { "data": { "codeDiscountNodeByCode": { "codeDiscount": { "__typename": "DiscountCodeBasic", "codesCount": { "count": 1 }, "shortSummary": "$10.00 off Element (151cm)" }, "id": "gid://shopify/DiscountCodeNode/573794601" } } }, "api_name": "admin", "minimum_api_version": "2024-04", "maximum_api_version": "unstable", "location": "/components/platform/admin/test/unit/graph_api/admin/query_root_test.rb", "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", "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", "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", "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", "php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<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\n$variables = [\n \"code\" => \"DISCOUNTAPPLICATIONSROCKS\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n" }, "titleStringKey": "arguments", "inputVariableEntries": [] } ]