PriceRule
Required access
read_price_rules
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.
Show definition# Price rules are a set of conditions, including entitlements and prerequisites, # that must be met in order for a discount code to apply. type PriceRule implements CommentEventSubject & HasEvents & LegacyInteroperability & Node { # The maximum number of times the price rule will be allocated onto an order. allocationLimit: Int # The method by which the price rule's value is allocated to its entitled items. allocationMethod: PriceRuleAllocationMethod! # The application that created the price rule. app: App # When the price rule was created. createdAt: DateTime! # A selection of customers for whom the price rule applies. customerSelection: PriceRuleCustomerSelection! # List of the price rule's discount codes. discountCodes( # Returns the elements that come after the specified cursor. after: String # Returns the elements that come before the specified cursor. before: String # Returns up to the first `n` elements from the list. first: Int # Returns up to the last `n` elements from the list. last: Int # Supported filter parameters: # - `times_used` # # See the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax). query: String # Reverse the order of the underlying list. reverse: Boolean = false # ID of an existing saved search. # The search’s query string will be used as the query argument. savedSearchId: ID # Sort the underlying list by the given key. sortKey: DiscountCodeSortKeys = ID ): PriceRuleDiscountCodeConnection! # How many discount codes associated with the price rule. discountCodesCount: Int! # When the price rule expires, or never if null. endsAt: DateTime # Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items. entitlementToPrerequisiteQuantityRatio: PriceRuleEntitlementToPrerequisiteQuantityRatio # The paginated list of events associated with the price rule. events( # Returns the elements that come after the specified cursor. after: String # Returns the elements that come before the specified cursor. before: String # Returns up to the first `n` elements from the list. first: Int # Returns up to the last `n` elements from the list. last: Int # Supported filter parameters: # - `comments` # - `created_at` # - `include_app_activity` # - `subject_type` # - `verb` # # See the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax). query: String # Reverse the order of the underlying list. reverse: Boolean = false # Sort the underlying list by the given key. sortKey: EventSortKeys = ID ): EventConnection! # A list of features used by the price rule. features: [PriceRuleFeature!]! # Indicates whether or not any timeline comments have been made on the price rule. hasTimelineComment: Boolean! # Globally unique identifier. id: ID! # The items to which the price rule applies. itemEntitlements: PriceRuleItemEntitlements! # The line item objects required for the price rule to be applicable. itemPrerequisites: PriceRuleLineItemPrerequisites! # The ID of the corresponding resource in the REST Admin API. legacyResourceId: UnsignedInt64! # Whether the price rule can be applied only once per customer. oncePerCustomer: Boolean! # The number of the entitled items must fall within this range for the price rule to be applicable. prerequisiteQuantityRange: PriceRuleQuantityRange # The shipping cost must fall within this range for the price rule to be applicable. prerequisiteShippingPriceRange: PriceRuleMoneyRange # The sum of the entitled items subtotal prices must fall within this range for the price rule to be applicable. prerequisiteSubtotalRange: PriceRuleMoneyRange # Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items. prerequisiteToEntitlementQuantityRatio: PriceRulePrerequisiteToEntitlementQuantityRatio # URLs that can be used to share the discount. shareableUrls: [PriceRuleShareableUrl!]! # The shipping lines to which the price rule applies. shippingEntitlements: PriceRuleShippingLineEntitlements! # When the price rule is starting to be active. startsAt: DateTime! # The status of the price rule. status: PriceRuleStatus! # A summary of the price rule. summary: String # The type of lines (line_item or shipping_line) to which the price rule applies. target: PriceRuleTarget! # The title of the price rule. title: String! # The total sales brought by the price rule. totalSales: MoneyV2 # A list of features used by the price rule. traits: [PriceRuleTrait!]! # How many times the price rule has been used. usageCount: Int! # The maximum number of times the price rule can be applied. usageLimit: Int # A time period during which a price rule is applicable. validityPeriod: PriceRuleValidityPeriod! # The value of the price rule. value: PriceRuleValue! # The value of the price rule. valueV2: PricingValue! }
Implements
Connections
discountCodes
(PriceRuleDiscountCodeConnection!
)
List of the price rule's discount codes.
Argument | Type | Default | Description |
---|---|---|---|
after
|
String
|
|
Returns the elements that come after the specified cursor. |
before
|
String
|
|
Returns the elements that come before the specified cursor. |
first
|
Int
|
|
Returns up to the first |
last
|
Int
|
|
Returns up to the last |
query
|
String
|
|
Supported filter parameters:
See the detailed search syntax. |
reverse
|
Boolean
|
|
Reverse the order of the underlying list. |
savedSearchId
|
ID
|
|
ID of an existing saved search. The search’s query string will be used as the query argument. |
sortKey
|
DiscountCodeSortKeys
|
|
Sort the underlying list by the given key. |
events
(EventConnection!
)
The paginated list of events associated with the price rule.
Argument | Type | Default | Description |
---|---|---|---|
after
|
String
|
|
Returns the elements that come after the specified cursor. |
before
|
String
|
|
Returns the elements that come before the specified cursor. |
first
|
Int
|
|
Returns up to the first |
last
|
Int
|
|
Returns up to the last |
query
|
String
|
|
Supported filter parameters:
See the detailed search syntax. |
reverse
|
Boolean
|
|
Reverse the order of the underlying list. |
sortKey
|
EventSortKeys
|
|
Sort the underlying list by the given key. |
Fields
allocationMethod
(PriceRuleAllocationMethod!
)
The method by which the price rule's value is allocated to its entitled items.
customerSelection
(PriceRuleCustomerSelection!
)
A selection of customers for whom the price rule applies.
hasTimelineComment
(Boolean!
)
Indicates whether or not any timeline comments have been made on the price rule.
itemPrerequisites
(PriceRuleLineItemPrerequisites!
)
The line item objects required for the price rule to be applicable.
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.
shippingEntitlements
(PriceRuleShippingLineEntitlements!
)
The shipping lines to which the price rule applies.
target
(PriceRuleTarget!
)
The type of lines (line_item or shipping_line) to which the price rule applies.
Deprecated fields
entitlementToPrerequisiteQuantityRatio
(PriceRuleEntitlementToPrerequisiteQuantityRatio
)
deprecated
Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items.
Deprecation warning
Use prerequisiteToEntitlementQuantityRatio
instead
traits
([PriceRuleTrait!]!
)
deprecated
A list of features used by the price rule.
Deprecation warning
Use features
instead
value
(PriceRuleValue!
)
deprecated
The value of the price rule.
Deprecation warning
Use valueV2
instead