Promotions

Returns a single promotion

get/api/Promotions/{id}

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

Path parameters

idstring nullable required

ID of the promotion to return

Response

Success

idstring nullable
numberstring nullable

Optional short, human-friendly promotion number from the tenant's promotion number series. Null when the tenant has no series configured.

namestring nullable
titlestring nullable
descriptionstring nullable
activeFromstring date-time
activeTostring date-time
costPriceActiveFromstring date-time nullable

Optional start date for cost prices on the linked price list (PriceListPromotion). If null, ActiveFrom is used.

costPriceActiveTostring date-time nullable

Optional end date for cost prices on the linked price list (PriceListPromotion). If null, ActiveTo is used.

storeCostPriceActiveFromstring date-time nullable

Optional start date for store cost prices on the linked price list (PriceListPromotion). If null, ActiveFrom is used.

storeCostPriceActiveTostring date-time nullable

Optional end date for store cost prices on the linked price list (PriceListPromotion). If null, ActiveTo is used.

marketsstring[] nullable
marketGroupsstring[] nullable
storeGroupsstring[] nullable
storesstring[] nullable
excludedStoresstring[] nullable
excludedStoreGroupsstring[] nullable
filterOnWarehouseStoresboolean
privateCustomerIdsstring[] nullable
businessCustomerIdsstring[] nullable
deactivatedboolean
priorityinteger
promotionServicestring nullable
couponCodestring nullable
canBeCombinedWithOtherPromotionsboolean
alwaysApplyboolean
customerClubMembersOnlyboolean
tenantIdstring nullable
indexIdentifierstring nullable
createdDatestring date-time nullable
updatedDatestring date-time nullable
userIdstring nullable

User ID of whoever created the promotion. Captured by Omnium on create; read-only.

userNamestring nullable

Display name of whoever created the promotion. Captured by Omnium on create; read-only.

orderTypesstring[] nullable
tagsstring[] nullable
priceFilterModestring nullable

Controls how the promotion filters products based on price type: None (default, no filtering), Exclude, or Include.

priceTypeFilterstring nullable

Comma-separated flags indicating which price types to filter: Discounted, MemberPrice, or both (Discounted, MemberPrice). Used with PriceFilterMode.

useDiscountedPriceAsBaseboolean

When true, the promotion discount is calculated from the discounted price instead of the original price.

useMemberPriceAsBaseboolean

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.

convertToRegularPriceAtstring date-time nullable

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.

isConvertedToRegularPriceboolean

Whether this promotion has been converted to a regular price with Last Chance flag.

convertedToRegularPriceAtstring date-time nullable

When the conversion to regular price was executed.

forceGeneratePricesboolean nullable

When true, price records are generated even if the promotion has coupon codes or order type restrictions. false and null both use default behavior.

excludeFromLowestPriceHistoryboolean nullable

When true, prices generated by this promotion are excluded from the lowest price history calculation. false and null both use default behavior (included).

createPriceListboolean nullable

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.

Changes

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