Documentation Index
Fetch the complete documentation index at: https://docs.omneo.io/llms.txt
Use this file to discover all available pages before exploring further.
Product Properties
| Attribute | Description |
|---|---|
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 where the product originated. |
type STRING ENUM | The type of the product. Valid values: appointment, simple, configurable, downloadable, gift, bundle, voucher, service, subscription. |
status STRING ENUM | The status of the product. Valid values: new, active, rundown, discontinued, ranged, deleted. |
brand STRING | The brand of the product |
description STRING | An HTML description of the product |
currency STRING | The currency associated with the product |
position INTEGER | The sort position of the product |
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 OBJECT | Product options grouped by option name |
custom_fields ARRAY | Custom fields for this product. Use these for data that does not fit the core fields. |
variants ARRAY | A list of attached product variants |