We recommend reading the following pages before integrating with Ometria:

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.

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:

Object

Field

Value

Product

special_price_dt_from

Date the special price is valid from.

special_price_dt_to

Date the special price is valid to.

special_price

The special price.

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

Object

Field

Value

List Products

special_price_dt_from

Date the special price is valid from.

special_price_dt_to

Date the special price is valid to.

special_price

The special price for that listing.

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.

Field

Value

is_active

TRUE

Price

0 or

There must be a product listing in the same currency as the base currency for the account.

Title

Must be defined.

URL

Must be defined.

is_in_stock

TRUE or not defined.

Note: If the value is FALSE, Ometria will assume the product is out of stock.

is_variant

FALSE


Did this page help you?