search-vendors-request.md

Search Vendors Request

Represents an input into a call to SearchVendors.

Structure

Search Vendors Request

Fields

Name	Type	Tags	Description
filter	Search Vendors Request Filter Hash	Optional	Defines supported query expressions to search for vendors by.
sort	Search Vendors Request Sort Hash	Optional	Defines a sorter used to sort results from SearchVendors.
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.

Example (as JSON)

{
  "query": {
    "filter": {
      "name": [
        "Joe's Fresh Seafood",
        "Hannah's Bakery"
      ],
      "status": [
        "ACTIVE"
      ]
    },
    "sort": {
      "field": "CREATED_AT",
      "order": "ASC"
    }
  }
}