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.

​
What are Profile Lists?

A list is a configurable, flexible way for Omneo users to organise their products. A list can give the customer the ability to create ‘look books’, wishlists, rank and reorder items within a list, move products between lists and cart, or even create personalised lists for events. 
[
   {
      "id":22,
      "profile_id":"9131241-150b-41dc-1311-9fabbc154eeb3",
      "name":"wishlist",
      "handle":"wishlist",
      "sort_order":1,
      "items":[
         {
            "id":40,
            "product_list_id":25,
            "product_category":null,
            "product_variant":{
               "id":1234,
               "product_id":600,
               "sku":"6411920012853",
               "external_id":"113124jjg",
               "barcode":null,
               "web_url":null,
               "handle":null,
               "title":"6cm Item",
               "description":"Test item 6CM",
               "position":0,
               "price":0,
               "price_discounted":null,
               "price_comparison":null,
               "price_cost":null,
               "available_quantity":null,
               "images":[
                  {
                     "url":"/testitem.png",
                     "sort_order":0
                  }
               ],
               "tags":[
                  
               ],
               "options":[
                  {
                     "name":"Size",
                     "value":"6CM",
                     "sort_order":null
                  },
                  {
                     "name":"Colour",
                     "value":"TEST",
                     "sort_order":null
                  }
               ],
               "created_at":"2020-03-30 13:54:34",
               "updated_at":"2020-10-23 08:50:16"
            },
            "meta": {
             	"exampleMetaString": "example string",
             	"exampleMetaObject": {
               	 "name": "value"
             	}
            },
            "product":{
               "id":1133,
               "title":"Test Item",
               "handle":"test_item",
               "external_id":"1234411",
               "status":"new",
               "brand":"Test Brand",
               "description":"This is a staging item, used for testing",
               "currency":null,
               "position":1,
               "images":[
                  
               ],
               "systems":[
                  
               ],
               "channels":[
                  "salesforce",
                  "omneo"
               ],
               "tags":[
                  "new",
                  "100"
               ],
               "options":{
                  "Size":[
                     "0X25,9X:0"
                  ],
                  "Colour":[
                     "RED"
                  ]
               },
               "custom_fields":[
                  {
                     "name":"Receipt text",
                     "handle":"receipt_text",
                     "namespace":"receipt_text",
                     "value":{
                        "overrides":{
                           "110004413":null
                        }
                     },
                     "type":"json",
                     "created_at":"2020-10-22 10:15:57",
                     "updated_at":"2020-10-22 10:15:57",
                     "version":1
                  }
               ],
               "created_at":"2020-03-30 16:45:18",
               "updated_at":"2020-10-22 10:15:57"
            },
            "created_at":"2021-02-02 00:13:39",
            "updated_at":"2021-02-02 00:13:39"
         },
      ],
      "tags":[
         "tag1",
         "tag2",
         "tag3"
      ],
      "custom_fields":[
         {
            "name":"Special Promo",
            "handle":"special_promo",
            "namespace":"wishlist",
            "value":true,
            "type":"boolean",
            "created_at":"2021-01-29 02:03:39",
            "updated_at":"2021-01-29 02:03:39",
            "version":null
         }
      ],
      "created_at":"2021-01-28 05:01:34",
      "updated_at":"2021-01-29 02:03:39"
   }
]

​
Profile List Properties

AttributeDescription
id READ-ONLY STRINGThe unique ID of the list
profile_id READ-ONLY STRINGThe profile_id of the attached profile
name STRINGThe visible name of the list
handle STRINGThe unique handle of the list
sort_order INTEGERSpecify the sort order of the list 1 = Ascending -1 = Descending
items ARRAYSpecify the items on the list e.g [{“product_variant_id”: 1234, “product_id”: 1133}][{“product_variant_id”: 1234, “product_id”: 1133}] Items must be valid items configured in Omneo
tags ARRAYAn array of tags against the list
custom_fields ARRAYAn array of custom fields configured against the list
created_at READ-ONLY DATE-TIMEThe UTC date & time the List record was created in ISO 8601 format.
updated_at READ-ONLY DATE-TIMEThe UTC date & time the List record was last updated in ISO 8601 format.