priceRules

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.

Anchor to default • string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to combines_with • string
Anchor to created_at • time
Anchor to discount_type • string
Anchor to ends_at • time
Anchor to id • id: Filter by id range.
Anchor to starts_at • time
Anchor to status • string
Anchor to times_used • integer
Anchor to title • string
Anchor to updated_at • time

reverse

•

BooleanDefault:false

Reverse the order of the underlying list.

savedSearchId

•

The ID of a saved search. The search’s query string is used as the query argument.

sortKey

•

PriceRuleSortKeysDefault: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.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to edgesedges • [PriceRuleEdge!]!non-null: The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.
Anchor to nodesnodes • [PriceRule!]!non-null: 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.
Anchor to pageInfopageInfo • PageInfo!non-null: An object that’s used to retrieve cursor information about the current page.

Was this section helpful?

Retrieve a shop's price rules

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

const response = await admin.graphql(

`#graphql

query {

priceRules(first: 20) {

nodes {

title

status

}

}`,

);

const data = await response.json();

query {
  priceRules(first: 20) {
    nodes {
      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 { priceRules(first: 20) { nodes { id title status } } }"
}'

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

const response = await admin.graphql(
  `#graphql
  query {
    priceRules(first: 20) {
      nodes {
        id
        title
        status
      }
    }
  }`,
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    priceRules(first: 20) {
      nodes {
        id
        title
        status
      }
    }
  }`,
});

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 {
    priceRules(first: 20) {
      nodes {
        id
        title
        status
      }
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

{

"priceRules": {

"nodes": [

{

"id": "gid://shopify/PriceRule/1057371216",

"title": "PROTABO",

"status": "ACTIVE"

}

]

}