Promotions

Get potential-discount hints for a cart: promotions that would apply if more items were added, an order amount was met, a club member was attached, or a coupon was entered.

get/api/Promotions/GetPotentialDiscounts

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/GetPotentialDiscounts
  • Auth: API key in header Authorization

Query parameters

cartIdstring nullable

ID of the cart to evaluate

Response

Success

type'MultiBuyMissingQuantity' | 'OrderAmountMissing' | 'ShippingAmountMissing' | 'KitMissingItems' | 'ClubMemberRequired' | 'CouponRequired'

Type of potential-discount hint returned by GetPotentialDiscounts.

promotionIdstring nullable

Id of the promotion this hint relates to.

promotionNamestring nullable

Display name of the promotion.

rewardPercentagenumber nullable

Reward percentage of the promotion, when the reward is percentage-based.

rewardUsePercentageboolean

True if the reward is a percentage discount; false if it is a fixed amount.

missingQuantityinteger nullable

Number of additional units required for the promotion to apply.

missingAmountnumber nullable

Additional amount required for the promotion to apply.

potentialSavingsnumber nullable

Estimated savings if the missing condition is met.

currencystring nullable

Currency for MissingAmount and PotentialSavings.

relatedLineItemIdstring nullable

Id of the cart line item this hint is related to, if any.

relatedProductIdstring nullable

Id of a product associated with the hint (e.g. the missing kit component).

relatedProductNamestring nullable

Name of the related product, if any.

relatedImageUrlstring nullable

Image URL of the related product, if any.

requiredCouponCodestring nullable

Coupon code required for the promotion to apply, when Type is CouponRequired.

Changes

No recorded changes to this operation across all 1 revision of this API.