priceRule
query
deprecated

Choose a version:

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

Anchor to section titled 'Arguments'

Arguments

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

Was this section helpful?

Anchor to section titled 'PriceRule possible returns'

PriceRule possible returns

Anchor to PriceRule PriceRule 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?

Code examples for QUERY: priceRule

Query Reference for QUERY: priceRule

"{\n  priceRule(id) {\n    # PriceRule fields\n  }\n}"

Input Reference for QUERY: priceRule

Schema Reference for QUERY: priceRule

Display Examples for QUERY: priceRule

[
  {
    "example": {
      "type_name": "pricerule",
      "title": "Retrieve a price rule by its ID",
      "query_string": "query GetPriceRule($id: ID!) {\n  priceRule(id: $id) {\n    id\n    title\n    status\n  }\n}",
      "variables": {
        "id": "gid://shopify/PriceRule/1057371215"
      },
      "response": {
        "data": {
          "priceRule": {
            "id": "gid://shopify/PriceRule/1057371215",
            "title": "PROTABO",
            "status": "ACTIVE"
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "2023-10",
      "maximum_api_version": "2024-07",
      "location": "/components/pricing/test/unit/graph_api/admin/price_rule_test.rb",
      "curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query GetPriceRule($id: ID!) { priceRule(id: $id) { id title status } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/PriceRule/1057371215\"\n  }\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query GetPriceRule($id: ID!) {\n    priceRule(id: $id) {\n      id\n      title\n      status\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/PriceRule/1057371215\"\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 GetPriceRule($id: ID!) {\n    priceRule(id: $id) {\n      id\n      title\n      status\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/PriceRule/1057371215\"\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 GetPriceRule($id: ID!) {\n      priceRule(id: $id) {\n        id\n        title\n        status\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/PriceRule/1057371215\"\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 GetPriceRule($id: ID!) {\n    priceRule(id: $id) {\n      id\n      title\n      status\n    }\n  }\nQUERY;\n\n$variables = [\n  \"id\" => \"gid://shopify/PriceRule/1057371215\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
    },
    "titleStringKey": "arguments",
    "inputVariableEntries": []
  }
]

priceRulequerydeprecated

Arguments

PriceRule possible returns

priceRule
query
deprecated