AppliedPromotion
objectInformation about an applied promotion to a single item.
Coupon identifier for the promotion.
<= 40 characters
Example:7610300001381
Amount of awarded Cumulus Points for a single item.
> 0
Example:2
Amount of the price reduction per unit for a single item.
> 0
Example:1.1
Calculate
objectRequest body for calculating prices.
List of coupon GTINs to take into account for the price calculation.
>= 4 characters
Example:7613404420317
One OfInformation about the customer and their loyalty.
Example:{"cumulus_number":"2099123123123","loyalty":["cumulus"]}
Information about the customer.
Show Child Parameters
Date and time used for calculating the prices.
This defaults to now but can be used to calculate prices based historic data.
Product to calculate prices for.
>= 1 items
Example:{"product_id":"120299100000","quantity":3}{"product_id":"101924500000","unit":"KG","weight":3.5}
Show Child Parameters
List of user coupon IDs (UCB) to take into account for the price calculation.
>= 4 characters
Example:456456456
CalculatedItem
objectInformation about calculated prices for a single item.
One OfInformation about the different amounts for a single item.
Information about the different amounts for a single item.
Show Child Parameters
Information about an applied promotion to a single item.
Show Child Parameters
Unit price before any promotions are applied.
> 0
Example:12.5
ID of the product.
Calculation
objectResponse with calculated prices.
One OfInformation about the different total amounts.
Information about the different total amounts.
Show Child Parameters
List of coupons attached to the calculation.
>= 1 items
Information about calculated prices for a single item.
>= 1 items
Show Child Parameters
Information about calculated prices for a single item.
>= 1 items
Show Child Parameters
Information about the VAT.
Show Child Parameters
Customer
objectInformation about the customer.
Cumulus number of the customer.
>= 10 characters<= 40 characters
Example:2099123123123
Loyalty programs the customer is part of.
A person who uses the loyalty program GKK cannot use any of the other loyalty programs. Therefore the maxItems
is set to 4, even though there are 5 loyalty programs in total.
Allowed values:cumulusfamigrosgenossenschaftermigustogkk
<= 4 items
Example:cumulus