Retrieve Vendor - Automate.ax

square.retrieveVendor retrieves the vendor of a specified Vendor ID.

Example

automations/square-retrieve-vendor.automation.ts

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

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

  square.retrieveVendor({
    vendorId: "vendor_id",
  })
})

Inputs

Every input accepts a compatible signal. It requires VENDOR_READ.

Field	Type	Required	Default	Description
`vendorId`	`string`	Yes	—	ID of the Vendor to retrieve.

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

Output

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