Getting Started

Quick Guides

Find the documentation and API endpoints most relevant to your integration needs.

Welcome to Omnium

Different teams integrate with Omnium in different ways. Select your role below to find the most relevant documentation, key concepts, and API endpoints for your work.

E-commerce Frontend

Building webshops, mobile apps, or headless commerce

PIM Integration

Syncing product data from PIM systems

ERP Integration

Order sync, inventory, and financial systems

WMS Integration

Warehouse management, fulfillment, and logistics

Configuration & Admin

Tenants, users, markets, and system settings

Payment Integration

Payment providers and checkout flows

Shipping Integration

Shipping providers, delivery, and tracking

Business Analysts

Reporting, analytics, and data exports

Common Resources

Before diving into role-specific content, ensure you have:

API Access: Get Access Guide - Request credentials and understand authentication
API Documentation: api.omnium.no - Complete Swagger documentation
Test Environment: apitest.omnium.no - Sandbox for development

E-commerce Frontend Developers

Build webshops, mobile apps, or headless commerce solutions using Omnium's product catalog, cart, and checkout APIs.

What You'll Build

Product listing and search pages
Shopping cart functionality
Checkout flows with payment and shipping
Customer account and order history
Inventory availability displays

Key Concepts

Concept	Description
Products	Searchable catalog with variants, pricing, and assets
Cart	Shopping session with items, discounts, shipping, and payment
Orders	Completed purchases with status tracking
Markets	Geographic/business segments with currency and language

Essential API Endpoints

Endpoint	Purpose
`POST /api/Products/SearchProducts`	Search and filter products with facets
`POST /api/Cart/AddItemToCart`	Create cart or add items
`GET /api/Cart/{cartId}`	Retrieve cart details
`POST /api/Cart/{cartId}/Validate`	Validate before checkout
`POST /api/Cart/CreateOrderFromCart/{cartId}`	Complete checkout
`POST /api/Orders/Search`	Customer order history
`GET /api/Inventory/Search`	Check stock availability

Documentation

Quick Start: E-commerce - End-to-end tutorial
Products - Product model and search
Carts - Cart operations and checkout
Inventory - Stock management

PIM Integrators

Sync product information from PIM systems (Akeneo, inRiver, Bluestone, etc.) into Omnium.

What You'll Build

Product import pipelines
Category synchronization
Asset and image management
Multi-language product content
Price list updates

Key Concepts

Concept	Description
Product	Master product with variants (SKUs)
Categories	Hierarchical product classification
Assets	Images and media attached to products
Prices	Market-specific pricing with validity periods

Essential API Endpoints

Endpoint	Purpose
`POST /api/Products`	Create product with variants
`PATCH /api/Products/PatchMany`	Bulk update products (up to 1000)
`POST /api/ProductCategories/AddMany`	Create/update categories
`PUT /api/Prices/AddMany`	Bulk price updates
`POST /api/Products/SearchProducts`	Verify imported products

Best Practices

Use PatchMany for updates - it only updates changed fields
Set prices at product level when variants share the same price
Use delta queries to sync only changed products

Documentation

Product Model - Complete product structure
Product Categories - Category management
Product Assets - Image and media handling
Prices - Pricing strategies
Data In: Best Practices - Bulk import patterns

ERP Integrators

Integrate with ERP systems (Dynamics 365, SAP, Fortnox, etc.) for order sync, inventory, and financial data.

What You'll Build

Order export to ERP
Order status synchronization
Inventory level updates
Return and refund processing
Purchase order management

Key Concepts

Concept	Description
Order	Customer purchase with workflow status
Workflow	Order processing steps (validation, payment, fulfillment)
Returns	Return requests and replacement orders
Events	Real-time notifications for order changes

Essential API Endpoints

Endpoint	Purpose
`POST /api/Orders/Search`	Query orders (use `modifiedSince` for delta)
`PUT /api/Orders/{orderId}/UpdateStatus`	Update order workflow status
`PUT /api/Inventory/UpdateMany`	Sync inventory levels
`POST /api/Returns`	Process returns
`POST /api/Orders`	Create orders from ERP

Integration Patterns

Polling: Use modifiedSince parameter for delta queries
Real-time: Subscribe to events via webhooks or Azure queues
Batch: Use bulk endpoints for high-volume operations

Documentation

Orders - Order model and operations
Order Workflows - Status management
Events - Real-time subscriptions
Delta Queries - Efficient polling
Data Out - Export patterns

Pre-built Connectors

WMS Integrators

Connect warehouse management systems for fulfillment, stock updates, and shipment tracking.

What You'll Build

Real-time inventory synchronization
Order fulfillment feeds
Shipment creation and tracking
Pick/pack operations
Goods receiving

Key Concepts

Concept	Description
Inventory	Stock levels per SKU and warehouse
Warehouse	Fulfillment location (store with `isWarehouse: true`)
Shipment	Delivery tracking with carrier information
Allocation	Reserving inventory for orders

Essential API Endpoints

Endpoint	Purpose
`PUT /api/Inventory/UpdateMany`	Bulk inventory updates (recommended)
`POST /api/Inventory/Search`	Query current stock levels
`POST /api/Orders/Search`	Get orders for fulfillment
`POST /api/OrderShipments`	Create shipments with tracking
`GET /api/Stores/SearchStores`	Get warehouse configuration

Best Practices

Use UpdateMany for inventory - it preserves reserved quantities
Subscribe to order events for real-time fulfillment triggers
Include tracking information when creating shipments

Documentation

