Skip to main content

OrderIncentiveParams

The parameters the incentive ran with.

type OrderIncentiveParams {
quantity: Int
price: Float
productId: Int
discount: Float
discountType: String
valuePoints: Float
repeat: YesNo
actionCode: String
}

Fields​

OrderIncentiveParams.quantity ● Int scalar​

Quantity the incentive used, for example the number of bonus items.

OrderIncentiveParams.price ● Float scalar​

Price the incentive used, for example the price of a bonus item or the shipping or transaction costs it set.

OrderIncentiveParams.productId ● Int scalar​

Identifier of the product the incentive used, for example the bonus product.

OrderIncentiveParams.discount ● Float scalar​

Discount the incentive gave, as an amount or a percentage depending on discountType.

OrderIncentiveParams.discountType ● String scalar​

How discount is applied: FLAT_FEE (an amount) or PERCENTAGE.

OrderIncentiveParams.valuePoints ● Float scalar​

Value points the incentive used.

OrderIncentiveParams.repeat ● YesNo enum​

Whether the incentive is given once per complete set its condition counts (Y) or once per order (N).

OrderIncentiveParams.actionCode ● String scalar​

Action code the rule requires, when it is an action-code rule.

Member Of​

OrderIncentive object