Search for products, return product list items. Does not return entire product models.
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/SearchProducts
- Auth: API key in header Authorization
Request body
Number of items pr page
Page to fetch
Search by market. Only prices valid for market will be returned
Search by market group. Only products
Search by markets. Only prices valid for the markets will be returned
Search by market groups.
Search by store. Only products available for store, and prices valid for store will be returned
Search by stores. Only products available for stores, and prices valid for stores will be returned
Search by store groups. Only products available for the stores in the store groups, and prices valid for stores will be returned
Only prices valid for store will be returned
Search for products with price above FromPrice
Search for products with price below ToPrice
Search for products with prices that became valid (activated) on or after this date/time
Search for products with prices that became valid (activated) on or before this date/time
Search for products with prices that became invalid (deactivated) on or after this date/time
Search for products with prices that became invalid (deactivated) on or before this date/time
When true, uses OR logic: returns products that are either modified since ModifiedFrom OR have prices that became active in PriceActivatedFrom/To range OR have prices that became inactive in PriceDeactivatedFrom/To range. When false (default), uses AND logic (current behavior).
Search by customer ID. Only prices valid for customer will be returned
Obsolete! Please use CustomerGroups instead. | Search by customer group. Only prices valid for customer group will be returned
Search by customer groups. Only prices valid for customer group will be returned
Search text
Search by product ids
Search by product parent ids
Search by category ids
Search by gtins on product. This searches for matches on fields EAN, GTINS and Units.EAN both on product and variants
Product tags
List of excluded tag names
Product type
If set to true, facets (aggregations) will not be created and returned in the search request. Should always be set if you do not need facets as it will both speed up the search request and reduce the response size.
Primary (1st) sort order. List of options can be found in docs: https://docs.omnium.no/docs/Product/product-api#sort-order
Secondary (2nd) sort order - if set, primary sort order (SortOrder) is required
Tertiary (3rd) sort order - if set, primary (SortOrder) and secondary (SortOrder2nd) sort order is required
If set result will not contain products with sort index lower than threshold
True will only return active products. False will return both active and inactive products.
True will only return inactive products. Ignored if IsActive == true.
True will only return products that are SKUs (products without variants). False will only return products that are not SKUs.
True will only return products that are bundles.
True will only return products that are packages.
True will only return deleted products (Status == "Deleted"). Value is false by default, only returning products that are not deleted.
True returns products in stock. False returns products not in stock. Null returns both. Should be combined with InStockMarketIds or InStockWarehouseIds for additional filtering.
Select which market(s) the IsInStock filter should be applied to. If not set, IsInStock will return true if any market has the item in stock.
Select which warehouse(s) the IsInStock filter should be applied to. If not set, IsInStock will return true if any warehouse has the item in stock.
True returns only main variants.
True returns products on sale. False returns products not on sale. Null returns both.
Only works if separate cost prices are enabled in the configuration. True returns products with cost on sale. False returns products with cost not on sale. Null returns both.
List of promotion IDs. Return only products with active prices with any of the promotion IDs.
Products modified from date
Products modified before date
If true, prices are searched, parsed and sorted in Omnium, but the price list is not returned
Number of days since published. This will replace StartPublishFrom date.
Products published from date
Products published to date
Products stopped published from date
Products stopped published from date
| If true - only returns products published today
Language code e.g. en, no, es
Ignore product language filter. If "ProductLanguage" is not specified in the request, we use the selected market's productContentLanguage with fallback to default product language. Set this option to true if you wish to search on all languages.
List of specified product Ids to exclude. Typically used if you want to search for sibling products (with a common parent ID) but you'll want to exclude the products you already have.
Property list ID - Predefined property lists in settings for filtering
Search by supplier.
Search by supplier skuIds.
Search by assortment codes.
If set to 'true', the customer in product search context's assortment codes will not be used in the product search.
Search products with external IDs
When true, the product must have an assortment that matches one of the provided assortment codes and if the product search request does not include any assortment codes, only products without assortment codes are returned. If null, the system defaults to the 'IsAssortmentStoreIdRequired' configuration setting.
Explicit override for the date used to evaluate AssortmentCode ValidFrom/ValidTo windows on customer and product assortments. When null the search falls back to Omnium.Public.Products.Search.OmniumProductSearchRequest.RequestedDeliveryDate and then to the current UTC time. Compared at minute granularity.
The requested delivery date for this search context. When set, assortment-code validity is evaluated against this date instead of the current time, so products whose assortment becomes valid only after this date (or expires before it) are filtered accordingly. Overridden by Omnium.Public.Products.Search.OmniumProductSearchRequest.AssortmentCodeEvaluationDate when both are provided. Treated as unset when null.
Search for products by component IDs. Returns all products that contain any of the specified IDs in their component-related properties (e.g., skuId, productId).
When true, returns only products that are available online (have stock in online-enabled warehouses). When false, returns only products not available online. When null (default), returns both.
Product category IDs to exclude from search results. Products in these categories will not be returned.
Search by SEO URI(s)
Only relevant when IsLocalProductsEnabled is enabled in productSettings. Filter by local product
Response
Search successful, returning product list items (view model)
Total number of hits
The Scroll ID is used when fetching large amounts of data. Whenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents
Deprecated
Changes
No recorded changes to this operation across all 1 revision of this API.