Products

Product Properties

AttributesDescription
id
INTEGER
READ-ONLY
A unique Omneo identifier for the product
title
STRING
The display name of the product
handle
STRING
A unique handle for the product
external_id
STRING
The external id of the product.
Usually the unique identifier in the system the product originated.
type
STRING
ENUM
The type of the product,
Valid types:
-appointment
-simple
-configurable
-downloadable
-gift
-bundle
-voucher
-service
-subscription
status
STRING
ENUM
The status of the product,
Valid status'
-new
-active
-rundown
-discontinued
-ranged
-deleted
brand
STRING
The brand of the product.
description
STRING
An HTML description of the product
currency
STRING
The basic string representing the currency associated with the product.
position
INTEGER
images
ARRAY
A list of product images attached to the product
systems
ARRAY
A list of systems associated with the product.
example ["pos",kiosk"]
channels
ARRAY
A list of channels associated with the product.
example ["Omneo","eCommerce","marketplace"]
tags
ARRAY
A list of tags associated with the product
example ["xmas","knitwear"]
options
custom_fieldsCustom fields for this product. These fields are used for customised data that does not fit in any of the core fields.
variants
ARRAY
A list of variants of the product.