Home > @infiniteobjects/shopify-data-manager > AdminTypes > PriceRuleInput
The input fields to manipulate a price rule.
Signature:
export interface PriceRuleInput
| Property | Modifiers | Type | Description |
|---|---|---|---|
| allocationLimit? | InputMaybe<Scalars[‘Int’][‘input’]> | (Optional) The maximum number of times that the price rule can be allocated onto an order. | |
| allocationMethod? | InputMaybe<PriceRuleAllocationMethod | `${PriceRuleAllocationMethod}`> | (Optional) The method by which the price rule’s value is allocated to its entitled items. | |
| combinesWith? | InputMaybe<DiscountCombinesWithInput> | (Optional) Determines which discount classes the discount can combine with. | |
| customerSelection? | InputMaybe<PriceRuleCustomerSelectionInput> | (Optional) The customers that can use this price rule. | |
| itemEntitlements? | InputMaybe<PriceRuleItemEntitlementsInput> | (Optional) The items to which the price rule applies. | |
| itemPrerequisites? | InputMaybe<PriceRuleItemPrerequisitesInput> | (Optional) The items required for the price rule to be applicable. | |
| oncePerCustomer? | InputMaybe<Scalars[‘Boolean’][‘input’]> | (Optional) Whether the price rule can be applied only once per customer. | |
| prerequisiteQuantityRange? | InputMaybe<PriceRuleQuantityRangeInput> | (Optional) The number of the entitled items must fall within this range for the price rule to be applicable. | |
| prerequisiteShippingPriceRange? | InputMaybe<PriceRuleMoneyRangeInput> | (Optional) The shipping cost must fall within this range for the price rule to be applicable. | |
| prerequisiteSubtotalRange? | InputMaybe<PriceRuleMoneyRangeInput> | (Optional) The sum of the entitled items subtotal prices must fall within this range for the price rule to be applicable. | |
| prerequisiteToEntitlementQuantityRatio? | InputMaybe<PriceRulePrerequisiteToEntitlementQuantityRatioInput> | (Optional) Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items. | |
| shippingEntitlements? | InputMaybe<PriceRuleShippingEntitlementsInput> | (Optional) The shipping lines to which the price rule applies. | |
| target? | InputMaybe<PriceRuleTarget | `${PriceRuleTarget}`> | (Optional) The type of lines (line_item or shipping_line) to which the price rule applies. | |
| title? | InputMaybe<Scalars[‘String’][‘input’]> | (Optional) Title of the price rule. | |
| usageLimit? | InputMaybe<Scalars[‘Int’][‘input’]> | (Optional) The maximum number of times that the price rule can be used in total. | |
| validityPeriod? | InputMaybe<PriceRuleValidityPeriodInput> | (Optional) PriceRuleValidityPeriod for the price rule. | |
| value? | InputMaybe<PriceRuleValueInput> | (Optional) The value of the price rule. |