Choose a version:

codeDiscountNodeByCode

query

Requires Apps must have read_discounts access scope.

Retrieves a code discount by its discount code. The search is case-insensitive, enabling you to find discounts regardless of how customers enter the code.

Returns a DiscountCodeNode that contains the underlying discount details, which could be a basic amount off discount, a "Buy X Get Y" (BXGY) discount, a free shipping discount, or an app-provided discount.

Learn more about working with Shopify's discount model.

Anchor to Arguments

Arguments

Anchor to codecode •String! required: The case-insensitive code of the DiscountCodeNode to return.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to DiscountCodeNodeDiscountCodeNode

•DiscountCodeNode

The DiscountCodeNode object enables you to manage code discounts that are applied when customers enter a code at checkout. For example, 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. Or, you can offer discounts where customers have to enter a code to get free shipping. Merchants can create and share discount codes individually with customers.

Learn more about working with Shopify's discount model, including related queries, mutations, limitations, and considerations.

Show fields

Anchor to codeDiscountcodeDiscount

•DiscountCode!

non-null

The underlying code discount object.

Show union types

Anchor to eventsevents

•EventConnection!

non-null

The paginated list of events associated with the host subject.

Show fields

Arguments

Anchor to afterafter

•String

The elements that come after the specified cursor.

Anchor to beforebefore

•String

The elements that come before the specified cursor.

Anchor to firstfirst

•Int

The first n elements from the paginated list.

Anchor to lastlast

•Int

The last n elements from the paginated list.

Anchor to queryquery

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Show filters

Anchor to action •string: The action that occured.
Anchor to comments •boolean: Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events.
Anchor to created_at •time: Filter by the date and time when the event occurred. Event data is retained for 1 year.
Anchor to id •id: Filter by id range.
Anchor to subject_type •string: The resource type affected by this event. See EventSubjectType for possible values.

Anchor to reversereverse

•Boolean

Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey

•EventSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Show enum values

Anchor to idid

•ID!

non-null

A globally-unique ID.

Anchor to metafieldmetafield

•Metafield

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

Show fields

Anchor to keykey •String! required: The key for the metafield.
Anchor to namespacenamespace •String: The container the metafield belongs to. If omitted, the app-reserved namespace will be used.

Anchor to metafieldsmetafields

•MetafieldConnection!

non-null

A list of custom fields that a merchant associates with a Shopify resource.

Show fields

Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to keyskeys •[String!]: List of keys of metafields in the format namespace.key, will be returned in the same format.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to namespacenamespace •String: The metafield namespace to filter by. If omitted, all metafields are returned.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to metafieldDefinitionsmetafieldDefinitions

•MetafieldDefinitionConnection!

non-nullDeprecated

Show fields

Arguments

Anchor to afterafter

•String

The elements that come after the specified cursor.

Anchor to beforebefore

•String

The elements that come before the specified cursor.

Anchor to firstfirst

•Int

The first n elements from the paginated list.

Anchor to lastlast

•Int

The last n elements from the paginated list.

Anchor to namespacenamespace

•String

Filter metafield definitions by namespace.

Anchor to pinnedStatuspinnedStatus

•MetafieldDefinitionPinnedStatus

Default:ANY

Filter by the definition's pinned status.

Show enum values

Anchor to queryquery

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Show filters

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to created_at •time: Filter by the date and time when the metafield definition was created.
Anchor to id •id: Filter by id range.
Anchor to key •string: Filter by the metafield definition key field.
Anchor to namespace •string: Filter by the metafield definition namespace field.
Anchor to owner_type •string: Filter by the metafield definition ownerType field.
Anchor to type •string: Filter by the metafield definition type field.
Anchor to updated_at •time: Filter by the date and time when the metafield definition was last updated.

Anchor to reversereverse

•Boolean

Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey

•MetafieldDefinitionSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Show enum values

Was this section helpful?

Examples

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

query codeDiscountNodeByCode($code: String!) {
  codeDiscountNodeByCode(code: $code) {
    codeDiscount {
      __typename
      ... on DiscountCodeBasic {
        codesCount {
          count
        }
        shortSummary
      }
    }
    id
  }
}

Variables

