Products | Update

Create new product, update if exists

Sample request for adding a product with three variants, market prices and customer specific price, assets and a custom property.

POST /api/products
{
  "id": "ABC-123_no",
  "productId": "ABC-123",
  "parentId": "ABC",
  "language": "no",
  "name": "Omnium Super Stylish sweater /w logo",
  "color": "black",
  "shortDescription": "A black cotton sweater",
  "description": "A beautifully made sweater, with a stylish black color and the well known Omnium logo in white large print. 100% cotton. Designed in Oslo.",
  "brand": "Omnium Sweaters 'n Jeans",
  "season": "FW22",
  "unit": "pcs",
  "weight": 900,
  "created": "2022-11-11T00:00:00",
  "published": "2022-12-12T00:00:00",
  "discontinued": "2026-06-03T00:00:00",
  "isActive": true,
  "variants": [
    {
      "skuId": "000000000001",
      "isActive": true,
      "isSku": true,
      "size": "S"
    },
    {
      "skuId": "000000000002",
      "isActive": true,
      "isSku": true,
      "size": "M"
    },
    {
      "skuId": "000000000003",
      "isActive": true,
      "isSku": true,
      "size": "L"
    }
  ],
  "prices": [
    {
      "marketId": "NOR",
      "unitPrice": 500,
      "currencyCode": "NOK"
    },
    {
      "marketId": "NOR",
      "code": "000000000002",
      "validFrom": "2022-01-01T00:00:00",
      "validUntil": "2023-01-01T00:00:00",
      "unitPrice": 250,
      "currencyCode": "NOK",
      "customerGroup": "100",
      "discountAmount": 250,
      "discountPercent": 50,
      "originalUnitPrice": 500
    }
  ],
  "assets": [
    {
      "assetId": "78901",
      "sortOrder": 1,
      "url": "https://omnium-cdn-url-goes-here.com/id/305/200/300",
      "externalUrl": "https://i.picsum.photos/id/305/200/300.jpg?hmac=qqxVDT5GPIxyVNSo9Y_9u_qZSwXU4Cy94gp7VAMVRIw",
      "isMainImage": true
    },
    {
      "assetId": "12345",
      "sortOrder": 2,
      "url": "https://omnium-cdn-url-goes-here.com/id/544/200/300",
      "externalUrl": "https://i.picsum.photos/id/544/200/300.jpg?hmac=YL3M_fg_84Kqg0EQTvbltmjeGeQetARWPFA5YLn5hS0",
      "name": "Close-up Omnium Awesome Sweater",
      "description": "Close-up on the sweater, but this is just a random image though.",
      "altText": "Close-up"
    }
  ],
  "properties": [
    {
      "key": "CollarType",
      "value": "CrewNeck"
    },
    {
      "key": "IsAwesome",
      "value": "true",
      "valueType": "Boolean"
    }
  ]
}
post/api/Products

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

Request body

isSkuboolean

True if product is stock keeping unit / product that can be sold. Should always be set to true for products without variants and false for products with variants.

parentIdstring nullable

The ParentId should only be set for products that has a third product level, which is above product and variant. For instance, if you have a product 'Awesome Sweater' that comes in 5 colors which each has 3 sizes, you should store this as five products with three variants each. You could then populate 'ParentId' in order to group the five products together.

isLocalProductboolean nullable

Only relevant when IsLocalProductsEnabled is enabled in productSettings. When enabled, both 'IsLocalProduct' must be activated and the user must have access to a selected store in order to edit the product

idstring nullable

Required for products: Product unique ID. If your product catalog has multiple languages, the ID should be set with the following convention {ProductId}{Language} ('12345_en'). For variants, the ID will be populated from SkuID, and should not be set manually. Valid format: Only letters (a-z, A-Z), digits (0-9), hyphens (-), and underscores (_). Regex pattern: ^[a-zA-Z0-9-]+$

skuIdstring nullable

Product unique SKU (but equal for all language versions). This should only be set for variants, or if the product itself is sellable and is stored with 'IsSku=true' and has no variants.

