Create Vendor - Automate.ax

square.createVendor creates a single Vendor object to represent a supplier to a seller.

Example

automations/square-create-vendor.automation.ts

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

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

  square.createVendor({
    idempotencyKey: "8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe",
    vendor: {
      name: "Joe's Fresh Seafood",
      address: {
        addressLine1: "505 Electric Ave",
        addressLine2: "Suite 600",
        locality: "New York",
        administrativeDistrictLevel1: "NY",
        postalCode: "10003",
        country: "US",
      },
      contacts: [
        {
          name: "Joe Burrow",
          emailAddress: "joe@joesfreshseafood.com",
          phoneNumber: "1-212-555-4250",
          ordinal: 1,
        },
      ],
      accountNumber: "4025391",
      note: "a vendor",
    },
  })
})

Inputs

Every input accepts a compatible signal. It requires VENDOR_WRITE.

Field	Type	Required	Default	Description
`idempotencyKey`	`string`	Yes	—	A client-supplied, universally unique identifier (UUID) to make this CreateVendor call idempotent. See Idempotency in the API Development 101 section for more information.
`vendor`	`Square.Vendor`	No	—	The requested Vendor to be created.

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

Output

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