circle-check
Heads up, our devs are blazing ahead—docs are catching up, so some features might not be fully documented yet.

Products, brands & categories

Overview

Product data flows one-way from Omnium to Flow. Omnium acts as the master system for the product catalog, and Flow receives product information through its standard REST API. This includes product details, variants, brands, categories, product groups, and images.

Products are synchronized automatically whenever a product is saved in Omnium.

Sync process

1

Product selection

Omnium identifies products modified since the last export, filtered by market/market group

2

Brand sync

Creates brands in Flow if they don't exist

3

Product mapping

Transforms Omnium data to Flow format (sanitizes UIDs, converts prices to cents, strips HTML)

4

Create/update

Adds new products or updates existing ones in Flow

5

Variant handling

Links configurable products as siblings

6

Image export

Uploads product media to Flow

7

Property sync

Synchronizes variant and text properties

Product field mapping

Core fields

Flow field
Omnium source
Notes

productUid

SkuId or ProductId

UID-sanitized

name

Name

sku

SkuId

Defaults to "NoSku" if empty

description

Description

HTML tags stripped

shortDescription

ShortDescription

HTML tags stripped

brandUid

Brand

Lowercased and sanitized (e.g., "Nike Air" → nike_air)

productGroupUid

MainCategoryId

Maps to Flow product group

allowPurchase

IsActive + assortment codes

Validates against non-purchasable codes

Pricing fields

Flow field
Omnium source
Notes

purchasePrice

Cost

Converted to cents (integer)

recommendedRetailPrice

Best valid price

Skipped if using price scheduled task

currencyPurchasePrice

Cost + CostCurrency

Only set when CostCurrency is present

Physical attributes

Flow field
Omnium source
Notes

weight

Weight or colli weight

Integer in grams

height

Colli Height

Integer in millimeters

width

Colli Width

Integer in millimeters

length

Colli Length

Integer in millimeters

numberOfPieces

Colli.Count

Defaults to 1

Identification

Flow field
Omnium source
Notes

gtins

Gtins or Ean

GTIN/EAN barcodes

manufacturerSku

External ID "Manufacturer SKU"

vatCodeUid

Product type mapping or default

See VAT configuration below

serialNoRequired

IsSerializableProduct

"ONSALE" if true, "NO" if false

Additional fields

Flow field
Omnium source
Notes

discontinuedFrom

StopPublished

Only on updates

limitToStoreUids

StoreIds

Restricts product to specific stores

productType

Property FlowProductType

Defaults to "STOCK"

Product types

Three product types are supported via the FlowProductType property in Omnium:

Type
Description

STOCK

Standard inventory-tracked product (default)

CONFIGURABLE

Product with variant options (color, size, etc.)

GIFTCARD

Gift card product

Variant products (configurable)

Products with a variantAttributes custom property become configurable products with a parent-child structure.

Variant properties

Use key group FlowVariantProperty for properties that define the variant selection (e.g., color, size):

Text properties

Use key group FlowTextProperty for descriptive, non-variant properties (e.g., material):

The main product is set to type CONFIGURABLE, and child products are linked as siblings with their variant property values.

Brands

Brands are synchronized automatically during product export. When a product references a brand that doesn't exist in Flow, Omnium creates it.

The brand UID is derived from the brand name — lowercased and sanitized:

  • "Nike Air"nike_air

  • "Levi's"levis

Categories and product groups

Standard categories

When SyncCategoriesToFlow is enabled in the Omnium connector, categories are exported to Flow and assigned to products.

Product groups

When ProductGroupRootId is configured, categories under that root are exported as product groups (since Flow products can only belong to one product group). The product's MainCategoryId maps to a Flow product group. If unset, DefaultProductGroupUid is used as a fallback.

Category sync can be scheduled:

Product images

Product images and media are exported after product synchronization. The integration sends image and thumbnail URLs to Flow, marking the main image as the cover image.

VAT configuration

VAT code resolution follows this priority order:

  1. Tax rate from price — If TaxRate exists for the current market group, use the matching VatCodeUids entry

  2. Product type VATVAT_{marketId} property on the product type

  3. Product-level propertyvatCodeUid_{marketGroupId} or vatCodeUid (recommended)

  4. DefaultDefaultVatCodeUid from the connector configuration

VAT code mapping

Map tax rates to Flow VAT UIDs using the VatCodeUids key group in Omnium:

Configuration reference

Setting
Description
Default

SyncCategoriesToFlow

Enable category synchronization

false

ProductGroupRootId

Root category ID for product group sync

Not set

DefaultProductGroupUid

Fallback product group UID

Not set

DefaultVatCodeUid

Default VAT code UID

Required

CreatePackageSlots

Enable package/bundle products

false

SendPackageProductOnPurchaseOrder

Include package product on POs

false

Last updated

Was this helpful?