eanstring nullable

EAN code

gtinsstring[] nullable

GTIN codes

productIdstring nullable

Unique product Id, without language conventions. Variants on a product should have the same value for ProductId as the product has.

namestring nullable

Product name

startDatestring date-time

Product activation date. Product is not active if date is in the future. Obsolete - Use Published property instead

endDatestring date-time

Product activation end date. Product is not active if date is in the past. Obsolete - Use StopPublished property instead

createdstring date-time

Date product is created

modifiedstring date-time

Date product is modified

publishedstring date-time nullable

Date product is published. Set automatically when an active product is saved without one. Can be null.

stopPublishedstring date-time nullable

Product activation end date. Can be null

discontinuedstring date-time nullable

Product discontinuation date. If discontinued date has passed, it should not be reordered from supplier

isActiveboolean

True if product is active. False if it should be hidden from customers.

catalogstring nullable

Label to categorize or group products. In Omnium this is used to show statistics grouped by this label. (This property is unrelated to the category tree.)

mainCategoryIdstring nullable

This is the main category for the product, and should be one of the CategoryIds in Categories. If Catalog is not used, this category's name will be used as grouping in statistics. If the main category is missing from the category list, it will automatically be added.

mainCategoryNamestring nullable

Calculated field: If MainCategoryId is given, and exists as a category in Omnium, this property will be overwritten by the name of that category.

mainImageUrlstring nullable

Product main image url. If not set, this will be populated from the product assets, using the asset which has 'IsMainImage="true"' set. If none are set, the first asset in the list is selected.

entryTypestring nullable

Product entry type

isBundleboolean

True if product is a bundle of other products (unlike package, price is sum of components)

isKitboolean

True if product is a pre-assembled kit made of other products (unlike package and bundle, kits have inventory)

isPackageboolean

True if product is package of other products (unlike bundle, price is specified for package)

preventPackageSplitboolean nullable

Controls whether this package/bundle's components may be allocated to different warehouses. True: components always ship together. False: components may be split, though components linked via ShipTogetherWithComponentId still stay together. Null: the allocation flow's default applies.

isWriteProtectedboolean

True if product is write protected by user. PIM integrations should not override product information.

isInStockboolean

Calculated: This is populated automatically by default based on inventory and updated by a scheduled task which updates the products every 30 minutes.

availableInventorynumber

Calculated: Number of items available in stock. If this is a product with variants, it will be a sum of all variants. This is populated automatically by default based on inventory and updated by a scheduled task which updates the products every 30 minutes.

inventoryStatusstring nullable

Status of current inventory, based on AvailableInventory. Could be 'OutOfStock', 'LowInStock' or 'HighInStock'

omniStockstring[] nullable

Calculated: List of store IDs where this product is available online (has stock and meets business rules for online sales)

catalogNodesstring[] nullable

Catalog nodes/categories. Simple list of strings of category names. Consider using the Categories property instead as this also contains IDs and category metadata.

minQuantitynumber

Minimum inventory quantity (point of reordering)

maxQuantitynumber

Max inventory quantity (what should be in stock after new supply)

weightnumber double nullable

Product weight in kilograms (kg)

taxCategorystring nullable

Product tax category

taxGroupCodestring nullable

References a TaxGroup.Code in the tenant's chart of tax groups. When null, the tenant's DefaultTaxGroupCode applies (if feature is enabled). Has no effect when AccountingSettings.TaxGroupsEnabled = false.

taxRatenumber nullable

Per-product VAT rate used as a fallback when tax groups are not configured. Applied to any price that has no TaxRate of its own at save time. Tax-group resolution takes precedence when enabled.

siblingsstring[] nullable

List of sibling product IDs Obsolete - Use RelatedProducts instead

associatedProductsstring[] nullable

Associated product IDs Obsolete - Use RelatedProducts instead

tagsstring[] nullable

List of tags.

marketIdsstring[] nullable

List of available market IDs. If not set, the product will be available for all markets.

storeIdsstring[] nullable

