priceRules - admin-graphql - QUERY
Version: 2024-01
Description:
Returns a list of price rule resources that have at least one associated discount code.
Access Scopes
Arguments
-
after:
String -
The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
-
before:
String -
The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
-
first:
Int -
The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
-
last:
Int -
The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
-
query:
String -
A filter made up of terms, connectives, modifiers, and comparators.
| name | type | description | acceptable_values | default_value | example_use |
| ---- | ---- | ---- | ---- | ---- | ---- |
| default | string | Filter by a case-insensitive search of multiple fields in a document. | | | - `query=Bob Norman`<br/> - `query=title:green hoodie` |
| combines_with | string |
| created_at | time |
| discount_type | string |
| ends_at | time |
| id | id | Filter by `id` range. | | | - `id:1234`<br/> - `id:>=1234`<br/> - `id:<=1234` |
| starts_at | time |
| status | string |
| times_used | integer |
| title | string |
| updated_at | time |
You can apply one or more filters to a query. Learn more about [Shopify API search syntax](https://shopify.dev/api/usage/search-syntax).
-
reverse:
Boolean -
Reverse the order of the underlying list.
-
savedSearchId:
ID -
The ID of a [saved search](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch#field-id).
The search’s query string is used as the query argument.
-
sortKey:
PriceRuleSortKeys -
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](https://shopify.dev/api/usage/pagination-graphql#search-performance-considerations).
Returns
-
edges:
PriceRuleEdge!
The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.
-
nodes:
PriceRule!
A list of nodes that are contained in PriceRuleEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve.
-
pageInfo:
PageInfo!
An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page.
Examples
-
Retrieve a shop's price rules
Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-01/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query { priceRules(first: 20) { nodes { id title status } } }\"\n}'\n"
Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: `query {\n priceRules(first: 20) {\n nodes {\n id\n title\n status\n }\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 {\n priceRules(first: 20) {\n nodes {\n id\n title\n status\n }\n }\n }\nQUERY\n\nresponse = client.query(query: query)\n"
PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n query {\n priceRules(first: 20) {\n nodes {\n id\n title\n status\n }\n }\n }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n query {\n priceRules(first: 20) {\n nodes {\n id\n title\n status\n }\n }\n }`,\n);\n\nconst data = await response.json();\n"
Graphql query: "query {\n priceRules(first: 20) {\n nodes {\n id\n title\n status\n }\n }\n}"
input: null
response: {
"data": {
"priceRules": {
"nodes": [
{
"id": "gid://shopify/PriceRule/1057371216",
"title": "PROTABO",
"status": "ACTIVE"
}
]
}
}
}