Skip to main content
Anchor to PriceRule

PriceRule

object

Requires read_price_rules access scope.

A set of conditions, including entitlements and prerequisites, that must be met for a discount code to apply.

Note

Use the types and queries included our discount tutorials instead. These will replace the GraphQL Admin API's PriceRule object and DiscountCode union, and the REST Admin API's deprecatedPriceRule resource.

Anchor to FieldsFields

Anchor to allocationLimitallocationLimit
•Int

The maximum number of times that the price rule can be allocated onto an order.

Anchor to allocationMethodallocationMethod
•PriceRuleAllocationMethod!
non-null

The method by which the price rule's value is allocated to its entitled items.

Anchor to appapp
•App

The application that created the price rule.

Anchor to combinesWithcombinesWith
•DiscountCombinesWith!
non-null

The discount classes that you can use in combination with Shopify discount types.

Anchor to createdAtcreatedAt
•DateTime!
non-null

The date and time when the price rule was created.

Anchor to customerSelectioncustomerSelection
•PriceRuleCustomerSelection!
non-null

The customers that can use this price rule.

Anchor to discountClassesdiscountClasses
•[DiscountClass!]!
non-null

The classes of the discount.

Anchor to discountCodesdiscountCodes
•PriceRuleDiscountCodeConnection!
non-null

List of the price rule's discount codes.

Arguments

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey
•DiscountCodeSortKeys
Default: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.

Anchor to queryquery
•String

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.

Example:

  • query=Bob Norman
  • query=title:green hoodie
Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to times_used
•integer
Anchor to savedSearchIdsavedSearchId
•ID

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

Anchor to discountCodesCountdiscountCodesCount
•Count

How many discount codes associated with the price rule.

Anchor to endsAtendsAt
•DateTime

The date and time when the price rule ends. For open-ended price rules, use null.

Anchor to eventsevents
•EventConnection!
non-null

The paginated list of events associated with the price rule.

Arguments

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey
•EventSortKeys
Default: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.

Anchor to queryquery
•String

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 action
•string

The action that occured.

Example:

  • action:create
Anchor to comments
•boolean

Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events.

Example:

  • false
  • true
Anchor to created_at
•time

Filter by the date and time when the event happened.

Example:

  • created_at:>2020-10-21
  • created_at:<now
Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to subject_type
•string

The resource type affected by this event. See EventSubjectType for possible values.

Example:

  • PRODUCT_VARIANT
  • PRODUCT
  • COLLECTION
Anchor to featuresfeatures
•[PriceRuleFeature!]!
non-null

A list of the price rule's features.

Anchor to hasTimelineCommenthasTimelineComment
•Boolean!
non-null

Indicates whether there are any timeline comments on the price rule.

Anchor to idid
•ID!
non-null

A globally-unique ID.

Anchor to itemEntitlementsitemEntitlements
•PriceRuleItemEntitlements!
non-null

The items to which the price rule applies.

Anchor to itemPrerequisitesitemPrerequisites
•PriceRuleLineItemPrerequisites!
non-null

The items required for the price rule to be applicable.

Anchor to legacyResourceIdlegacyResourceId
•UnsignedInt64!
non-null

The ID of the corresponding resource in the REST Admin API.

Anchor to oncePerCustomeroncePerCustomer
•Boolean!
non-null

Whether the price rule can be applied only once per customer.

Anchor to prerequisiteQuantityRangeprerequisiteQuantityRange
•PriceRuleQuantityRange

The number of the entitled items must fall within this range for the price rule to be applicable.

Anchor to prerequisiteShippingPriceRangeprerequisiteShippingPriceRange
•PriceRuleMoneyRange

The shipping cost must fall within this range for the price rule to be applicable.

Anchor to prerequisiteSubtotalRangeprerequisiteSubtotalRange
•PriceRuleMoneyRange

The sum of the entitled items subtotal prices must fall within this range for the price rule to be applicable.

Anchor to prerequisiteToEntitlementQuantityRatioprerequisiteToEntitlementQuantityRatio
•PriceRulePrerequisiteToEntitlementQuantityRatio

Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items.

Anchor to shareableUrlsshareableUrls
•[PriceRuleShareableUrl!]!
non-null

URLs that can be used to share the discount.

Anchor to shippingEntitlementsshippingEntitlements
•PriceRuleShippingLineEntitlements!
non-null

The shipping lines to which the price rule applies.

Anchor to startsAtstartsAt
•DateTime!
non-null

The date and time when the price rule starts.

Anchor to statusstatus
•PriceRuleStatus!
non-null

The status of the price rule.

Anchor to summarysummary
•String

A detailed summary of the price rule.

Anchor to targettarget
•PriceRuleTarget!
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 totalSalestotalSales
•MoneyV2

The total sales from orders where the price rule was used.

Anchor to usageCountusageCount
•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.

Anchor to usageLimitusageLimit
•Int

The maximum number of times that the price rule can be used in total.

Anchor to validityPeriodvalidityPeriod
•PriceRuleValidityPeriod!
non-null

A time period during which a price rule is applicable.

Anchor to valueV2valueV2
•PricingValue!
non-null

The value of the price rule.

Deprecated fields

Anchor to discountClassdiscountClass
•DiscountClass!
non-nullDeprecated
Anchor to entitlementToPrerequisiteQuantityRatioentitlementToPrerequisiteQuantityRatio
•PriceRuleEntitlementToPrerequisiteQuantityRatio
Deprecated
Anchor to traitstraits
•[PriceRuleTrait!]!
non-nullDeprecated
Anchor to valuevalue
•PriceRuleValue!
non-nullDeprecated
Was this section helpful?

Anchor to InterfacesInterfaces

Was this section helpful?