Square

Square Vendors API

The Vendors API from Square — 6 operation(s) for vendors.

Documentation GitHub OpenAPI

Business capability

Operations 7

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /v2/vendors/bulk-create Add several suppliers at once · Square Bulk Create Vendors #

Ask an LLM

“How do I add a list of my suppliers as vendors in one call?”

“Can I create multiple vendor records in bulk?”

Tell an agent

Create these vendors: {vendors}.

Bulk add suppliers {vendors}.

POST /v2/vendors/bulk-retrieve Fetch several vendors by ID · Square Bulk Retrieve Vendors #

Ask an LLM

“Can I look up multiple suppliers at once by their vendor IDs?”

“Is there a batch fetch for vendor records?”

Tell an agent

Get vendors {vendor_ids}.

Retrieve these supplier records in one call: {vendor_ids}.

PUT /v2/vendors/bulk-update Update several suppliers at once · Square Bulk Update Vendors #

Ask an LLM

“How do I update contact details for many vendors in one request?”

“Can I bulk edit existing supplier records?”

Tell an agent

Bulk update vendors {vendors}.

Apply these changes to multiple suppliers: {vendors}.

POST /v2/vendors/create Add a supplier · Square Create Vendor #

Ask an LLM

“How do I add a single new supplier to my Square account?”

“What does it take to create one vendor record?”

Tell an agent

Create vendor {vendor}.

Add a single supplier: {vendor}.

POST /v2/vendors/search Search suppliers · Square Search Vendors #

Ask an LLM

“How do I find a supplier by name or status?”

“Can I sort vendor search results?”

Tell an agent

Search vendors with filter {filter}.

Find suppliers matching {filter} sorted by {sort}.

GET /v2/vendors/{vendor_id} Get a supplier · Square Retrieve Vendor #

Ask an LLM

“What contact details do I have on file for a vendor?”

“How can I look up one supplier by its vendor ID?”

Tell an agent

Get vendor {vendor_id}.

Show supplier record {vendor_id}.

PUT /v2/vendors/{vendor_id} Update one supplier · Square Update Vendor #

Ask an LLM

“How do I edit the details of a single supplier?”

“Can I change one vendor's contacts without a bulk update?”

Tell an agent

Update vendor {vendor_id} with these supplier details: {vendor}.

Save changes to one supplier record: {vendor}.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/square:square-vendors-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  version: '2.0'
  title: Square Vendors API
  description: Supercharge Square for sellers of every size. Our entire connected commerce platform from elegant hardware to a rich suite of Square APIs is yours to build with. Whether youre developing an app or composing a bespoke solution, this is the place to make it happen.
  termsOfService: https://connect.squareup.com/tos
  contact:
    name: Square Developer Platform
    email: developers@squareup.com
    url: https://squareup.com/developers
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  externalDocs:
    description: 'Read the official documentation here:'
    url: https://docs.connect.squareup.com/
  x-server-configuration:
    default-environment: production
    default-server: default
    environments:
    - name: production
      servers:
      - name: default
        url: https://connect.squareup.com
    - name: sandbox
      servers:
      - name: default
        url: https://connect.squareupsandbox.com
    - name: custom
      servers:
      - name: default
        url: '{custom_url}'
    parameters:
    - name: custom_url
      description: Sets the base URL requests are made to. Defaults to `https://connect.squareup.com`
      type: string
      example: https://connect.squareup.com
  x-square-generic-error-codes:
  - ACCESS_TOKEN_EXPIRED
  - ACCESS_TOKEN_REVOKED
  - API_VERSION_INCOMPATIBLE
  - APPLICATION_DISABLED
  - ARRAY_EMPTY
  - ARRAY_LENGTH_TOO_LONG
  - ARRAY_LENGTH_TOO_SHORT
  - BAD_CERTIFICATE
  - BAD_GATEWAY
  - BAD_REQUEST
  - CONFLICT
  - CONFLICTING_PARAMETERS
  - CURRENCY_MISMATCH
  - EXPECTED_ARRAY
  - EXPECTED_BASE64_ENCODED_BYTE_ARRAY
  - EXPECTED_BOOLEAN
  - EXPECTED_FLOAT
  - EXPECTED_INTEGER
  - EXPECTED_JSON_BODY
  - EXPECTED_MAP
  - EXPECTED_OBJECT
  - EXPECTED_STRING
  - FORBIDDEN
  - GATEWAY_TIMEOUT
  - GONE
  - IDEMPOTENCY_KEY_REUSED
  - INCORRECT_TYPE
  - INSUFFICIENT_SCOPES
  - INTERNAL_SERVER_ERROR
  - INVALID_ARRAY_VALUE
  - INVALID_CONTENT_TYPE
  - INVALID_CURSOR
  - INVALID_ENUM_VALUE
  - INVALID_FORM_VALUE
  - INVALID_SORT_ORDER
  - INVALID_SQUARE_VERSION_FORMAT
  - INVALID_TIME
  - INVALID_TIME_RANGE
  - INVALID_VALUE
  - LOCATION_MISMATCH
  - MAP_KEY_LENGTH_TOO_LONG
  - MAP_KEY_LENGTH_TOO_SHORT
  - MERCHANT_SUBSCRIPTION_NOT_FOUND
  - METHOD_NOT_ALLOWED
  - MISSING_REQUIRED_PARAMETER
  - NOT_ACCEPTABLE
  - NOT_FOUND
  - NOT_IMPLEMENTED
  - NO_FIELDS_SET
  - RATE_LIMITED
  - REQUEST_ENTITY_TOO_LARGE
  - REQUEST_TIMEOUT
  - SANDBOX_NOT_SUPPORTED
  - SERVICE_UNAVAILABLE
  - TOO_MANY_MAP_ENTRIES
  - UNAUTHORIZED
  - UNEXPECTED_VALUE
  - UNKNOWN_BODY_PARAMETER
  - UNKNOWN_QUERY_PARAMETER
  - UNPROCESSABLE_ENTITY
  - UNSUPPORTED_MEDIA_TYPE
  - V1_ACCESS_TOKEN
  - V1_APPLICATION
  - VALUE_EMPTY
  - VALUE_REGEX_MISMATCH
  - VALUE_TOO_HIGH
  - VALUE_TOO_LONG
  - VALUE_TOO_LOW
  - VALUE_TOO_SHORT
servers:
- url: https://connect.squareup.com
  variables: {}
tags:


# --- truncated at 32 KB (96 KB total) ---
# Full source: https://artifacts.apis.io/square/openapi/square-vendors-api-openapi.yml

Square Vendors API

Operations 7

Documentation

Specifications

Schemas & Data

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification