search-vendors-response.md

Search Vendors Response

Represents an output from a call to SearchVendors.

Structure

SearchVendorsResponse

Fields

Name	Type	Tags	Description	Getter	Setter
errors	?(Error[])	Optional	Errors encountered when the request fails.	getErrors(): ?array	setErrors(?array errors): void
vendors	?(Vendor[])	Optional	The Vendor objects matching the specified search filter.	getVendors(): ?array	setVendors(?array vendors): void
cursor	?string	Optional	The pagination cursor to be used in a subsequent request. If unset, this is the final response. See the Pagination guide for more information.	getCursor(): ?string	setCursor(?string cursor): void

Example (as JSON)

{
  "errors": [
    {
      "category": "MERCHANT_SUBSCRIPTION_ERROR",
      "code": "INVALID_EXPIRATION",
      "detail": "detail6",
      "field": "field4"
    }
  ],
  "vendors": [
    {
      "id": "id8",
      "created_at": "created_at6",
      "updated_at": "updated_at4",
      "name": "name8",
      "address": {
        "address_line_1": "address_line_16",
        "address_line_2": "address_line_26",
        "address_line_3": "address_line_32",
        "locality": "locality6",
        "sublocality": "sublocality6"
      }
    },
    {
      "id": "id8",
      "created_at": "created_at6",
      "updated_at": "updated_at4",
      "name": "name8",
      "address": {
        "address_line_1": "address_line_16",
        "address_line_2": "address_line_26",
        "address_line_3": "address_line_32",
        "locality": "locality6",
        "sublocality": "sublocality6"
      }
    }
  ],
  "cursor": "cursor8"
}