PriceRule object

This page was printed on Oct 20, 2019. For the current version, visit https://help.shopify.com/en/api/graphql-admin-api/reference/object/pricerule.
Version 2020-01 (Release candidate)

Price rules are a set of conditions, including entitlements and prerequisites, that must be met in order for a discount code to apply.

Required access

read_price_rules access scope

Connections

discountCodes (PriceRuleDiscountCodeConnection!)

List of the price rule's discount codes.
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 n elements from the list.
last ( Int )

Returns up to the last n elements from the list.
query ( String )

Supported filter parameters:

  • times_used

See the detailed search syntax.
reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false
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.
Default value: ID
events (EventConnection!)

The paginated list of events associated with the price rule.
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 n elements from the list.
last ( Int )

Returns up to the last n elements from the list.
query ( String )

Supported filter parameters:

  • comments
  • created_at
  • subject_type
  • verb

See the detailed search syntax.
reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false
sortKey ( EventSortKeys )

Sort the underlying list by the given key.
Default value: ID

Fields

allocationLimit (Int)

The maximum number of times the price rule will 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.
createdAt (DateTime!)

When the price rule was created.
customerSelection (PriceRuleCustomerSelection!)

A selection of customers for whom the price rule applies.
discountCodesCount (Int!)

How many discount codes associated with the price rule.
endsAt (DateTime)

When the price rule expires, or never if null.
features ([PriceRuleFeature!]!)

A list of features used by the price rule.
hasTimelineComment (Boolean!)

Indicates whether or not any timeline comments have been made on the price rule.
id (ID!)

Globally unique identifier.
itemEntitlements (PriceRuleItemEntitlements!)

The items to which the price rule applies.
itemPrerequisites (PriceRuleLineItemPrerequisites!)

The line item objects 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!)

When the price rule is starting to be active.
status (PriceRuleStatus!)

The status of the price rule.
summary (String)

A 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 brought by the price rule.
usageCount (Int!)

How many times the price rule has been used.
usageLimit (Int)

The maximum number of times the price rule can be applied.
validityPeriod (PriceRuleValidityPeriod!)

A time period during which a price rule is applicable.
valueV2 (PricingValue!)

The value of the price rule.

Types that return PriceRule

Mutations for PriceRule

priceRuleActivate

Activate a price rule.
priceRuleCreate

Create a price rule using the input.
priceRuleDeactivate

Deactivate a price rule.
priceRuleDelete

Delete a price rule.
priceRuleUpdate

Update a price rule using its id and an input.

Implements

Deprecated fields

Show/Hide
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
Version 2019-10 (Latest)

Price rules are a set of conditions, including entitlements and prerequisites, that must be met in order for a discount code to apply.

Required access

read_price_rules access scope

Connections

discountCodes (PriceRuleDiscountCodeConnection!)

List of the price rule's discount codes.
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 n elements from the list.
last ( Int )

Returns up to the last n elements from the list.
query ( String )

Supported filter parameters:

  • times_used

See the detailed search syntax.
reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false
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.
Default value: ID
events (EventConnection!)

The paginated list of events associated with the price rule.
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 n elements from the list.
last ( Int )

Returns up to the last n elements from the list.
query ( String )

Supported filter parameters:

  • comments
  • created_at
  • subject_type
  • verb

See the detailed search syntax.
reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false
sortKey ( EventSortKeys )

Sort the underlying list by the given key.
Default value: ID

Fields

allocationLimit (Int)

The maximum number of times the price rule will 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.
createdAt (DateTime!)

When the price rule was created.
customerSelection (PriceRuleCustomerSelection!)

A selection of customers for whom the price rule applies.
discountCodesCount (Int!)

How many discount codes associated with the price rule.
endsAt (DateTime)

When the price rule expires, or never if null.
features ([PriceRuleFeature!]!)

A list of features used by the price rule.
hasTimelineComment (Boolean!)

Indicates whether or not any timeline comments have been made on the price rule.
id (ID!)

Globally unique identifier.
itemEntitlements (PriceRuleItemEntitlements!)

The items to which the price rule applies.
itemPrerequisites (PriceRuleLineItemPrerequisites!)

The line item objects 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!)

When the price rule is starting to be active.
status (PriceRuleStatus!)

The status of the price rule.
summary (String)

A 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 brought by the price rule.
usageCount (Int!)

How many times the price rule has been used.
usageLimit (Int)

The maximum number of times the price rule can be applied.
validityPeriod (PriceRuleValidityPeriod!)

A time period during which a price rule is applicable.
valueV2 (PricingValue!)

The value of the price rule.

Types that return PriceRule

Mutations for PriceRule

priceRuleActivate

Activate a price rule.
priceRuleCreate

Create a price rule using the input.
priceRuleDeactivate

Deactivate a price rule.
priceRuleDelete

Delete a price rule.
priceRuleUpdate

