PriceRuleInput input object

Version 2020-10 (Release candidate)

Specifies the input fields to manipulate a price rule.

Input fields

allocationLimit (Int)

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

allocationMethod (PriceRuleAllocationMethod)

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

customerSelection (PriceRuleCustomerSelectionInput)

The customers that can use this price rule.

entitlementToPrerequisiteQuantityRatio (PriceRuleEntitlementToPrerequisiteQuantityRatioInput)

Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items. This argument is deprecated: Use prerequisiteToEntitlementQuantityRatio instead.

itemEntitlements (PriceRuleItemEntitlementsInput)

The items to which the price rule applies.

itemPrerequisites (PriceRuleItemPrerequisitesInput)

The items required for the price rule to be applicable.

oncePerCustomer (Boolean)

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

prerequisiteQuantityRange (PriceRuleQuantityRangeInput)

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

prerequisiteShippingPriceRange (PriceRuleMoneyRangeInput)

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

prerequisiteSubtotalRange (PriceRuleMoneyRangeInput)

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

prerequisiteToEntitlementQuantityRatio (PriceRulePrerequisiteToEntitlementQuantityRatioInput)

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

shippingEntitlements (PriceRuleShippingEntitlementsInput)

The shipping lines to which the price rule applies.

target (PriceRuleTarget)

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

title (String)

Title of the price rule.

usageLimit (Int)

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

validityPeriod (PriceRuleValidityPeriodInput)

PriceRuleValidityPeriod for the price rule.

value (PriceRuleValueInput)

The value of the price rule.

Version 2020-07 (Latest)

Specifies the input fields to manipulate a price rule.

Input fields

allocationLimit (Int)

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

allocationMethod (PriceRuleAllocationMethod)

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

customerSelection (PriceRuleCustomerSelectionInput)

The customers that can use this price rule.

entitlementToPrerequisiteQuantityRatio (PriceRuleEntitlementToPrerequisiteQuantityRatioInput)

Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items. This argument is deprecated: Use prerequisiteToEntitlementQuantityRatio instead.

itemEntitlements (PriceRuleItemEntitlementsInput)

The items to which the price rule applies.

itemPrerequisites (PriceRuleItemPrerequisitesInput)

The items required for the price rule to be applicable.

oncePerCustomer (Boolean)

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

prerequisiteQuantityRange (PriceRuleQuantityRangeInput)

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

prerequisiteShippingPriceRange (PriceRuleMoneyRangeInput)

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

prerequisiteSubtotalRange (PriceRuleMoneyRangeInput)

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

prerequisiteToEntitlementQuantityRatio (PriceRulePrerequisiteToEntitlementQuantityRatioInput)

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

shippingEntitlements (PriceRuleShippingEntitlementsInput)

The shipping lines to which the price rule applies.

target (PriceRuleTarget)

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

title (String)

Title of the price rule.

usageLimit (Int)

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

validityPeriod (PriceRuleValidityPeriodInput)

PriceRuleValidityPeriod for the price rule.

value (PriceRuleValueInput)

The value of the price rule.

Version 2020-04

Specifies the input fields to manipulate a price rule.

Input fields

allocationLimit (Int)

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

allocationMethod (PriceRuleAllocationMethod)

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

customerSelection (PriceRuleCustomerSelectionInput)

The customers that can use this price rule.

entitlementToPrerequisiteQuantityRatio (PriceRuleEntitlementToPrerequisiteQuantityRatioInput)

Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items. This argument is deprecated: Use prerequisiteToEntitlementQuantityRatio instead.

itemEntitlements (PriceRuleItemEntitlementsInput)

The items to which the price rule applies.

itemPrerequisites (PriceRuleItemPrerequisitesInput)

The items required for the price rule to be applicable.

oncePerCustomer (Boolean)

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

prerequisiteQuantityRange (PriceRuleQuantityRangeInput)

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

prerequisiteShippingPriceRange (PriceRuleMoneyRangeInput)

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

prerequisiteSubtotalRange (PriceRuleMoneyRangeInput)

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

prerequisiteToEntitlementQuantityRatio (PriceRulePrerequisiteToEntitlementQuantityRatioInput)

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

shippingEntitlements (PriceRuleShippingEntitlementsInput)

The shipping lines to which the price rule applies.

target (PriceRuleTarget)

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

title (String)

Title of the price rule.

usageLimit (Int)

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

validityPeriod (PriceRuleValidityPeriodInput)

PriceRuleValidityPeriod for the price rule.

value (PriceRuleValueInput)

The value of the price rule.

Version 2020-01

Specifies the input fields to manipulate a price rule.

Input fields

allocationLimit (Int)

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

allocationMethod (PriceRuleAllocationMethod)

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

customerSelection (PriceRuleCustomerSelectionInput)

The customers that can use this price rule.

entitlementToPrerequisiteQuantityRatio (PriceRuleEntitlementToPrerequisiteQuantityRatioInput)

Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items. This argument is deprecated: Use prerequisiteToEntitlementQuantityRatio instead.

itemEntitlements (PriceRuleItemEntitlementsInput)

The items to which the price rule applies.

itemPrerequisites (PriceRuleItemPrerequisitesInput)

The items required for the price rule to be applicable.

oncePerCustomer (Boolean)

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

