priceRule

queryDeprecated

Returns a code price rule resource by ID. Use codeDiscountNode instead.

Arguments

Anchor to idid • ID!required: The ID of the PriceRule to return.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to PriceRulePriceRule • PriceRule: Price rules are a set of conditions, including entitlements and prerequisites, that must be met in order for a discount code to apply.

We recommend using the types and queries detailed at Getting started with discounts instead. These will replace the GraphQL PriceRule object and REST Admin PriceRule and DiscountCode resources.

Was this section helpful?

Retrieve a price rule by its ID

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  query GetPriceRule($id: ID!) {
6    priceRule(id: $id) {
7      id
8      title
9      status
10    }
11  }`,
12  {
13    variables: {
14      "id": "gid://shopify/PriceRule/1057371215"
15    },
16  },
17);
18
19const data = await response.json();
20

query GetPriceRule($id: ID!) {
  priceRule(id: $id) {
    id
    title
    status
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query GetPriceRule($id: ID!) { priceRule(id: $id) { id title status } }",
 "variables": {
    "id": "gid://shopify/PriceRule/1057371215"
  }
}'

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

const response = await admin.graphql(
  `#graphql
  query GetPriceRule($id: ID!) {
    priceRule(id: $id) {
      id
      title
      status
    }
  }`,
  {
    variables: {
      "id": "gid://shopify/PriceRule/1057371215"
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `query GetPriceRule($id: ID!) {
      priceRule(id: $id) {
        id
        title
        status
      }
    }`,
    "variables": {
      "id": "gid://shopify/PriceRule/1057371215"
    },
  },
});

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 GetPriceRule($id: ID!) {
    priceRule(id: $id) {
      id
      title
      status
    }
  }
QUERY

variables = {
  "id": "gid://shopify/PriceRule/1057371215"
}

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

Input variables

JSON

1{
2  "id": "gid://shopify/PriceRule/1057371215"
3}

Response

JSON

1{
2  "priceRule": {
3    "id": "gid://shopify/PriceRule/1057371215",
4    "title": "PROTABO",
5    "status": "ACTIVE"
6  }
7}