{
  "code": "DISCOUNTAPPLICATIONSROCKS"
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query codeDiscountNodeByCode($code: String!) { codeDiscountNodeByCode(code: $code) { codeDiscount { __typename ... on DiscountCodeBasic { codesCount { count } shortSummary } } id } }",
 "variables": {
    "code": "DISCOUNTAPPLICATIONSROCKS"
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query codeDiscountNodeByCode($code: String!) {
    codeDiscountNodeByCode(code: $code) {
      codeDiscount {
        __typename
        ... on DiscountCodeBasic {
          codesCount {
            count
          }
          shortSummary
        }
      }
      id
    }
  }`,
  {
    variables: {
        "code": "DISCOUNTAPPLICATIONSROCKS"
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query codeDiscountNodeByCode($code: String!) {
    codeDiscountNodeByCode(code: $code) {
      codeDiscount {
        __typename
        ... on DiscountCodeBasic {
          codesCount {
            count
          }
          shortSummary
        }
      }
      id
    }
  }
QUERY

variables = {
  "code": "DISCOUNTAPPLICATIONSROCKS"
}

response = client.query(query: query, variables: variables)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `query codeDiscountNodeByCode($code: String!) {
      codeDiscountNodeByCode(code: $code) {
        codeDiscount {
          __typename
          ... on DiscountCodeBasic {
            codesCount {
              count
            }
            shortSummary
          }
        }
        id
      }
    }`,
    "variables": {
        "code": "DISCOUNTAPPLICATIONSROCKS"
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'query codeDiscountNodeByCode($code: String!) {
  codeDiscountNodeByCode(code: $code) {
    codeDiscount {
      __typename
      ... on DiscountCodeBasic {
        codesCount {
          count
        }
        shortSummary
      }
    }
    id
  }
}' \
--variables \
'{
  "code": "DISCOUNTAPPLICATIONSROCKS"
}'

Direct API Access

const response = await fetch('shopify:admin/api/2026-01/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      query codeDiscountNodeByCode($code: String!) {
        codeDiscountNodeByCode(code: $code) {
          codeDiscount {
            __typename
            ... on DiscountCodeBasic {
              codesCount {
                count
              }
              shortSummary
            }
          }
          id
        }
      }
    `,
    variables: {
        "code": "DISCOUNTAPPLICATIONSROCKS"
    },
  }),
});

const { data } = await response.json();
console.log(data);

Response

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

Search for a code discount by discount code

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

query codeDiscountNodeByCode($code: String!) {

codeDiscountNodeByCode(code: $code) {

codeDiscount {

__typename

... on DiscountCodeBasic {

codesCount {

count

}

shortSummary

}

}`,

{

variables: {

"code": "DISCOUNTAPPLICATIONSROCKS"

);

const json = await response.json();

return json.data;

}

GQL

query codeDiscountNodeByCode($code: String!) {
  codeDiscountNodeByCode(code: $code) {
    codeDiscount {
      __typename
      ... on DiscountCodeBasic {
        codesCount {
          count
        }
        shortSummary
      }
    }
    id
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query codeDiscountNodeByCode($code: String!) { codeDiscountNodeByCode(code: $code) { codeDiscount { __typename ... on DiscountCodeBasic { codesCount { count } shortSummary } } id } }",
 "variables": {
    "code": "DISCOUNTAPPLICATIONSROCKS"
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query codeDiscountNodeByCode($code: String!) {
    codeDiscountNodeByCode(code: $code) {
      codeDiscount {
        __typename
        ... on DiscountCodeBasic {
          codesCount {
            count
          }
          shortSummary
        }
      }
      id
    }
  }`,
  {
    variables: {
        "code": "DISCOUNTAPPLICATIONSROCKS"
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `query codeDiscountNodeByCode($code: String!) {
      codeDiscountNodeByCode(code: $code) {
        codeDiscount {
          __typename
          ... on DiscountCodeBasic {
            codesCount {
              count
            }
            shortSummary
          }
        }
        id
      }
    }`,
    "variables": {
        "code": "DISCOUNTAPPLICATIONSROCKS"
    },
  },
});

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query codeDiscountNodeByCode($code: String!) {
    codeDiscountNodeByCode(code: $code) {
      codeDiscount {
        __typename
        ... on DiscountCodeBasic {
          codesCount {
            count
          }
          shortSummary
        }
      }
      id
    }
  }
QUERY

variables = {
  "code": "DISCOUNTAPPLICATIONSROCKS"
}

response = client.query(query: query, variables: variables)

Shopify CLI

shopify app execute \
--query \
'query codeDiscountNodeByCode($code: String!) {
  codeDiscountNodeByCode(code: $code) {
    codeDiscount {
      __typename
      ... on DiscountCodeBasic {
        codesCount {
          count
        }
        shortSummary
      }
    }
    id
  }
}' \
--variables \
'{
  "code": "DISCOUNTAPPLICATIONSROCKS"
}'

Direct API Access

const response = await fetch('shopify:admin/api/2026-01/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      query codeDiscountNodeByCode($code: String!) {
        codeDiscountNodeByCode(code: $code) {
          codeDiscount {
            __typename
            ... on DiscountCodeBasic {
              codesCount {
                count
              }
              shortSummary
            }
          }
          id
        }
      }
    `,
    variables: {
        "code": "DISCOUNTAPPLICATIONSROCKS"
    },
  }),
});

const { data } = await response.json();
console.log(data);

Input variables

JSON

{

"code": "DISCOUNTAPPLICATIONSROCKS"

}

Response

JSON

{

"codeDiscountNodeByCode": {

"codeDiscount": {

"__typename": "DiscountCodeBasic",

"codesCount": {

"count": 1

"shortSummary": "$10.00 off Element (151cm)"

"id": "gid://shopify/DiscountCodeNode/573794601"

}