Update a price rule using its id and an input.

Implements

Deprecated fields

Show/Hide
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
Version 2019-07

Price rules are a set of conditions, including entitlements and prerequisites, that must be met in order for a discount code to apply.

Required access

read_price_rules access scope

Connections

discountCodes (PriceRuleDiscountCodeConnection!)

List of the price rule's discount codes.
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 n elements from the list.
last ( Int )

Returns up to the last n elements from the list.
query ( String )

Supported filter parameters:

  • times_used

See the detailed search syntax.
reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false
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.
Default value: ID
events (EventConnection!)

The paginated list of events associated with the price rule.
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 n elements from the list.
last ( Int )

Returns up to the last n elements from the list.
query ( String )

Supported filter parameters:

  • comments
  • created_at
  • subject_type
  • verb

See the detailed search syntax.
reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false
sortKey ( EventSortKeys )

Sort the underlying list by the given key.
Default value: ID

Fields

allocationLimit (Int)

The maximum number of times the price rule will 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.
createdAt (DateTime!)

When the price rule was created.
customerSelection (PriceRuleCustomerSelection!)

A selection of customers for whom the price rule applies.
discountCodesCount (Int!)

How many discount codes associated with the price rule.
endsAt (DateTime)

When the price rule expires, or never if null.
features ([PriceRuleFeature!]!)

A list of features used by the price rule.
hasTimelineComment (Boolean!)

Indicates whether or not any timeline comments have been made on the price rule.
id (ID!)

Globally unique identifier.
itemEntitlements (PriceRuleItemEntitlements!)

The items to which the price rule applies.
itemPrerequisites (PriceRuleLineItemPrerequisites!)

The line item objects 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!)

When the price rule is starting to be active.
status (PriceRuleStatus!)

The status of the price rule.
summary (String)

A 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 brought by the price rule.
usageCount (Int!)

How many times the price rule has been used.
usageLimit (Int)

The maximum number of times the price rule can be applied.
validityPeriod (PriceRuleValidityPeriod!)

A time period during which a price rule is applicable.
valueV2 (PricingValue!)

The value of the price rule.

Types that return PriceRule

Mutations for PriceRule

priceRuleActivate

Activate a price rule.
priceRuleCreate

Create a price rule using the input.
priceRuleDeactivate

Deactivate a price rule.
priceRuleDelete

Delete a price rule.
priceRuleUpdate

Update a price rule using its id and an input.

Implements

Deprecated fields

Show/Hide
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
Version 2019-04

Price rules are a set of conditions, including entitlements and prerequisites, that must be met in order for a discount code to apply.

Required access

read_price_rules access scope

Connections

discountCodes (PriceRuleDiscountCodeConnection!)

List of the price rule's discount codes.
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 n elements from the list.
last ( Int )

Returns up to the last n elements from the list.
query ( String )

Supported filter parameters:

  • times_used

See the detailed search syntax.
reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false
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.
Default value: ID
events (EventConnection!)

The paginated list of events associated with the price rule.
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 n elements from the list.
last ( Int )

Returns up to the last n elements from the list.
query ( String )

Supported filter parameters:

  • comments
  • created_at
  • subject_type
  • verb

See the detailed search syntax.
reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false
sortKey ( EventSortKeys )

Sort the underlying list by the given key.
Default value: ID

Fields

allocationLimit (Int)

The maximum number of times the price rule will 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.
createdAt (DateTime!)

When the price rule was created.
customerSelection (PriceRuleCustomerSelection!)

A selection of customers for whom the price rule applies.
discountCodesCount (Int!)

How many discount codes associated with the price rule.
endsAt (DateTime)

When the price rule expires, or never if null.
features ([PriceRuleFeature!]!)

A list of features used by the price rule.
hasTimelineComment (Boolean!)

Indicates whether or not any timeline comments have been made on the price rule.
id (ID!)

Globally unique identifier.
itemEntitlements (PriceRuleItemEntitlements!)

The items to which the price rule applies.
itemPrerequisites (PriceRuleLineItemPrerequisites!)

The line item objects 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!)

When the price rule is starting to be active.
status (PriceRuleStatus!)

The status of the price rule.
summary (String)

A 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 brought by the price rule.
usageCount (Int!)

How many times the price rule has been used.
usageLimit (Int)

The maximum number of times the price rule can be applied.
validityPeriod (PriceRuleValidityPeriod!)

A time period during which a price rule is applicable.
valueV2 (PricingValue!)

The value of the price rule.

Types that return PriceRule

Mutations for PriceRule

priceRuleActivate

Activate a price rule.
priceRuleCreate

Create a price rule using the input.
priceRuleDeactivate

Deactivate a price rule.
priceRuleDelete

Delete a price rule.
priceRuleUpdate

Update a price rule using its id and an input.

Implements

Deprecated fields

Show/Hide
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

Sign up for a Partner account to get started.

Sign up