Skip to main content
Anchor to DiscountCustomerGetsValue

DiscountCustomerGetsValue

union

Requires Apps must have read_discounts access scope.

The type of the discount value and how it will be applied. For example, it might be a percentage discount on a fixed number of items. Alternatively, it might be a fixed amount evenly distributed across all items or on each individual item. A third example is a percentage discount on all items.

Anchor to Possible typesPossible types

Anchor to DiscountAmountDiscountAmount
•
OBJECT

The fixed amount value of a discount, and whether the amount is applied to each entitled item or spread evenly across the entitled items.

Anchor to DiscountOnQuantityDiscountOnQuantity
•
OBJECT

The quantity of items discounted, the discount value, and how the discount will be applied.

Anchor to DiscountPercentageDiscountPercentage
•
OBJECT

A discount effect that gives customers a percentage off of specified items on their order.

Was this section helpful?

Anchor to Fields with this unionFields with this union

Anchor to DiscountCustomerGets.valueDiscountCustomerGets.value
•
OBJECT

Entitled quantity and the discount value.

Was this section helpful?