Fields in list

Fields available in a list.


Things to consider

Fields that are visible but not documented are for internal usage

Fields in list

  "lid": "swym generated list ID",
  "lname": "List name. List names need not be unique, i.e. If uniqueness is needed API caller should ensure dupes are not",
  "lty": "_recommends", //To prevent mixing with enduser created wishlists
  "lnote": "Optional. List note, single line of note at the list level",
  "lprops": {}, //Optional. Map or properties - {}. Not available downstream for reporting or segmentation queries
  "anonRead": "Optional. Default - false. Boolean flag if anonymous read is allowed for the given List ID",
  "cnt": 0,
  "_cp": false,
  "cby": "Created by email address",
  "uby": "Updated by email address",
  "cts": "Created at in milliseconds",
  "uts": "Updated at in milliseconds",
  "userinfo": {}
lidstringList id to be updated
lnamestringList name
listcontentsarrayPreview array of list items
stringList type - when null, it represents wishlist. When set to a value eg: _saveForLater, gets added to a different type of list separate from the wishlist
lnote (optional)stringOptional note
objectOptional. Map of custom fields
booleanOptional. True if the list can be read anonymously with lid
cntnumberNumber of items in list
booleanOptional. True if list duplication is in progress, copying the list items for large lists
ctsnumberCreated time at in milliseconds
uts (optional)numberLast updated time at in milliseconds
stringEmail address of the user if known when list was created
stringEmail address of the user if known when list was last updated
objectUser info of the list owner if user is known
userinfo.emstringEmail address of the owner
userinfo.fnamestringFirst name of the owner
userinfo.lnamestringLast name of the owner