Product List Items

A Product List is a collection of List Items. Each item references either a product from the Omneo product catalogue or a custom user-defined product.

Adding an item from the Omneo product catalogue

The list must already exist. Adding an item to a list the profile does not have returns 404. See Lists are not created automatically. {list} in the path is the list’s numeric id or the list’s own handle. Provide at least one product identifier:

Identifier	Matches
`product_variant_id`	An Omneo product variant by id
`product_variant_sku`	An Omneo product variant by SKU
`product_variant_barcode`	An Omneo product variant by barcode
`product_id`	An Omneo product by id (no variant)
`external_id`	An Omneo product by its `external_id`. It does not match variants, so the item is saved against the product with no variant.

To save a specific size or colour, use one of the variant identifiers. A variant’s external_id cannot be used to add an item. Look the variant up first, or send its SKU or barcode.

curl -X POST https://api.[tenant].getomneo.com/api/v3/profiles/{profileId}/lists/{list}/items \
  -H "Authorization: Bearer ${TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "product_variant_id": 333729,
    "quantity": 1,
    "position": 1
  }'

To include quantity, the List Definition must have allow_quantity: true. Otherwise quantity is ignored.

Adding items when creating a list

Items can be included inline in the list creation payload:

{
  "name": "Birthday Wishlist",
  "list_definition_id": 3,
  "items": [
    {
      "product_variant_id": 333729,
      "quantity": 1,
      "position": 1
    }
  ]
}

Adding a custom product item

If the List Definition has allow_custom_product: true, you can add items not in the Omneo product catalogue:

curl -X POST https://api.[tenant].getomneo.com/api/v3/profiles/{profileId}/lists/{listId}/custom \
  -H "Authorization: Bearer ${TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Vintage Chanel Bag",
    "description": "Seen at the vintage market",
    "price": 450.00,
    "currency": "AUD",
    "url": "https://example.com/item",
    "image_url": "https://example.com/item.jpg",
    "quantity": 1
  }'

Removing a list item

DELETE /api/v3/profiles/{profileId}/lists/{listId}/items/{itemId}

Updating item position or quantity

Update is done on the list level. Include the item’s id in the items array of a PUT request to the list:

curl -X PUT https://api.[tenant].getomneo.com/api/v3/profiles/{profileId}/lists/{listId} \
  -H "Authorization: Bearer ${TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "items": [
      { "id": "item-uuid", "quantity": 2, "position": 1 }
    ]
  }'

Core setup

Profiles and data

Commerce

Incentives

Reactions

Webhooks and events

Frontend & SDK

Discovery search

POS integration

Appointments

Lists

Groups

Feedback

Extensions

Product List Items

Adding an item from the Omneo product catalogue

Adding items when creating a list

Adding a custom product item

Removing a list item

Updating item position or quantity

​Adding an item from the Omneo product catalogue

​Adding items when creating a list

​Adding a custom product item

​Removing a list item

​Updating item position or quantity

Adding an item from the Omneo product catalogue

Adding items when creating a list

Adding a custom product item

Removing a list item

Updating item position or quantity