Get a variant by product and variant 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/Products/{productId}/Variants/{variantId}
- Auth: API key in header Authorization
Path parameters
Response
Variants found and returned
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.
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.
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
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-]+$
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.
EAN code
GTIN codes
Unique product Id, without language conventions. Variants on a product should have the same value for ProductId as the product has.
Product name
Product activation date. Product is not active if date is in the future. Obsolete - Use Published property instead
Product activation end date. Product is not active if date is in the past. Obsolete - Use StopPublished property instead
Date product is created
Date product is modified
Date product is published. Set automatically when an active product is saved without one. Can be null.
Product activation end date. Can be null
Product discontinuation date. If discontinued date has passed, it should not be reordered from supplier
True if product is active. False if it should be hidden from customers.
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.)
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.
Calculated field: If MainCategoryId is given, and exists as a category in Omnium, this property will be overwritten by the name of that category.
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.
Product entry type
True if product is a bundle of other products (unlike package, price is sum of components)
True if product is a pre-assembled kit made of other products (unlike package and bundle, kits have inventory)
True if product is package of other products (unlike bundle, price is specified for package)
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.
True if product is write protected by user. PIM integrations should not override product information.
Calculated: This is populated automatically by default based on inventory and updated by a scheduled task which updates the products every 30 minutes.
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.
Status of current inventory, based on AvailableInventory. Could be 'OutOfStock', 'LowInStock' or 'HighInStock'
Calculated: List of store IDs where this product is available online (has stock and meets business rules for online sales)
Catalog nodes/categories. Simple list of strings of category names. Consider using the Categories property instead as this also contains IDs and category metadata.
Minimum inventory quantity (point of reordering)
Max inventory quantity (what should be in stock after new supply)
Product weight in kilograms (kg)
Product tax category
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.
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.
List of sibling product IDs Obsolete - Use RelatedProducts instead
Associated product IDs Obsolete - Use RelatedProducts instead
List of tags.
List of available market IDs. If not set, the product will be available for all markets.
List of available store IDs. If not set, the product will be available for all stores.
List of available market group IDs
Product language code. This should match 'ProductContentLanguage' on a stored market in Omnium. Typically the values would be 'en' (english) or 'no' (norwegian).
The location of the product in the warehouse.
Product color
Product brand
Product size
Short product description
Product description
Product Specification
Calculated - Average rating for this product
Calculated - Number of ratings for this product
Set to true if this product should be excluded from rating emails/forms
Set to true if this product should be excluded from promotions
Embargo date: product cannot be sold before this date
Price protection category (e.g. book law)
Discounts are blocked until this date
Permanent discount prohibition
Set to true if this product should be excluded from analytics (e.g., gift cards that would inflate sales figures)
Name of main product supplier
Main supplier ID
Color from supplier
Unit for supplier sku
Supplier packaging quantity (D-Pack)
Indicates if supplier packages can be split to order quantities smaller than the full package size.
Lead time in days
Supplier lead time in days
External product ID from supplier, used when creating purchase orders
Freight class
Product size type
Product unit, used for describing what unit the quantities are in
Product season
Calculated sort index
Sort index set by API / GUI
Calculated sort index base set by Omnium services
If true, the product have no reorder level, and will usually not be in stock
When true, the price on order lines created from this product will be locked and not recalculated.
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.
If true, the product is serializable, and order line should contain serial number when completed
If true, the product is available for rental
The SKU ID of the original product this rental product was created from
Alternative product name
Product net cost
Currency code. E.g. USD, EUR, NOK
Cost in default currency
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
Promotions associated with the product
Overstock locations (extra inventory locations)
Virtual products will not affect inventory.
Gender
Country of origin
Customs code for the product
Date when the product is expected back in stock. Calculated by purchase order services, or set externally.
Status is set by Omnium. "Published" is default. When delete a product in GUI. Status will be updated to "Deleted"
Changes
No recorded changes to this operation across all 1 revision of this API.