Shopify uses cookies to provide necessary site functionality and improve your experience. By using our website, you agree to our privacy policy and our cookie policy.
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.
allocationLimit•
Int
The maximum number of times that the price rule can be allocated onto an order.
allocationMethod•
PriceRuleAllocationMethod!
non-null
The method by which the price rule's value is allocated to its entitled items.
The date and time when the price rule was created.
customerSelection•
PriceRuleCustomerSelection!
non-null
The customers that can use this price rule.
discountClass•
DiscountClass!
non-null
The
discount class
that's used to control how discounts can be combined.
discountCodes•
PriceRuleDiscountCodeConnection!
non-null
List of the price rule's discount codes.
discountCodesCount•
Count
How many discount codes associated with the price rule.
endsAt•
DateTime
The date and time when the price rule ends. For open-ended price rules, use null.
events•
EventConnection!
non-null
The paginated list of events associated with the price rule.
features•
[PriceRuleFeature!]!
non-null
A list of the price rule's features.
hasTimelineComment•
Boolean!
non-null
Indicates whether there are any timeline comments on the price rule.
id•
ID!
non-null
A globally-unique ID.
itemEntitlements•
PriceRuleItemEntitlements!
non-null
The items to which the price rule applies.
itemPrerequisites•
PriceRuleLineItemPrerequisites!
non-null
The items required for the price rule to be applicable.
legacyResourceId•
UnsignedInt64!
non-null
The ID of the corresponding resource in the REST Admin API.
oncePerCustomer•
Boolean!
non-null
Whether the price rule can be applied only once per customer.
prerequisiteQuantityRange•
PriceRuleQuantityRange
The number of the entitled items must fall within this range for the price rule to be applicable.
prerequisiteShippingPriceRange•
PriceRuleMoneyRange
The shipping cost must fall within this range for the price rule to be applicable.
prerequisiteSubtotalRange•
PriceRuleMoneyRange
The sum of the entitled items subtotal prices must fall within this range for the price rule to be applicable.
prerequisiteToEntitlementQuantityRatio•
PriceRulePrerequisiteToEntitlementQuantityRatio
Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items.
shareableUrls•
[PriceRuleShareableUrl!]!
non-null
URLs that can be used to share the discount.
shippingEntitlements•
PriceRuleShippingLineEntitlements!
non-null
The shipping lines to which the price rule applies.
startsAt•
DateTime!
non-null
The date and time when the price rule starts.
status•
PriceRuleStatus!
non-null
The status of the price rule.
summary•
String
A detailed summary of the price rule.
target•
PriceRuleTarget!
non-null
The type of lines (line_item or shipping_line) to which the price rule applies.
title•
String!
non-null
The title of the price rule.
totalSales•
MoneyV2
The total sales from orders where the price rule was used.
usageCount•
Int!
non-null
The number of times that the price rule has been used. This value is updated asynchronously and can be different than the actual usage count.
usageLimit•
Int
The maximum number of times that the price rule can be used in total.
validityPeriod•
PriceRuleValidityPeriod!
non-null
A time period during which a price rule is applicable.
valueV2•
PricingValue!
non-null
The value of the price rule.
entitlementToPrerequisiteQuantityRatio•
PriceRuleEntitlementToPrerequisiteQuantityRatio
Deprecated
Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items. Use prerequisiteToEntitlementQuantityRatio instead.
traits•
[PriceRuleTrait!]!
non-nullDeprecated
A list of the price rule's features. Use features instead.
