checkout_read
Returns
required
The store’s checkout discount rules and whether they are on.
Show fields
Show fields
required
Active rules in evaluation order. At checkout the first one whose conditions match wins.
Show fields
Show fields
Boolean!
required
Whether the rule is evaluated at checkout while discount rules are on.
required
When the rule applies.
Show fields
Show fields
Groups of conditions, at most 6.
How the blocks combine.
required
What the rule takes off.
ID!
required
The rule’s id.
String!
required
Shopper-facing text shown with the discounted price.
required
What the rule discounts.
Whether discount rules can be turned on.
Show fields
Show fields
Boolean!
required
True when nothing blocks turning discount rules on.
What blocks it. Empty when eligible.
Boolean!
required
Whether discount rules are on. While off, no rule applies at checkout, active or not.
required
Inactive rules, oldest first. Cursors are positional, so a rule can shift if rules are created, activated or deleted while you page.
Show fields
Show fields
ArgumentsFields
String
Return rules after this cursor.
String
Return rules before this cursor.
Int
Page size.
Int
Page size, paging backward.
required
The list of edges (each a node plus its pagination
cursor).Show fields
Show fields
String!
required
Opaque cursor for this item; pass to
after/before to page from here.required
The item at this edge.
required
The nodes in this page, without the edge/cursor wrapper — a convenience over
edges.Show fields
Show fields
Boolean!
required
Whether the rule is evaluated at checkout while discount rules are on.
required
When the rule applies.
required
What the rule takes off.
ID!
required
The rule’s id.
String!
required
Shopper-facing text shown with the discounted price.
required
What the rule discounts.
Pagination metadata for the current page.
Show fields
Show fields
String
Cursor of the last edge in this page; pass to
after to page forward.Boolean!
required
Whether more items exist after this page (drives forward pagination with
first/after).Boolean!
required
Whether more items exist before this page (drives backward pagination with
last/before).String
Cursor of the first edge in this page; pass to
before to page backward.Example
query {
checkoutDiscountRules {
enabled
inactiveRules {
nodes {
active
createdAt
id
message
updatedAt
}
pageInfo { hasNextPage endCursor }
}
}
}