Create instance

POST 
/api/square/instances

Create a new Square integration instance. For v1, provide a personal access token from the Square Developer Console; OAuth is pending business verification.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Body fields:

• name (required) — instance display name
• environment (optional) — sandbox | production, default sandbox
• access_token (optional) — personal access token; if omitted, falls back to the tenant's default sandbox token from Secrets Manager
• auth_method (optional) — manual | oauth
• merchant_id (optional)
• order_import_start_date (optional, YYYY-MM-DD)
• default_return_warehouse_id (optional, integer)

The name must be unique across all of your integrations. Reusing a name that another integration already uses returns 422 with a NameMustBeUnique error on the name field, rather than creating a duplicate.

Request

Responses

201

Created

Response Headers

Content-Type

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.

422

Unprocessable Content

Response Headers

Content-Type

429

Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.