PriceRule - admin-graphql - OBJECT
Version: 2024-10
Description:
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](https://shopify.dev/docs/apps/selling-strategies/discounts/getting-started) instead. These will replace the GraphQL `PriceRule` object and REST Admin `PriceRule` and `DiscountCode` resources.
Access Scopes
`read_price_rules` access scope.
Fields
-
allocationLimit:
Int -
The maximum number of times that the price rule can be allocated onto an order.
-
allocationMethod:
PriceRuleAllocationMethod! -
The method by which the price rule's value is allocated to its entitled items.
-
app:
App -
The application that created the price rule.
-
combinesWith:
DiscountCombinesWith! -
Determines which discount classes the discount can combine with.
-
createdAt:
DateTime! -
The date and time when the price rule was created.
-
customerSelection:
PriceRuleCustomerSelection! -
The customers that can use this price rule.
-
discountClass:
DiscountClass! -
The class of the discount for combining purposes.
-
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`.
-
entitlementToPrerequisiteQuantityRatio:
PriceRuleEntitlementToPrerequisiteQuantityRatio -
Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items.
-
features:
PriceRuleFeature! -
A list of the price rule's features.
-
hasTimelineComment:
Boolean! -
Indicates whether there are any timeline comments on the price rule.
-
id:
ID! -
A globally-unique ID.
-
itemEntitlements:
PriceRuleItemEntitlements! -
The items to which the price rule applies.
-
itemPrerequisites:
PriceRuleLineItemPrerequisites! -
The items required for the price rule to be applicable.
-
legacyResourceId:
UnsignedInt64! -
The ID of the corresponding resource in the REST Admin API.
-
oncePerCustomer:
Boolean! -
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! -
URLs that can be used to share the discount.
-
shippingEntitlements:
PriceRuleShippingLineEntitlements! -
The shipping lines to which the price rule applies.
-
startsAt:
DateTime! -
The date and time when the price rule starts.
-
status:
PriceRuleStatus! -
The status of the price rule.
-
summary:
String -
A detailed summary of the price rule.
-
target:
PriceRuleTarget! -
The type of lines (line_item or shipping_line) to which the price rule applies.
-
title:
String! -
The title of the price rule.
-
totalSales:
MoneyV2 -
The total sales from orders where the price rule was used.
-
traits:
PriceRuleTrait! -
A list of the price rule's features.
-
usageCount:
Int! -
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! -
A time period during which a price rule is applicable.
-
value:
PriceRuleValue! -
The value of the price rule.
-
valueV2:
PricingValue! -
The value of the price rule.
Connections
Related queries
Related mutations
Related Unions
Examples