Products | Price List Items

Get price list items for a price list

get/api/PriceLists/{id}/priceListItems

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

Path parameters

idstring nullable required

The id of the price list

Query parameters

pageinteger

Page number

takeinteger

Number of elements

Response

Success

priceListIdstring required

The Id of the price list this item is linked to

skuIdstring nullable

Optional: If the price list item should apply on variant level, specify the sku id.

productIdstring nullable

If skuId is provided, this will be calculated. If not, the priceListItem will apply on product level, and the ProductId is requred.

unitPricenumber

The unit price of the item

costnumber

The cost price in cost currency

costInPriceListCurrencynumber

Calculated: The cost price in the price lists currency

costCurrencyCodestring nullable

Optional per-item override for the cost currency. When set, the price-list-level cost currency is ignored for this item. If provided without CostCurrencyExchangeRate, the rate is resolved server-side via the currency service.

costCurrencyExchangeRatenumber nullable

Optional per-item override for the cost currency exchange rate to the price list currency. When omitted but CostCurrencyCode is set, the rate is resolved server-side via the currency service.

namestring nullable

Name of the price list item

createdstring date-time nullable

Time the item was created

discountnumber

The discount for the price list item

discountPercentnumber

Calculated: The given discount in percentage

discountedPricenumber

Calculated: UnitPrice - Discount

profitnumber

Calculated: UnitPriceExTax - CostInPriceListCurrency

profitPercentnumber

Calculated: Profit/Cost

profitMarginnumber

Calculated: Profit/UnitPriceExTax

isActiveboolean nullable

Calculated: True if the price is activated for the sku. Is set to active when price list is activated.

idstring nullable

Calculated: {PricelistId}_{SkuId}

taxRatenumber nullable

Optional tax rate override for this item. If null, the price list's tax rate is used. Useful when specific products have a different tax rate than the price list default (e.g. 0% for used goods).

tagsstring[] nullable

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

costDiscountnumber

Cost discount amount

costDiscountPercentnumber

Calculated: Cost discount as percentage

discountedCostnumber

Calculated: Cost after discount

unitPriceBasenumber

Calculated: Base unit price before adjustments

storeCostPricenumber

Store cost price in price list currency

storeCostDiscountnumber

Store cost discount amount, in price list currency

storeCostDiscountPercentnumber

Calculated: Store cost discount as percentage of StoreCostPrice

storeDiscountedCostPricenumber

Calculated: Store cost price after the store cost discount

storeCostPriceAdditionPercentnumber

Calculated: the addition on discounted cost that the store cost price represents. Only used as an input when StoreCostPrice is not set.

storeCostPriceMarginnumber

Calculated: Store margin against the ex-tax selling price: (DiscountedPrice ex tax - StoreCostPrice) / DiscountedPrice ex tax * 100

standardCostnumber nullable

Standard cost in cost currency. User-settable via public API.

standardCostInPriceListCurrencynumber nullable

Standard cost in price list currency. Recomputed by the server from StandardCost x CostCurrencyExchangeRate; values set by the caller are overwritten.

discountedStandardCostnumber nullable

Standard cost reduced by the absolute CostDiscount amount. Does not factor in CostDiscountPercent. Calculated server-side; values set by the caller are ignored.

discountedStandardCostInPriceListCurrencynumber nullable

Discounted standard cost in price list currency. Calculated server-side from the absolute CostDiscount; values set by the caller are ignored.

plannedSalesVolumenumber nullable

Planned sales volume (units) - primary planning input

plannedRevenuenumber nullable

Planned revenue calculated from PlannedSalesVolume x DiscountedPrice

planningCommentstring nullable

Optional internal comment for planning context

plannedPurchaseVolumenumber nullable

Planned purchase volume (units) - expected purchasing quantity for the campaign

planningPurchaseCommentstring nullable

Optional internal comment for purchase planning context

Changes

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