search-vendors-request.md

Search Vendors Request

Represents an input into a call to SearchVendors.

Structure

SearchVendorsRequest

Fields

Name	Type	Tags	Description	Getter	Setter
filter	?SearchVendorsRequestFilter	Optional	Defines supported query expressions to search for vendors by.	getFilter(): ?SearchVendorsRequestFilter	setFilter(?SearchVendorsRequestFilter filter): void
sort	?SearchVendorsRequestSort	Optional	Defines a sorter used to sort results from SearchVendors.	getSort(): ?SearchVendorsRequestSort	setSort(?SearchVendorsRequestSort sort): void
cursor	?string	Optional	A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the Pagination guide for more information.	getCursor(): ?string	setCursor(?string cursor): void

Example (as JSON)

{
  "query": {
    "filter": {
      "name": [
        "Joe's Fresh Seafood",
        "Hannah's Bakery"
      ],
      "status": [
        "ACTIVE"
      ]
    },
    "sort": {
      "field": "CREATED_AT",
      "order": "ASC"
    }
  },
  "filter": {
    "name": [
      "name4",
      "name5",
      "name6"
    ],
    "status": [
      "ACTIVE",
      "INACTIVE"
    ]
  },
  "sort": {
    "field": "NAME",
    "order": "DESC"
  },
  "cursor": "cursor0"
}