We're constantly trying to improve your support experience, and your feedback is extremely valuable to us.

Please take a moment to tell us about your experience today.
Sign up for future Help Center user research studies.

priceRuleCreate

This page was printed on Sep 22, 2019. For the current version, visit https://help.shopify.com/en/api/graphql-admin-api/reference/mutation/pricerulecreate.
Version 2019-04

Create a price rule using the input.

Required access

write_price_rules access scope

Interactive Example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

priceRule ( PriceRuleInput! ) required

Input fields to create a price rule.
priceRuleDiscountCode ( PriceRuleDiscountCodeInput )

Input fields to create a discount code for the price rule.

Return Fields

priceRule (PriceRule)

The newly created price rule.
priceRuleDiscountCode (PriceRuleDiscountCode)

The newly created discount code.
priceRuleUserErrors ([PriceRuleUserError!]!)

List of errors that occurred executing the mutation.

Deprecated return fields

Show/Hide
userErrors ([UserError!]!) deprecated

List of errors that occurred executing the mutation.

Deprecation warning

Use priceRuleUserErrors instead
Version 2019-07 (Latest)

Create a price rule using the input.

Required access

write_price_rules access scope

Interactive Example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

priceRule ( PriceRuleInput! ) required

Input fields to create a price rule.
priceRuleDiscountCode ( PriceRuleDiscountCodeInput )

Input fields to create a discount code for the price rule.

Return Fields

priceRule (PriceRule)

The newly created price rule.
priceRuleDiscountCode (PriceRuleDiscountCode)

The newly created discount code.
priceRuleUserErrors ([PriceRuleUserError!]!)

List of errors that occurred executing the mutation.

Deprecated return fields

Show/Hide
userErrors ([UserError!]!) deprecated

List of errors that occurred executing the mutation.

Deprecation warning

Use priceRuleUserErrors instead
Version 2019-10 (Release candidate)

Create a price rule using the input.

Required access

write_price_rules access scope

Interactive Example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

priceRule ( PriceRuleInput! ) required

Input fields to create a price rule.
priceRuleDiscountCode ( PriceRuleDiscountCodeInput )

Input fields to create a discount code for the price rule.

Return Fields

priceRule (PriceRule)

The newly created price rule.
priceRuleDiscountCode (PriceRuleDiscountCode)

The newly created discount code.
priceRuleUserErrors ([PriceRuleUserError!]!)

List of errors that occurred executing the mutation.

Deprecated return fields

Show/Hide
userErrors ([UserError!]!) deprecated

List of errors that occurred executing the mutation.

Deprecation warning

Use priceRuleUserErrors instead

Sign up for a Partner account to get started.

Sign up