Price
Requires access scope.
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 object and REST Admin and resources.
Anchor to Fields and connectionsFields and connections
- Anchor to allocationLimitallocation•Int
Limit The maximum number of times that the price rule can be allocated onto an order.
- Anchor to allocationMethodallocation•Price
Method Rule Allocation Method!non-null The method by which the price rule's value is allocated to its entitled items.
- •App
The application that created the price rule.
- Anchor to combinesWithcombines•Discount
With Combines With!non-null The discount classes that you can use in combination with Shopify discount types.
- Anchor to createdAtcreated•Date
At Time!non-null The date and time when the price rule was created.
- Anchor to customerSelectioncustomer•Price
Selection Rule Customer Selection!non-null The customers that can use this price rule.
- Anchor to discountClassesdiscount•[Discount
Classes Class!]!non-null The classes of the discount.
- Anchor to discountCodesdiscount•Price
Codes Rule Discount Code Connection!non-null List of the price rule's discount codes.
- Anchor to endsAtends•Date
At Time The date and time when the price rule ends. For open-ended price rules, use
null.- Anchor to eventsevents•Event
Connection!non-null The paginated list of events associated with the price rule.
- Anchor to featuresfeatures•[Price
Rule Feature!]!non-null A list of the price rule's features.
- Anchor to hasTimelineCommenthas•Boolean!non-null
Timeline Comment Indicates whether there are any timeline comments on the price rule.
- •ID!non-null
A globally-unique ID.
- Anchor to itemEntitlementsitem•Price
Entitlements Rule Item Entitlements!non-null The items to which the price rule applies.
- Anchor to itemPrerequisitesitem•Price
Prerequisites Rule Line Item Prerequisites!non-null The items required for the price rule to be applicable.
- Anchor to legacyResourceIdlegacy•Unsigned
Resource Id Int64!non-null The ID of the corresponding resource in the REST Admin API.
- Anchor to oncePerCustomeronce•Boolean!non-null
Per Customer Whether the price rule can be applied only once per customer.
- Anchor to prerequisiteQuantityRangeprerequisite•Price
Quantity Range Rule Quantity Range The number of the entitled items must fall within this range for the price rule to be applicable.
- Anchor to prerequisiteShippingPriceRangeprerequisite•Price
Shipping Price Range Rule Money Range The shipping cost must fall within this range for the price rule to be applicable.
- Anchor to prerequisiteSubtotalRangeprerequisite•Price
Subtotal Range Rule Money Range The sum of the entitled items subtotal prices must fall within this range for the price rule to be applicable.
- Anchor to prerequisiteToEntitlementQuantityRatioprerequisite•Price
To Entitlement Quantity Ratio Rule Prerequisite To Entitlement Quantity Ratio Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items.
- •[Price
Rule Shareable Url!]!non-null URLs that can be used to share the discount.
- Anchor to shippingEntitlementsshipping•Price
Entitlements Rule Shipping Line Entitlements!non-null The shipping lines to which the price rule applies.
- Anchor to startsAtstarts•Date
At Time!non-null The date and time when the price rule starts.
- Anchor to statusstatus•Price
Rule Status!non-null The status of the price rule.
- Anchor to summarysummary•String
A detailed summary of the price rule.
- Anchor to targettarget•Price
Rule Target!non-null The type of lines (line_item or shipping_line) to which the price rule applies.
- Anchor to titletitle•String!non-null
The title of the price rule.
- Anchor to totalSalestotal•Money
Sales V2 The total sales from orders where the price rule was used.
- Anchor to usageCountusage•Int!non-null
Count 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.
- Anchor to usageLimitusage•Int
Limit The maximum number of times that the price rule can be used in total.
- Anchor to validityPeriodvalidity•Price
Period Rule Validity Period!non-null A time period during which a price rule is applicable.
- Anchor to valueV2value•Pricing
V2 Value!non-null The value of the price rule.
Deprecated fields and connections
- Anchor to discountClassdiscount•Discount
Class Class!non-nullDeprecated - Anchor to entitlementToPrerequisiteQuantityRatioentitlement•Price
To Prerequisite Quantity Ratio Rule Entitlement To Prerequisite Quantity RatioDeprecated - Anchor to traitstraits•[Price
Rule Trait!]!non-nullDeprecated - Anchor to valuevalue•Price
Rule Value!non-nullDeprecated