Add a new promotion
Request
- Base URL: https://api.omnium.no (the document declares no server; this is the origin it was published from)
- URL: https://api.omnium.no/api/Promotions
- Auth: API key in header Authorization
Request body
Unique Id of the promotion, GUID will be generated if not provided.
Optional short, human-friendly promotion number. Generated from the tenant's promotion number series if not provided (and a series is configured).
Name of the promotion
Descriptive title of the promotion
Start date of the promotion
End date of the promotion.
Optional start date for cost prices on the linked price list. If null, ActiveFrom is used.
Optional end date for cost prices on the linked price list. If null, ActiveTo is used.
Optional start date for store cost prices on the linked price list. If null, ActiveFrom is used.
Optional end date for store cost prices on the linked price list. If null, ActiveTo is used.
Promotion is only valid for carts with these markets.
Promotion is only valid for carts with these market groups.
Promotion is only valid for carts with these store groups.
Promotion is only valid for carts with these stores.
Promotion will not apply for carts with these stores. Exclude takes priority over include.
Promotion will not apply for carts with stores in these store groups. Exclude takes priority over include.
Only discount for products sent from chosen stores. (Only applies if stores are set). Default is false.
Promotion is only valid for these specific private (B2C) customers by ID.
Promotion is only valid for these specific business (B2B) customers by ID.
Priority of the promotion. Promotions with higher priority will be applied first. 0 is the highest priority.
Coupon code for the promotion. If not set, the promotion will be applied automatically.
Promotion can be combined with other promotions on the same orderLine (e.g. 10% off + 5$ off).
Promotion can be combined also with promotions that have are canBeCombinedWithOtherPromotions = false.
Promotion is valid only for customers that are members of the customer club.
Is reward given in bonus points instead of discount (CustomerClub and CategoryOrBrand promotions only).
Promotion is valid only for these order types (e.g. online, clickAndCollect, pos).
Tag for filtering promotions. E.g. "BlackFriday"
Controls how the promotion filters products based on price type: None (default, no filtering), Exclude, or Include.
Comma-separated flags indicating which price types to filter: Discounted, MemberPrice, or both (Discounted, MemberPrice). Used with PriceFilterMode.
When true, the promotion discount is calculated from the discounted price instead of the original price. Default is false.
When true, the promotion discount is calculated from the product's member (customer club) price. Other campaigns' prices are never used as the base; products without a member price fall back to the ordinary price. Takes precedence over UseDiscountedPriceAsBase. Default is false.
When set, indicates when the promotion price should be automatically converted to a regular price with a "Last Chance" label. Typically set to promotion start date + 30 days.
When true, price records are generated even if the promotion has coupon codes or order type restrictions. false and null both use default behavior.
When true, prices generated by this promotion are excluded from the lowest price history calculation. false and null both use default behavior (included).
When true, a price list is automatically created with the same ID as the promotion. The price list stores planning/budget data for non-PriceListPromotion types.
Response
Success
Changes
No recorded changes to this operation across all 1 revision of this API.