PriceRuleInput
The input fields to manipulate a price rule.
Anchor to FieldsFields
- Anchor to allocationLimitallocation•
Limit The maximum number of times that the price rule can be allocated onto an order.
- Anchor to allocationMethodallocation•
Method The method by which the price rule's value is allocated to its entitled items.
- Anchor to combinesWithcombines•
With The discount class that you can use in combination with Shopify discount types.
- Anchor to customerSelectioncustomer•
Selection The customers that can use this price rule.
- Anchor to itemEntitlementsitem•
Entitlements The items to which the price rule applies.
- Anchor to itemPrerequisitesitem•
Prerequisites The items required for the price rule to be applicable.
- Anchor to oncePerCustomeronce•
Per Customer BooleanDefault:false Whether the price rule can be applied only once per customer.
- Anchor to prerequisiteQuantityRangeprerequisite•
Quantity Range The number of the entitled items must fall within this range for the price rule to be applicable.
- Anchor to prerequisiteShippingPriceRangeprerequisite•
Shipping Price Range The shipping cost must fall within this range for the price rule to be applicable.
- Anchor to prerequisiteSubtotalRangeprerequisite•
Subtotal Range The sum of the entitled items subtotal prices must fall within this range for the price rule to be applicable.
- Anchor to prerequisiteToEntitlementQuantityRatioprerequisite•
To Entitlement Quantity Ratio Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items.
- Anchor to shippingEntitlementsshipping•
Entitlements The shipping lines to which the price rule applies.
- Anchor to targettarget•
The type of lines (line_item or shipping_line) to which the price rule applies.
- Anchor to titletitle•
Title of the price rule.
- Anchor to usageLimitusage•
Limit The maximum number of times that the price rule can be used in total.
- Anchor to validityPeriodvalidity•
Period PriceRuleValidityPeriod for the price rule.
- Anchor to valuevalue•
The value of the price rule.
- Anchor to entitlementToPrerequisiteQuantityRatioentitlement•
To Prerequisite Quantity Ratio Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items. Use
instead.