Bulk Create Vendors - Automate.ax

square.bulkCreateVendors creates one or more Vendor objects to represent suppliers to a seller.

Example

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

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

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

  square.bulkCreateVendors({
    vendors: {
      "8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe": {
        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
`vendors`	`Record\<string, Square.Vendor\>`	Yes	—	Specifies a set of new Vendor objects as represented by a collection of idempotency-key/`Vendor`-object pairs.

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

Output

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