POST /v2/vendors/create - Square API Reference

Create vendorBeta

POST

/v2/vendors/create

Creates a single Vendor object to represent a supplier to a seller.

Permissions:VENDOR_WRITE

Guide

Create vendors

Try in API Explorer

Link to section

Request body

Example code

Link to section

idempotency_key

string

Required

A client-supplied, universally unique identifier (UUID) to make this CreateVendor call idempotent.

See Idempotency in the API Development 101 section for more information.

Min Length

Max Length

128

Link to section

vendor

The requested Vendor to be created.

Link to section

Response fields

Link to section

errors

Errors encountered when the request fails.

Link to section

vendor

The successfully created Vendor object.

curl https://connect.squareup.com/v2/vendors/create \ -X POST \ -H 'Square-Version: 2024-04-17' \ -H 'Authorization: Bearer ACCESS_TOKEN' \ -H 'Content-Type: application/json' \ -d '{ "idempotency_key": "8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe", "vendor": { "name": "Joe'\''s Fresh Seafood", "address": { "address_line_1": "505 Electric Ave", "address_line_2": "Suite 600", "locality": "New York", "administrative_district_level_1": "NY", "postal_code": "10003", "country": "US" }, "contacts": [ { "name": "Joe Burrow", "email_address": "[email protected]", "phone_number": "1-212-555-4250" } ], "account_number": "4025391", "note": "a vendor" } }'

{ "vendor": { "id": "INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4", "created_at": "2022-03-16T10:21:54.859Z", "updated_at": "2022-03-16T10:21:54.859Z", "name": "Joe's Fresh Seafood", "address": { "address_line_1": "505 Electric Ave", "address_line_2": "Suite 600", "locality": "New York", "administrative_district_level_1": "NY", "postal_code": "10003", "country": "US" }, "contacts": [ { "id": "INV_VC_FMCYHBWT1TPL8MFH52PBMEN92A", "name": "Joe Burrow", "email_address": "[email protected]", "phone_number": "1-212-555-4250" } ], "account_number": "4025391", "note": "a vendor", "version": 1, "status": "ACTIVE" }, "errors": [] }