Square Vendors API is one of 45 APIs that Square publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include Vendors. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.
This API exposes
7 operations
across 6 paths,
and defines 25 schemas.
It is described by OpenAPI 3.2.0, at version 2.0.
Requests are made against a single base URL, https://connect.squareup.com.
7 operations6 paths25 schemas1 GET4 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Square Vendors API declares
2 security schemes
for authenticating requests.
It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 57 scopes.
An API key is passed in the header as Authorization (oauth2ClientSecret).
Paths & Operations 7
Across 6 paths, the API surfaces 7 operations — 1 GET, 4 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
Vendors 7
POST
/v2/vendors/bulk-create
Square Bulk Create Vendors
BulkCreateVendorsbody→ 200
POST
/v2/vendors/bulk-retrieve
Square Bulk Retrieve Vendors
BulkRetrieveVendorsbody→ 200
PUT
/v2/vendors/bulk-update
Square Bulk Update Vendors
BulkUpdateVendorsbody→ 200
POST
/v2/vendors/create
Square Create Vendor
CreateVendorbody→ 200
POST
/v2/vendors/search
Square Search Vendors
SearchVendorsbody→ 200
GET
/v2/vendors/{vendor_id}
Square Retrieve Vendor
RetrieveVendor1 param→ 200
PUT
/v2/vendors/{vendor_id}
Square Update Vendor
UpdateVendorbody→ 200
Schemas 25
The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are Address (14 properties), Vendor (10 properties), VendorContact (6 properties), Error (4 properties). Each schema is shown below with its type and property counts.
VendorContact
object
Represents a contact of a [Vendor](entity:Vendor).
6 properties1 required
UpdateVendorRequest
object
Represents an input to a call to [UpdateVendor](api-endpoint:Vendors-UpdateVendor).
2 properties1 required
BulkCreateVendorsRequest
object
Represents an input to a call to [BulkCreateVendors](api-endpoint:Vendors-BulkCreateVendors).
1 property1 required
Vendor
object
Represents a supplier to a seller.
10 properties
UpdateVendorResponse
object
Represents an output from a call to [UpdateVendor](api-endpoint:Vendors-UpdateVendor).
2 properties
Country
string
Indicates the country associated with another entity, such as a business. Values are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/count…
SearchVendorsRequestSort
object
Defines a sorter used to sort results from [SearchVendors](api-endpoint:Vendors-SearchVendors).
2 properties
CreateVendorRequest
object
Represents an input to a call to [CreateVendor](api-endpoint:Vendors-CreateVendor).
2 properties1 required
BulkRetrieveVendorsResponse
object
Represents an output from a call to [BulkRetrieveVendors](api-endpoint:Vendors-BulkRetrieveVendors).
2 properties
SearchVendorsResponse
object
Represents an output from a call to [SearchVendors](api-endpoint:Vendors-SearchVendors).
3 properties
RetrieveVendorResponse
object
Represents an output from a call to [RetrieveVendor](api-endpoint:Vendors-RetrieveVendor).
2 properties
SearchVendorsRequest
object
Represents an input into a call to [SearchVendors](api-endpoint:Vendors-SearchVendors).
3 properties
SortOrder
string
The order (e.g., chronological or alphabetical) in which results from a request are returned.
Address
object
Represents a postal address in a country. For more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addr…
14 properties
BulkUpdateVendorsResponse
object
Represents an output from a call to [BulkUpdateVendors](api-endpoint:Vendors-BulkUpdateVendors).
2 properties
CreateVendorResponse
object
Represents an output from a call to [CreateVendor](api-endpoint:Vendors-CreateVendor).
2 properties
BulkRetrieveVendorsRequest
object
Represents an input to a call to [BulkRetrieveVendors](api-endpoint:Vendors-BulkRetrieveVendors).
1 property
Error
object
Represents an error encountered during a request to the Connect API. See [Handling errors](https://developer.squareup.com/docs/build-basics/handling-errors) fo…
4 properties2 required
ErrorCode
string
Indicates the specific error that occurred during a request to a Square API.
SearchVendorsRequestFilter
object
Defines supported query expressions to search for vendors by.
2 properties
VendorStatus
string
The status of the [Vendor](entity:Vendor), whether a [Vendor](entity:Vendor) is active or inactive.
BulkCreateVendorsResponse
object
Represents an output from a call to [BulkCreateVendors](api-endpoint:Vendors-BulkCreateVendors).
2 properties
BulkUpdateVendorsRequest
object
Represents an input to a call to [BulkUpdateVendors](api-endpoint:Vendors-BulkUpdateVendors).
1 property1 required
ErrorCategory
string
Indicates which high-level category of error has occurred during a request to the Connect API.
SearchVendorsRequestSortField
string
The field to sort the returned [Vendor](entity:Vendor) objects by.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Square Vendors API, published by
API Evangelist. We do not operate, host, resell, or
support these APIs, and we are not affiliated with or endorsed by the company unless stated above.
Everything here is built from publicly available information — the company's own site,
developer portal, documentation, public repositories, and the specifications it publishes for public use.
Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's
public API artifacts, scored against a published rubric. They are not certifications,
endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and
you do not need to justify the request. A removed company is recorded as unrated, never scored
zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy → On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.
