Products | Price Lists

Get price list

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

Path parameters

idstring required

The id of the price list

Response

Success

idstring required

Unique identifier for the price list.

namestring required

The name of the price list.

priceListType'Price' | 'CostPrice' | 'PriceAndCostPrice'

The price list can be used to populate only prices, only cost prices or both. The default value is Price.

priceType'Default' | 'PriceFactor'
marketIdstring nullable

Identifier for the market this price list applies to (deprecated - use MarketIds or MarketGroupId instead).

marketIdsstring[] nullable

List of market IDs this price list applies to. Replaces MarketId for multi-market support. Mutually exclusive with MarketGroupId.

marketGroupIdstring nullable

Market group ID this price list applies to. All markets in the group will be included. Mutually exclusive with MarketIds.

storeIdsstring[] nullable

List of store IDs where this price list is applicable. Limited to a maximum of 1000 store IDs.

currencyCodestring required

The currency code for the prices in this price list

costCurrencyCodestring nullable

Currency code for the cost price. Defaults to the same as CurrencyCode

costCurrencyExchangeRatenumber nullable

The exchange rate from cost currency to the currency for the price list. If not given, it will be calculated and set to today's exchange rate.

customerIdsstring[] nullable

List of customer IDs this price list applies to. Limited to a maximum of 250 customer IDs.

validFromstring date-time nullable

The start date and time from which the price list is valid.

validTostring date-time nullable

The end date and time until which the price list is valid. If null, the price list does not expire.

costPriceValidFromstring date-time nullable

Optional start date for cost prices. Allows the buying window to differ from the selling window (e.g. a store buying stock earlier than the campaign sells). If null, ValidFrom is used.

costPriceValidTostring date-time nullable

Optional end date for cost prices. Allows the buying window to differ from the selling window. If null, ValidTo is used.

storeCostPriceValidFromstring date-time nullable

Optional start date for store cost prices (only relevant when IsStoreCostPriceEnabled is true). If null, ValidFrom is used.

storeCostPriceValidTostring date-time nullable

Optional end date for store cost prices (only relevant when IsStoreCostPriceEnabled is true). If null, ValidTo is used.

unitstring nullable

The unit of measurement for the price list (e.g., "KG", "PCS"). IMPORTANT: Only use this if price list should apply to other units than the main sales unit

roundingDecimalsinteger nullable

Number of decimal places to use when calculating unit price.

isCustomerClubSpecificPriceboolean nullable

If the prices should be customer specific

taxRatenumber nullable

The tax rate for the price list. If not given, the default tax rate for the market will be set.

isExcludingTaxboolean

If tax should be ignored on the price list

isActiveboolean

Calculated: True if the price list is activated.

isPromotionsAllowedboolean nullable

True if prices from the price list can be combined with promotions

publishedstring date-time nullable

Calculated: The time when the price list was activated

createdstring date-time nullable

Created date

modifiedstring date-time nullable

Calculated: Modified date

priceFactornumber nullable

PriceFactor and PurchaseDiscountPercentage is used to calculate 'configurable product prices. PriceFactor works as a exchange rate (with mark-up) when calculating the placed price (example SEK) from the inputted list price (NOK).

purchaseDiscountPercentagenumber

Only relevant for configurable products when calculating cost price from inputted list price

isPriceEditableboolean

Allow editing the calculated prices which are disabled by default

useLatestExchangeRateForCostboolean

When enabled, the latest available currency exchange rate is always used to calculate the cost

supplierIdstring nullable
tagsstring[] nullable

Tags for categorizing/labeling price lists (e.g. "Last Chance", "Clearance"). Downstream systems can use these tags for display logic.

isStoreCostPriceEnabledboolean

Enable store cost pricing with separate market/store group dimensions

storeCostPriceMarketIdsstring[] nullable

Market IDs for store cost price dimension

storeCostPriceStoreGroupIdsstring[] nullable

Store group IDs for store cost price dimension

promotionIdstring nullable

Reference to the owning promotion.

isMetadataOnlyboolean

When true, this price list contains only planning/budget metadata and does not push prices to products.

Changes

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