Skip to main content

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.

{
  "id": 42311,
  "product_id": 1331,
  "sku": "0133949911",
  "external_id": "13141ADA",
  "barcode": "9000132491131",
  "web_url": "https://demo_site.com/42311",
  "handle": "demo_handle",
  "title": "A demo item",
  "description": "This is an item for demonstration",
  "position": 0,
  "price": 1000,
  "price_discounted": 599.99,
  "price_comparison": 1200,
  "price_cost": 100,
  "available_quantity": 231,
  "images": [],
  "tags": [],
  "options": [
      {
          "name": "Size",
          "value": "61",
          "sort_order": null
      },
      {
          "name": "Colour",
          "value": "900",
          "sort_order": null
      }
  ],
  "created_at": "2020-04-16 11:04:43",
  "updated_at": "2020-04-16 11:04:43"
}

​
What are product variants?

Products with variants are products that have similarities, they are usually based on the same model, and differ in some way. Variants allow customers to purchase a product in different aspects such as colour or size. Product variants need to be attached to a master product_id

​
Product variant properties

AttributeDescription
id INTEGERA unique Omneo ID for the variant
product_id INTEGERThe product_id of the attached Product
sku STRINGA string representing the SKU
external_id STRINGA unique external id of the originating system
barcode STRING BARCODEThe unique barcode of the item
web_url STRING URLThe URL of a web location to view the product. (eCommerce site, product catalogue)
handle STRINGA unique handle for the product
title STRINGThe title of the product
description STRINGThe description of the product
position INTEGERThe position of the product with 0 being first. This will influence the default ordering of products
price FLOATThe full price of the item.
price_discounted FLOATThe discounted price of the item.
price_comparison FLOATThe ‘compare at’ price of the item
price_cost FLOATThe cost price of the item
available_quantity INTEGERThe quantity available for sale
images ARRAYProduct images attached to the item
tags ARRAYTags attached to the item
options ARRAYOptions attached to the item
created_at READ-ONLY DATE-TIMEThe UTC date & time the Product Variant record was created in ISO 8601 format.
updated_at READ-ONLY DATE-TIMEThe UTC date & time the Product Variant record was last updated in ISO 8601 format.