Bulk Retrieve Vendors - Automate.ax

square.bulkRetrieveVendors retrieves one or more vendors of specified Vendor IDs.

Example

automations/square-bulk-retrieve-vendors.automation.ts

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

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

  square.bulkRetrieveVendors({
    vendorIds: ["INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4"],
  })
})

Inputs

Every input accepts a compatible signal. It requires VENDOR_READ.

Field	Type	Required	Default	Description
`vendorIds`	`string[] \| null`	No	—	IDs of the Vendor objects to retrieve.

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

Output

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