Inventory - Stock management
Stores - Warehouse configuration
Order Shipments - Shipment handling
Events - Real-time order notifications

Pre-built Connectors

Ongoing WMS

Configuration & Admin

Set up and configure Omnium tenants, users, markets, and integrations.

What You'll Manage

Market and store structure
User accounts and permissions
API credentials
Integration connectors
System settings

Key Concepts

Concept	Description
Market	Geographic/business segment with currency and language
Store	Sales channel or warehouse location
Roles	Permission groups for users
Triggers	Event subscriptions and webhooks

Essential API Endpoints

Endpoint	Purpose
`PUT /api/Markets/Update`	Configure markets
`POST /api/Stores/AddMany`	Create stores/warehouses
`GET/POST /api/Users`	User management
`GET/POST /api/Role`	Role and permission management
`GET/POST /api/Trigger`	Event subscription setup
`GET/PUT /api/Settings`	System configuration

Getting Started

Set up markets for your geographic regions
Create stores and designate warehouses
Configure API users with appropriate permissions
Set up event subscriptions for integrations

Documentation

Markets - Market configuration
Stores - Store and warehouse setup
Security - Authentication and authorization
Configuration - System settings
Events - Webhook setup

Payment Integrators

Implement payment provider integrations for checkout and payment processing.

What You'll Build

Payment method integration
Checkout session handling
Payment capture and refunds
Payment reconciliation

Key Concepts

Concept	Description
Payment Method	Configured payment provider (Klarna, Vipps, etc.)
Payment Session	Provider-specific checkout session
Capture	Finalizing payment after order fulfillment
Refund	Returning funds to customer

Essential API Endpoints

Endpoint	Purpose
`GET /api/Cart/{cartId}/GetPaymentOptions`	Available payment methods
`POST /api/Cart/{cartId}/AddPayments`	Add payment to cart
`POST /api/Cart/CreateOrderFromCart/{cartId}`	Complete checkout

Pre-built Payment Connectors

Omnium has ready-to-use integrations for major payment providers:

Provider	Documentation
Klarna	Klarna V3
Vipps	Vipps
Dintero	Dintero
Nets Easy	Nets Easy
Qliro	Qliro
Walley	Walley
Resurs Bank	Resurs Bank
Zaver	Zaver
Aera	Aera

Documentation

Carts - Payment - Cart payment operations
Order Payment Steps - Payment workflow

Shipping Integrators

Connect shipping providers for delivery options, label generation, and tracking.

What You'll Build

Shipping option retrieval
Rate calculation
Label generation
Tracking updates
Delivery notifications

Key Concepts

Concept	Description
Shipping Method	Configured delivery option
Shipment	Order delivery with tracking
Carrier	Shipping provider (PostNord, Bring, etc.)

Essential API Endpoints

Endpoint	Purpose
`GET /api/Cart/{cartId}/GetShippingOptions`	Available shipping methods
`POST /api/Cart/{cartId}/AddShipments`	Add shipping to cart
`POST /api/OrderShipments`	Create shipment with tracking
`GET /api/ShipmentOptions`	Query shipping configuration

Pre-built Shipping Connectors

Omnium integrates with Nordic and international carriers:

Provider	Documentation
PostNord	PostNord
nShift Delivery	nShift Delivery
nShift Ship	nShift Ship
Ingrid	Ingrid
Ongoing	Ongoing

Documentation

Order Shipments - Shipment handling
Stores - Warehouse configuration for fulfillment

Business Analysts

Access reporting, analytics, and data exports for business intelligence.

What You'll Access

Order reports and analytics
Sales data exports
Inventory reports
Customer insights
Product performance data

Key Concepts

Concept	Description
Delta Queries	Fetch only changed records since last sync
Scrolling	Paginate through large datasets
Events	Subscribe to data changes

Essential API Endpoints

Endpoint	Purpose
`POST /api/Orders/Search`	Query orders with filters
`POST /api/Products/SearchProducts`	Product catalog data
`POST /api/Inventory/Search`	Stock level reports
`POST /api/Customers/Search`	Customer data (respect GDPR)
`GET /api/AnalyticsOrders`	Order analytics data

Data Export Patterns

Use modifiedSince for incremental exports
Use scrolling for large result sets
Subscribe to events for real-time data feeds

Documentation

Data Out - Export patterns
Delta Queries - Incremental data fetching
Scrolling - Large dataset pagination
Events - Real-time data subscriptions
Customer - Customer data management

Need Help?

API Questions: Explore api.omnium.no for complete endpoint documentation
Integration Support: Contact info@omnium.no
Demo Environment: Request a demo tenant to test your integration

Previous

Get Access

Next

Quick Start: Omnichannel e-com

On this page

Welcome to Omnium Common Resources E-commerce Frontend Developers What You'll Build Key Concepts Essential API Endpoints Documentation PIM Integrators What You'll Build Key Concepts Essential API Endpoints Best Practices Documentation ERP Integrators What You'll Build Key Concepts Essential API Endpoints Integration Patterns Documentation Pre-built Connectors WMS Integrators What You'll Build Key Concepts Essential API Endpoints Best Practices Documentation Pre-built Connectors Configuration & Admin What You'll Manage Key Concepts Essential API Endpoints Getting Started Documentation Payment Integrators What You'll Build Key Concepts Essential API Endpoints Pre-built Payment Connectors Documentation Shipping Integrators What You'll Build Key Concepts Essential API Endpoints Pre-built Shipping Connectors Documentation Business Analysts What You'll Access Key Concepts Essential API Endpoints Data Export Patterns Documentation Need Help?