Skip to main content
input_object

The input fields to manipulate a price rule.

•Int

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

•PriceRuleAllocationMethod

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

•DiscountCombinesWithInput

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

•PriceRuleCustomerSelectionInput

The customers that can use this price rule.

•PriceRuleItemEntitlementsInput

The items to which the price rule applies.

•PriceRuleItemPrerequisitesInput

The items required for the price rule to be applicable.

•BooleanDefault:false

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

Anchor to prerequisiteQuantityRangeprerequisiteQuantityRange
•PriceRuleQuantityRangeInput

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

Anchor to prerequisiteShippingPriceRangeprerequisiteShippingPriceRange
•PriceRuleMoneyRangeInput

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

Anchor to prerequisiteSubtotalRangeprerequisiteSubtotalRange
•PriceRuleMoneyRangeInput

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

Anchor to prerequisiteToEntitlementQuantityRatioprerequisiteToEntitlementQuantityRatio
•PriceRulePrerequisiteToEntitlementQuantityRatioInput

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

Anchor to shippingEntitlementsshippingEntitlements
•PriceRuleShippingEntitlementsInput

The shipping lines to which the price rule applies.

•PriceRuleTarget

The type of lines (line_item or shipping_line) to which the price rule applies.

•String

Title of the price rule.

•Int

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

•PriceRuleValidityPeriodInput

PriceRuleValidityPeriod for the price rule.

•PriceRuleValueInput

The value of the price rule.


Was this section helpful?