prerequisiteQuantityRange (PriceRuleQuantityRangeInput)

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

prerequisiteShippingPriceRange (PriceRuleMoneyRangeInput)

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

prerequisiteSubtotalRange (PriceRuleMoneyRangeInput)

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

prerequisiteToEntitlementQuantityRatio (PriceRulePrerequisiteToEntitlementQuantityRatioInput)

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

shippingEntitlements (PriceRuleShippingEntitlementsInput)

The shipping lines to which the price rule applies.

target (PriceRuleTarget)

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

title (String)

Title of the price rule.

usageLimit (Int)

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

validityPeriod (PriceRuleValidityPeriodInput)

PriceRuleValidityPeriod for the price rule.

value (PriceRuleValueInput)

The value of the price rule.

Version 2019-10

Specifies the input fields to manipulate a price rule.

Input fields

allocationLimit (Int)

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

allocationMethod (PriceRuleAllocationMethod)

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

customerSelection (PriceRuleCustomerSelectionInput)

The customers that can use this price rule.

entitlementToPrerequisiteQuantityRatio (PriceRuleEntitlementToPrerequisiteQuantityRatioInput)

Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items. This argument is deprecated: Use prerequisiteToEntitlementQuantityRatio instead.

itemEntitlements (PriceRuleItemEntitlementsInput)

The items to which the price rule applies.

itemPrerequisites (PriceRuleItemPrerequisitesInput)

The items required for the price rule to be applicable.

oncePerCustomer (Boolean)

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

prerequisiteQuantityRange (PriceRuleQuantityRangeInput)

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

prerequisiteShippingPriceRange (PriceRuleMoneyRangeInput)

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

prerequisiteSubtotalRange (PriceRuleMoneyRangeInput)

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

prerequisiteToEntitlementQuantityRatio (PriceRulePrerequisiteToEntitlementQuantityRatioInput)

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

shippingEntitlements (PriceRuleShippingEntitlementsInput)

The shipping lines to which the price rule applies.

target (PriceRuleTarget)

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

title (String)

Title of the price rule.

usageLimit (Int)

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

validityPeriod (PriceRuleValidityPeriodInput)

PriceRuleValidityPeriod for the price rule.

value (PriceRuleValueInput)

The value of the price rule.

Version 2019-07 (Unsupported)

Specifies the input fields to manipulate a price rule.

Input fields

allocationLimit (Int)

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

allocationMethod (PriceRuleAllocationMethod)

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

customerSelection (PriceRuleCustomerSelectionInput)

The customers that can use this price rule.

entitlementToPrerequisiteQuantityRatio (PriceRuleEntitlementToPrerequisiteQuantityRatioInput)

Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items. This argument is deprecated: Use prerequisiteToEntitlementQuantityRatio instead.

itemEntitlements (PriceRuleItemEntitlementsInput)

The items to which the price rule applies.

itemPrerequisites (PriceRuleItemPrerequisitesInput)

The items required for the price rule to be applicable.

oncePerCustomer (Boolean)

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

prerequisiteQuantityRange (PriceRuleQuantityRangeInput)

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

prerequisiteShippingPriceRange (PriceRuleMoneyRangeInput)

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

prerequisiteSubtotalRange (PriceRuleMoneyRangeInput)

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

prerequisiteToEntitlementQuantityRatio (PriceRulePrerequisiteToEntitlementQuantityRatioInput)

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

shippingEntitlements (PriceRuleShippingEntitlementsInput)

The shipping lines to which the price rule applies.

target (PriceRuleTarget)

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

title (String)

Title of the price rule.

usageLimit (Int)

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

validityPeriod (PriceRuleValidityPeriodInput)

PriceRuleValidityPeriod for the price rule.

value (PriceRuleValueInput)

The value of the price rule.

Version 2019-04 (Unsupported)

Specifies the input fields to manipulate a price rule.

Input fields

allocationLimit (Int)

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

allocationMethod (PriceRuleAllocationMethod)

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

customerSelection (PriceRuleCustomerSelectionInput)

The customers that can use this price rule.

entitlementToPrerequisiteQuantityRatio (PriceRuleEntitlementToPrerequisiteQuantityRatioInput)

Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items. This argument is deprecated: Use prerequisiteToEntitlementQuantityRatio instead.

itemEntitlements (PriceRuleItemEntitlementsInput)

The items to which the price rule applies.

itemPrerequisites (PriceRuleItemPrerequisitesInput)

The items required for the price rule to be applicable.

oncePerCustomer (Boolean)

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

prerequisiteQuantityRange (PriceRuleQuantityRangeInput)

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

prerequisiteShippingPriceRange (PriceRuleMoneyRangeInput)

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

prerequisiteSubtotalRange (PriceRuleMoneyRangeInput)

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

prerequisiteToEntitlementQuantityRatio (PriceRulePrerequisiteToEntitlementQuantityRatioInput)

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

shippingEntitlements (PriceRuleShippingEntitlementsInput)

The shipping lines to which the price rule applies.

target (PriceRuleTarget)

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

title (String)

Title of the price rule.

usageLimit (Int)

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

validityPeriod (PriceRuleValidityPeriodInput)

PriceRuleValidityPeriod for the price rule.

value (PriceRuleValueInput)

The value of the price rule.