We recommend reading the following pages before integrating with Ometria:

• Ometria API introduction
• Ometria data architecture

About the product endpoint

The easiest and fastest way to add bulk product data to Ometria is to use the Push endpoint; the product endpoint should only be used for specific cases.

The product endpoint provides methods to list different products, retrieve an individual product and create a new product.

Products vs. Product variants

Typically, a parent product in Ometria corresponds to a single product page in your eCommerce store.

See: Products, product listings and product variants

A product can have multiple variant SKUs, but these variants will not have their own individual URLs.

We recommend passing all products and then setting the product.is_variant parameter to true for all product variants (those without a unique URL).

If you are using the Ometria API, we also recommend that you always pass a product listing when passing a new product. This is particularly important if you want to create price drop campaigns.

Product IDs and SKUs

Often product ID and SKU will be the same value, but for some systems (e.g. where there is a separate product row identifier) these may be different.

'is_active'

This field defines whether or not a product in the catalogue is active (i.e. available to sell) or not.

• If the object level "is_active":false then it will always be false, and Ometria considers the product inactive.
• If the object level is "is_active":true then Ometria checks the listing level for that store to confirm if the product is active at listing level.

You can choose to exclude inactive products from product recommendations at account and campaign level:

• Edit Campaign Settings: Filter out of stock/inactive products
• General settings

Special Price

Special price is used for products on sale at a discounted price.

Ometria uses the special price 'from' and 'to' dates on the product and the special price in the listing.

To set a product without listings on sale, set the following parameters:

To set all listing on a product on sale, set the following parameters:

To set specific listings on a product on sale, set the values as above, but do not set a special_price for the listing which is not on sale.

Product recommendations

To ensure your products are used in the Ometria Product recommendations engines, there is a set of criteria that must be met.

🚧

Note

All fields listed below must be the parent level product.