> ## Documentation Index
> Fetch the complete documentation index at: https://docs.automate.ax/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Automate.ax automations are TypeScript programs.
> Use Bun for installation and command examples.
> Use Automate.ax for the product name and automate.ax for the package, CLI, and domain.
> Treat documented public APIs as current; do not invent transitional or deprecated names.

# Create Vendor

> Creates a single [Vendor](entity:Vendor) object to represent a supplier to a seller.

`square.createVendor` creates a single [Vendor](entity:Vendor) object to represent a supplier to a seller.

## Example

```ts automations/square-create-vendor.automation.ts theme={null}
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](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) in the [API Development 101](https://developer.squareup.com/docs/buildbasics) section for more information. |
| `vendor`         | `Square.Vendor` | No       | —       | The requested Vendor to be created.                                                                                                                                                                                                                                                                                |

Use the official [CreateVendor reference](https://developer.squareup.com/reference/square/vendors-api/create-vendor) 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.