List of available store IDs. If not set, the product will be available for all stores.

marketGroupIdsstring[] nullable

List of available market group IDs

languagestring nullable

Product language code. This should match 'ProductContentLanguage' on a stored market in Omnium. Typically the values would be 'en' (english) or 'no' (norwegian).

locationstring nullable

The location of the product in the warehouse.

colorstring nullable

Product color

brandstring nullable

Product brand

sizestring nullable

Product size

shortDescriptionstring nullable

Short product description

descriptionstring nullable

Product description

specificationstring nullable

Product Specification

averageRatingnumber double

Calculated - Average rating for this product

ratingCountinteger

Calculated - Number of ratings for this product

isNotRatableboolean nullable

Set to true if this product should be excluded from rating emails/forms

excludeFromPromotionsboolean nullable

Set to true if this product should be excluded from promotions

salesStartDatestring date-time nullable

Embargo date: product cannot be sold before this date

fixedPriceCodestring nullable

Price protection category (e.g. book law)

fixedPriceEndDatestring date-time nullable

Discounts are blocked until this date

discountBlockedboolean nullable

Permanent discount prohibition

isExcludedFromAnalyticsboolean

Set to true if this product should be excluded from analytics (e.g., gift cards that would inflate sales figures)

supplierNamestring nullable

Name of main product supplier

supplierIdstring nullable

Main supplier ID

supplierColorstring nullable

Color from supplier

supplierPackagingUnitstring nullable

Unit for supplier sku

supplierPackagingQuantitynumber nullable

Supplier packaging quantity (D-Pack)

allowSupplierPackageBreakboolean nullable

Indicates if supplier packages can be split to order quantities smaller than the full package size.

leadTimeinteger nullable

Lead time in days

supplierLeadTimeinteger nullable

Supplier lead time in days

supplierSkuIdstring nullable

External product ID from supplier, used when creating purchase orders

freightClassstring nullable

Freight class

sizeTypestring nullable

Product size type

unitstring nullable

Product unit, used for describing what unit the quantities are in

seasonstring nullable

Product season

sortIndexinteger

Calculated sort index

sortIndexBoostinteger

Sort index set by API / GUI

sortIndexBaseinteger

Calculated sort index base set by Omnium services

isBackorderboolean

If true, the product have no reorder level, and will usually not be in stock

isPriceLockedboolean

When true, the price on order lines created from this product will be locked and not recalculated.

isMainProductVariantboolean

If true, this variant should represent the product in flattened variant lists. This can also be used if you have a product catalog with multiple products with the same parent ID set, and you only wish to show one of the products in product searches. You could then set this to 'false' on the products you wish to exclude from searches, and filter on the value.

isSerializableProductboolean

If true, the product is serializable, and order line should contain serial number when completed

isRentalboolean

If true, the product is available for rental

rentalSourceProductIdstring nullable

The SKU ID of the original product this rental product was created from

alternativeProductNamestring nullable

Alternative product name

costnumber

Product net cost

costCurrencystring nullable

Currency code. E.g. USD, EUR, NOK

costInDefaultCurrencynumber nullable

Cost in default currency

productTypestring nullable

Optional: Specifies if this product is of a specific kind. An example of this is the type "ProductOption" A Product Option is a sold as an additional item or service to an other product, and is not sold by itself. Inscriptions or other types of customization could be this sort of option. It could also be a service, such as assembling, or it could be an additional item which would not make sense so sell on it's own

promotionIdsstring[] nullable

Promotions associated with the product

locationOverstockstring[] nullable

Overstock locations (extra inventory locations)

isVirtualboolean nullable

Virtual products will not affect inventory.

genderstring nullable

Gender

countryOfOriginstring nullable

Country of origin

customsCodestring nullable

Customs code for the product

expectedDeliveryDatestring date-time nullable

Date when the product is expected back in stock. Calculated by purchase order services, or set externally.

statusstring nullable

Status is set by Omnium. "Published" is default. When delete a product in GUI. Status will be updated to "Deleted"

Response

Product created successfully

Changes

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