• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

You are viewing an old version of the API
V1 submit batch
V1
Square V1 APIs

We recommend using the Square API (V2) for all new development when possible. See When to use Connect V1 to learn more about working with V1 endpoints.

Deprecated
Effective November 20th, 2019

Bundle multiple requests to Connect V1 API endpoints as a single request.

The V1SubmitBatch endpoint does not require an access token in the request header. Instead, provide an access_token parameter for each request included in the batch.

V1SubmitBatch responds with an array that contains response objects for each of the batched requests. There is no guarantee of the order in which batched requests are performed.

IMPORTANT

You cannot include more than 30 requests in a single batch and recursive requests to V1SubmitBatch are not allowed. In other words, none of the requests included in a batch can itself be a request to the V1SubmitBatch endpoint.


Deprecation date
2019-11-20
Retirement date
2020-11-18
Migration guide
Name Description
method
string

Required

HTTP method for the API call.

relative_path
string

Required

Endpoint path for the API call.

access_token
string

Required

Square access token for the API call.

body
Map<string, string>

Request body for the API call. Only used for API calls using POST.

request_id
string

Client-provided value to identify the request.

Response Fields

Name Description
items
BatchResponse [ ]

Examples

You are viewing an old version of the API
POST /v1/batch
cURL
https://connect.squareup.com/v1/batch

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?