Search Vendors - Automate.ax

square.searchVendors searches for vendors using a filter against supported Vendor properties and a supported sorter.

Example

automations/square-search-vendors.automation.ts

import { automation, onDashboardRun } from "automate.ax"
import { square } from "automate.ax/square"

export default automation("Search Square Vendors", () => {
  onDashboardRun({ title: "Search Square Vendors" })

  square.searchVendors({})
})

Inputs

Every input accepts a compatible signal. It requires VENDOR_READ.

Field	Type	Required	Default	Description
`filter`	`Square.SearchVendorsRequestFilter`	No	—	Specifies a filter used to search for vendors.
`sort`	`Square.SearchVendorsRequestSort`	No	—	Specifies a sorter used to sort the returned vendors.
`cursor`	`string`	No	—	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.

Use the official SearchVendors reference for provider field semantics and limits.

Output

Returns the official Square.SearchVendorsResponse response as a codec-safe object. Square integer money amounts remain bigint values.