Passa al contenuto principale

Promotion

Promotion applied to a row of an order: of the percentage_* and amount_* fields, only the one of its type is set

promocodestring | nullnullablerequired

Promotional code used; null when the promotion applies without a code

descriptionstring | nullnullablerequired

Promotion description; null when the promotion has none

percentage_increasefloatnullablerequired

Price increase, in percent; null for the other types

percentage_decreasefloatnullablerequired

Discount, in percent; null for the other types

amount_increase objectrequired

Price increase, as an amount before VAT; null for the other types

anyOf
amountfloatnullablerequired

Taxable amount

currencystringrequired

Currency code: always EUR

tax_ratefloatnullablerequired

VAT rate as a fraction, for example 0.22 for 22%

taxfloatnullablerequired

VAT (tax) amount

totalfloatnullablerequired

Total amount

amount_decrease objectrequired

Discount, as an amount before VAT; null for the other types

anyOf
amountfloatnullablerequired

Taxable amount

currencystringrequired

Currency code: always EUR

tax_ratefloatnullablerequired

VAT rate as a fraction, for example 0.22 for 22%

taxfloatnullablerequired

VAT (tax) amount

totalfloatnullablerequired

Total amount

amount_fixed objectrequired

Fixed price set by the promotion, before VAT; null for the other types

anyOf
amountfloatnullablerequired

Taxable amount

currencystringrequired

Currency code: always EUR

tax_ratefloatnullablerequired

VAT rate as a fraction, for example 0.22 for 22%

taxfloatnullablerequired

VAT (tax) amount

totalfloatnullablerequired

Total amount

applied_amount objectrequired

Difference between the base price and the price of the order row (base_price and price of OrderRow): negative when the promotion increases the price

anyOf
amountfloatnullablerequired

Taxable amount

currencystringrequired

Currency code: always EUR

tax_ratefloatnullablerequired

VAT rate as a fraction, for example 0.22 for 22%

taxfloatnullablerequired

VAT (tax) amount

totalfloatnullablerequired

Total amount

date_applieddate-timerequired

When the promotion was applied to the order

Promotion
{
"promocode": "string",
"description": "string",
"percentage_increase": 0,
"percentage_decrease": 0,
"amount_increase": {
"amount": 0,
"currency": "string",
"tax_rate": 0,
"tax": 0,
"total": 0
},
"amount_decrease": {
"amount": 0,
"currency": "string",
"tax_rate": 0,
"tax": 0,
"total": 0
},
"amount_fixed": {
"amount": 0,
"currency": "string",
"tax_rate": 0,
"tax": 0,
"total": 0
},
"applied_amount": {
"amount": 0,
"currency": "string",
"tax_rate": 0,
"tax": 0,
"total": 0
},
"date_applied": "2024-07-29T15:51:28.071Z"
}