stack

Home > @infiniteobjects/shopify-data-manager > AdminTypes > QuantityRule

AdminTypes.QuantityRule interface

The quantity rule for the product variant in a given context.

Signature:

export interface QuantityRule 

Properties

Property	Modifiers	Type	Description
increment		Scalars[‘Int’][‘output’]	<p>The value that specifies the quantity increment between minimum and maximum of the rule. Only quantities divisible by this value will be considered valid.</p><p>The increment must be lower than or equal to the minimum and the maximum, and both minimum and maximum must be divisible by this value.</p>
isDefault		Scalars[‘Boolean’][‘output’]	Whether the quantity rule fields match one increment, one minimum and no maximum.
maximum?		Maybe<Scalars[‘Int’][‘output’]>	(Optional) An optional value that defines the highest allowed quantity purchased by the customer. If defined, maximum must be lower than or equal to the minimum and must be a multiple of the increment.
minimum		Scalars[‘Int’][‘output’]	The value that defines the lowest allowed quantity purchased by the customer. The minimum must be a multiple of the quantity rule’s increment.
originType		QuantityRuleOriginType | `${QuantityRuleOriginType}`	Whether the values of the quantity rule were explicitly set.
productVariant		ProductVariant	The product variant for which the quantity rule is applied.