Search Favorite Lists

POST 
/v2/favoritelists/search

Search Favorite Lists

Request

application/json

Body

required

Search orderlists. Use either an id or a source

name string

Possible values: <= 64 characters

Favorite List name

isDefault boolean

Default Favorite List

companyId int

Favorite List company ID

companySource

object

id stringrequired

Source ID

name stringrequired

Name of the source

contactId int

Favorite List contact ID

contactSource

object

id stringrequired

Source ID

name stringrequired

Name of the source

customerId int

Favorite List customer ID

customerSource

object

id stringrequired

Source ID

name stringrequired

Name of the source

productIds integer[]

Favorite List product IDs list

productSources string[]

List of product sources

clusterIds integer[]

Favorite List cluster IDs list

clusterSources string[]

List of cluster sources

Responses

200

Paginated list of FavoriteLists

application/json

Schema

Schema

items

object[]

required

List of items of type FavoriteListDto

Array [

name stringrequired

Possible values: <= 64 characters

Favorite List name

companyId int

Favorite List company ID

contactId int

Favorite List contact ID

customerId int

Favorite List customer ID

productIds number[]

Favorite List product IDs list

clusterIds number[]

Favorite List cluster IDs list

isDefault booleanrequired

Default Favorite List

slug stringrequired

Favorite List slug

createdAt date-time

Favorite List date created

updatedAt date-time

Favorite List date modified

id stringrequired

Favorite List identifier

]

itemsFound integerrequired

Total number of items found

offset integernullablerequired

Possible values: >= 1

Default value: 12

The amount of items to show per page

page integernullablerequired

Possible values: >= 1

Default value: 1

The current page

pages integernullablerequired

Possible values: >= 1

Total amount of pages

start integernullablerequired

Possible values: >= 1

Start position of the current page

end integernullablerequired

Possible values: >= 1

End position of the current page

Example (from schema)

{
  "items": [
    {
      "name": "MyFavoriteList",
      "companyId": 1111,
      "contactId": 1111,
      "customerId": 1111,
      "productIds": [
        1111,
        2222,
        3333
      ],
      "clusterIds": [
        1111,
        2222,
        3333
      ],
      "isDefault": true,
      "slug": "my-favorite-list-slug",
      "createdAt": "2022-01-01T00:00:00.000Z",
      "updatedAt": "2022-01-01T00:00:00.000Z",
      "id": "64e896addf2137b255101f49"
    }
  ],
  "itemsFound": 12,
  "offset": 12,
  "page": 4,
  "pages": 1,
  "start": 1,
  "end": 12
}

400

Bad request

403

Forbidden.

500

Unknown search FavoriteList error

Loading...