Square Connector

Square is a comprehensive commerce platform that provides payment processing, point-of-sale systems, online store capabilities, and business management tools. This component enables management of payments, customers, orders, inventory, invoices, team members, and webhooks in a Square account.

API Documentation

This component was built using the Square API Documentation

Connections

OAuth 2.0

Authenticate using OAuth 2.0.

To connect to Square using OAuth 2.0, create an application in the Square Developer Portal.

Prerequisites

A Square account
Access to the Square Developer Portal

Setup Steps

Navigate to the Square Developer Portal and sign in
Create a new application or select an existing application
In the application settings, navigate to the OAuth section
Add https://oauth2.integrations.acme.com/callback as a Redirect URL
Configure the required permissions (scopes) for the application based on the integration needs
Copy the Application ID and Application Secret from the Credentials section

Configure the Connection

Select the Authorize URL matching the target Square environment. Defaults to the Production URL https://connect.squareup.com/oauth2/authorize; select the Sandbox URL https://connect.squareupsandbox.com/oauth2/authorize for testing.
Select the Token URL matching the same environment as the Authorize URL. Defaults to the Production URL https://connect.squareup.com/oauth2/token; select the Sandbox URL https://connect.squareupsandbox.com/oauth2/token for testing.
For Scopes, enter a space-separated list of OAuth permissions required by the application. Refer to the Square OAuth Permissions documentation for available scopes.
Enter the Application ID as the Client ID.
Enter the Application Secret as the Client Secret.
(Optional) Set the API Version to override the default Square API version. Leave blank to use the default. See Square API Versioning for details.

Verify Connection

After configuring the connection, the authorizing user is redirected to Square to authorize access to the account. Once authorized, the integration can interact with the Square API on behalf of the merchant.

Production Credentials

Square separates its development environment from production to prevent test operations from affecting live merchant data. Sandbox and production credentials are distinct. Switching to production credentials is a required step before the integration can interact with real Square accounts.

Square sandbox and production environments use separate credentials. The sandbox environment is for testing only. To connect to real Square accounts, use production credentials.

Navigate to the application in the Square Developer Portal
Toggle from Sandbox to Production in the top navigation
Copy the Application ID and Application Secret from the Production > Credentials section

Update the connection configuration with the production Application ID (Client ID) and Application Secret (Client Secret).

App Marketplace

If distributing the app publicly through the Square App Marketplace, a formal app review is required, including having at least 5 active sellers using the integration. For private integrations within a single organization, App Marketplace listing is not required and no formal review applies.

This connection uses OAuth 2.0, a common authentication mechanism for integrations. Read about how OAuth 2.0 works here.

Input	Comments	Default
Authorize URL	The OAuth 2.0 Authorization URL for Square. Select Sandbox for testing or Production for live transactions.	https://connect.squareup.com/oauth2/authorize
Token URL	The OAuth 2.0 Token URL for Square. This must match the environment selected in the Authorize URL.	https://connect.squareup.com/oauth2/token
Scopes	A space-separated list of OAuth permission scopes. These scopes must be configured in the Square Application. See Square OAuth Permissions for available scopes.	MERCHANT_PROFILE_READ PAYMENTS_READ PAYMENTS_WRITE
Application ID	The Application ID from the Square Developer Dashboard. Navigate to Applications > [App Name] > Credentials to find this value.
Application Secret	The Application Secret from the Square Developer Dashboard. Keep this value secure and never share it publicly.
API Version	Override the default Square API version (2025-08-20). Leave blank to use the default version. See Square API Versioning for version details.

Triggers

New and Updated Payments

Fetches Square payments created or updated since the last execution, separated into new and updated buckets.

Input	Comments	Default
Connection	The Square connection to use.
Show New Records	When true, newly created payments are included in the trigger output.	true
Show Updated Records	When true, payments updated since the last poll are included in the trigger output.	true

Webhook

Receive and validate webhook requests from Square for manually configured webhook subscriptions.

Actions

Batch Change Inventory

Applies adjustments and counts to the provided item quantities.

Input	Comments	Default
Connection	The Square connection to use.
Idempotency Key	A unique string that identifies this request to ensure idempotent operations.
Inventory Changes	An array of inventory changes in JSON format. See Square Inventory Changes for change types.	[ { "type": "PHYSICAL_COUNT", "physical_count": { "catalog_object_id": "W62UWFY35CWMYGVWK6TWJDNI", "state": "IN_STOCK", "quantity": "10", "location_id": "LH2G9VFHJRWKR", "occurred_at": "2024-07-01T00:00:00Z", "created_at": "2024-07-01T00:00:00Z" } }, { "type": "ADJUSTMENT", "adjustment": { "catalog_object_id": "W62UWFY35CWMYGVWK6TWJDNI", "from_state": "IN_STOCK", "to_state": "SOLD", "quantity": "-1", "location_id": "LH2G9VFHJRWKR", "occurred_at": "2024-07-01T00:00:00Z", "created_at": "2024-07-01T00:00:00Z", "source": { "product": "SQUARE_POS", "application_id": "sandbox-sq0idb-example", "name": "Point of Sale", "type": "APPLICATION" } } } ]
Ignore Unchanged Counts	When true, unchanged inventory counts are ignored.	false

Batch Delete Catalog Objects

Deletes a set of CatalogItems based on the provided list of target IDs and returns a set of successfully deleted IDs in the response.

Input	Comments	Default
Connection	The Square connection to use.
Object IDs	Array of catalog object IDs to retrieve in JSON format.	`[ "W62UWFY35CWMYGVWK6TWJDNI", "X73VXGZ46DXNZHXWL7UXKENJ", "Y84WHHA57EYOAIYWM8VYLOFK" ]`

Batch Retrieve Catalog Objects

Returns a set of objects based on the provided ID.

Input	Comments	Default
Connection	The Square connection to use.
Object IDs	Array of catalog object IDs to retrieve in JSON format.	`[ "W62UWFY35CWMYGVWK6TWJDNI", "X73VXGZ46DXNZHXWL7UXKENJ", "Y84WHHA57EYOAIYWM8VYLOFK" ]`
Include Related Objects	When true, the response includes additional objects that are related to the requested objects.	false
Include Deleted Objects	When true, deleted objects are included in the results.	false
Catalog Version	The specific version of the catalog objects to include in the response. Used to retrieve historical versions of objects. The value is matched against the CatalogObject version attribute.

Batch Retrieve Inventory Counts

Returns current counts for the provided CatalogObjects at the requested Locations.

Input	Comments	Default
Connection	The Square connection to use.
Catalog Object IDs	An array of catalog object IDs in JSON format used to filter inventory results.	`[ "W62UWFY35CWMYGVWK6TWJDNI", "X73VXGZ46DXNZHXWL7UXKENJ" ]`
Location IDs	An array of location IDs in JSON format used to filter results to specific locations.	`[ "LH2G9VFHJRWKR", "LK3H8WGIKSMLA" ]`
Cursor	The pagination cursor returned by a previous call to this endpoint.
Limit	The maximum number of results to return in a single page.
Updated After	The timestamp filter used to return results whose calculated_at value is after the given time. Format: RFC 3339.
States	An array of inventory states in JSON format used to filter results. Options: IN_STOCK, SOLD, RETURNED_BY_CUSTOMER.	`[ "IN_STOCK", "SOLD" ]`

Batch Retrieve Orders

Retrieves a set of orders by their IDs.

Input	Comments	Default
Connection	The Square connection to use.
Location ID	The unique identifier for the location.
Order IDs	An array of order IDs to retrieve in JSON format. A maximum of 100 orders can be retrieved per request.	`[ "CAISEHUwyPjyk5QFnMR1k5axW5YgAQ", "CAISEHUwyPjyk5QFnMR1k5axW5YgAB" ]`

Batch Upsert Catalog Objects

Creates or updates up to 10,000 target objects based on the provided list of objects.

Input	Comments	Default
Connection	The Square connection to use.
Idempotency Key	A unique string that identifies this request to ensure idempotent operations.
Batches	Array of batches containing catalog objects in JSON format. Each batch may contain up to 1,000 objects. Maximum 10,000 objects total across all batches.	`[ { "objects": [ { "type": "ITEM", "id": "#coffee-mug", "item_data": { "name": "Coffee Mug", "description": "Ceramic coffee mug" } } ] } ]`

Cancel Invoice

Cancels an invoice.

Input	Comments	Default
Connection	The Square connection to use.
Invoice ID	The unique identifier for the invoice.

Cancel Payment

Cancels (voids) a payment.

Input	Comments	Default
Connection	The Square connection to use.
Payment ID	The unique identifier for the payment.

Clone Order

Creates a new order, in the DRAFT state, by duplicating an existing order.

Input	Comments	Default
Connection	The Square connection to use.
Order ID	The unique identifier for the order.
Idempotency Key	A unique string that identifies this request to ensure idempotent operations.

Complete Payment

Completes (captures) a payment.

Input	Comments	Default
Connection	The Square connection to use.
Payment ID	The unique identifier for the payment.
Version Token	The version token used for optimistic concurrency control. Identifies the current payment version.

Create Customer

Creates a new customer profile.

Input	Comments	Default
Connection	The Square connection to use.
Address	The customer's mailing address in JSON format. See Square Address Object for field details.	`{ "address_line_1": "1234 Main Street", "address_line_2": "Suite 100", "locality": "San Francisco", "administrative_district_level_1": "CA", "postal_code": "94102", "country": "US", "first_name": "John", "last_name": "Doe" }`
Birthday	The customer's date of birth. Format: YYYY-MM-DD.
Company Name	The name of the company associated with the customer.
Email Address	The email address of the customer.
Family Name	The last name of the customer.
Given Name	The first name of the customer.
Nickname	An informal name to associate with the customer.
Note	A free-form note to associate with the customer.
Phone Number	The phone number of the customer in E.164 format (e.g., +14155552671).
Reference ID	An optional external reference ID to associate with the customer.
Tax IDs	Tax identification numbers in JSON format. Only applicable for EU countries. See Square Tax IDs for supported formats.	`{ "eu_vat": "IE3426675K" }`
Idempotency Key	A unique string that identifies this request to ensure idempotent operations.

Create Job

Creates a job in a seller account with a title and tip eligibility.

Input	Comments	Default
Connection	The Square connection to use.
Job Title	The designation for the job role (for example, Cashier, Server, Manager).
Idempotency Key	A unique string that identifies this CreateJob request.
Is Tip Eligible	When true, employees in this job role are eligible to receive tips.	true

Create Order

Creates a new order.

Input Comments Default

Connection The Square connection to use.

Location ID The unique identifier for the location.

Order Object

The complete order object in JSON format. See Square Order Object for field details.

{
 "idempotency_key": "a7c8e4b1-3f5d-4e2a-9c1b-7d3e5f8a2c6b",
 "order": {
 "location_id": "LH2G9VFHJRWKR",
 "line_items": [
 {
 "name": "Coffee Mug",
 "quantity": "1",
 "base_price_money": {
 "amount": 1500,
 "currency": "USD"
 }
 }
 ]
 }
}

Create Payment

Creates a payment using the provided source.

Input	Comments	Default
Connection	The Square connection to use.
Payment Data	Payment data in JSON format. Amounts are in cents (smallest currency unit). See Square Create Payment for field details.	`{ "source_id": "cnon:card-nonce-ok", "idempotency_key": "a7c8e4b1-3f5d-4e2a-9c1b-7d3e5f8a2c6b", "amount_money": { "amount": 1500, "currency": "USD" }, "location_id": "LH2G9VFHJRWKR" }`

Create Team Member

Creates a new team member.

Input	Comments	Default
Connection	The Square connection to use.
Team Member	The team member data in JSON format. See Square TeamMember Object for field details.
Idempotency Key	A unique string that identifies this request to ensure idempotent operations.

Create Webhook Subscription

Creates a webhook subscription.

Input	Comments	Default
Connection	The Square connection to use.
Idempotency Key	A unique string that identifies this request to ensure idempotent operations.
Webhook Subscription	The webhook subscription data in JSON format. See Square Webhook Subscription for configuration details.

Delete Catalog Object

Deletes a single CatalogObject based on the provided ID and returns the set of successfully deleted IDs in the response.

Input	Comments	Default
Connection	The Square connection to use.
Object ID	The unique identifier for the catalog object.

Delete Customer

Deletes a customer profile from a business.

Input	Comments	Default
Connection	The Square connection to use.
Customer ID	The unique identifier for the customer.

Delete Instance Webhooks

Deletes all webhooks that point to a flow in this instance.

Input	Comments	Default
Connection	The Square connection to use.

Delete Invoice

Deletes an invoice.

Input	Comments	Default
Connection	The Square connection to use.
Invoice ID	The unique identifier for the invoice.

Delete Webhook Subscription

Deletes a webhook subscription.

Input	Comments	Default
Connection	The Square connection to use.
Subscription ID	The unique identifier for the webhook subscription to delete.

Get Invoice

Retrieves an invoice by its ID.

Input	Comments	Default
Connection	The Square connection to use.
Invoice ID	The unique identifier for the invoice.

Get Payment

Retrieves details for a specific payment.

Input	Comments	Default
Connection	The Square connection to use.
Payment ID	The unique identifier for the payment.

Get Payment Refund

Retrieves a specific refund using the refund_id.

Input	Comments	Default
Connection	The Square connection to use.
Refund ID	The unique identifier for the payment refund.

List Catalog

Returns a list of all CatalogObjects of the specified types in the catalog.

Input	Comments	Default
Connection	The Square connection to use.
Cursor	The pagination cursor returned by a previous call to this endpoint.
Types	An optional case-insensitive, comma-separated list of object types to retrieve. Valid values are defined in the CatalogObjectType enum, for example, ITEM, ITEM_VARIATION, CATEGORY, DISCOUNT, TAX, MODIFIER, MODIFIER_LIST, IMAGE.	ITEM, ITEM_VARIATION, CATEGORY, DISCOUNT, TAX, MODIFIER, MODIFIER_LIST, IMAGE
Catalog Version	The specific version of the catalog objects to include in the response. Used to retrieve historical versions of objects. The value is matched against the CatalogObject version attribute.

List Customers

Lists customer profiles associated with a Square account.

Input	Comments	Default
Connection	The Square connection to use.
Cursor	The pagination cursor returned by a previous call to this endpoint.
Limit	The maximum number of results to return in a single page.
Sort Field	The field used to sort the results.
Sort Order	The order in which results are sorted.

List Invoices

Returns a list of invoices for a given location.

Input	Comments	Default
Connection	The Square connection to use.
Location ID	The unique identifier for the location.
Cursor	The pagination cursor returned by a previous call to this endpoint.
Limit	The maximum number of results to return in a single page.

List Jobs

Lists jobs in a seller account, sorted by title in ascending order.

Input	Comments	Default
Connection	The Square connection to use.
Fetch All	When true, automatically fetches all pages of results using cursor pagination.	false
Cursor	The pagination cursor returned by a previous call to this endpoint.

List Locations

Lists all of the seller's locations, including those with an inactive status.

Input	Comments	Default
Connection	The Square connection to use.

List Payment Refunds

Retrieves a list of refunds for the account making the request.

Input	Comments	Default
Connection	The Square connection to use.
Begin Time	The timestamp marking the start of the time range. Format: RFC 3339.
Location ID	The unique identifier for the location.
Cursor	The pagination cursor returned by a previous call to this endpoint.
Limit	The maximum number of results to return in a single page.
End Time	The end of the time range used to retrieve payments. Filtered using the created_at field. Format: RFC 3339.
Sort Order	The order in which results are sorted.
Status	When provided, only refunds with the given status are returned.
Source Type	When provided, only refunds whose payments have the indicated source type are returned.

List Payments

Retrieves a list of payments taken by the account making the request.

Input	Comments	Default
Connection	The Square connection to use.
Begin Time	The timestamp marking the start of the time range. Format: RFC 3339.
Location ID	The unique identifier for the location.
Cursor	The pagination cursor returned by a previous call to this endpoint.
Limit	The maximum number of results to return in a single page.
End Time	The end of the time range used to retrieve payments. Filtered using the created_at field. Format: RFC 3339.
Sort Order	The order in which results are sorted.
Total	The exact payment amount in cents (smallest currency unit). For example, 1500 for $15.00.
Last 4 Digits of Card	The last four digits of the payment card used.
Card Brand	The brand of the payment card (for example, VISA, MASTERCARD, AMEX).

List Webhook Subscriptions

Lists all webhook subscriptions owned by your application.

Input	Comments	Default
Connection	The Square connection to use.
Cursor	The pagination cursor returned by a previous call to this endpoint.
Limit	The maximum number of results to return in a single page.
Include Disabled	When true, disabled subscriptions are included in the results. By default, only enabled subscriptions are returned.	false
Sort Order	The sort order for subscriptions by creation date. Options: ASC (oldest first), DESC (newest first).

Publish Invoice

Publishes an invoice.

Input	Comments	Default
Connection	The Square connection to use.
Invoice ID	The unique identifier for the invoice.
Idempotency Key	A unique string that identifies this request to ensure idempotent operations.

Raw Request

Sends a raw HTTP request to the Square API.

Input	Comments	Default
URL	This is the URL to call.
Method	The HTTP method to use.
Data	The HTTP body payload to send to the URL.
Form Data	The Form Data to be sent as a multipart form upload.
File Data	File Data to be sent as a multipart form upload.
File Data File Names	File names to apply to the file data inputs. Keys must match the file data keys above.
Query Parameter	A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Header	A list of headers to send with the request.
Response Type	The type of data you expect in the response. You can request json, text, or binary data.	json
Timeout	The maximum time that a client will await a response to its request
Retry Delay (ms)	The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.	0
Retry On All Errors	If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.	false
Max Retry Count	The maximum number of retries to attempt. Specify 0 for no retries.	0
Use Exponential Backoff	Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.	false
Connection	The Square connection to use.

Refund Payment

Refunds a payment. You can refund the entire payment amount or a portion of it.

Input	Comments	Default
Connection	The Square connection to use.
Payment ID	The unique identifier for the payment.
Idempotency Key	A unique string that identifies this request to ensure idempotent operations.
Refund Amount	The refund amount in JSON format. Amount is in cents (smallest currency unit). Cannot exceed the payment total minus previous refunds.
Reason	A description of the reason for the refund.

Retrieve Catalog Object

Returns a single CatalogObject based on the provided ID.

Input	Comments	Default
Connection	The Square connection to use.
Object ID	The unique identifier for the catalog object.
Include Related Objects	When true, the response includes additional objects that are related to the requested objects.	false
Catalog Version	The specific version of the catalog objects to include in the response. Used to retrieve historical versions of objects. The value is matched against the CatalogObject version attribute.

Retrieve Customer

Retrieves details for a single customer.

Input	Comments	Default
Connection	The Square connection to use.
Customer ID	The unique identifier for the customer.

Retrieve Job

Retrieves a specified job by ID.

Input	Comments	Default
Connection	The Square connection to use.
Job ID	The unique identifier for the job.

Retrieve Location

Retrieves details of a specific location.

Input	Comments	Default
Connection	The Square connection to use.
Location ID	The unique identifier for the location.

Retrieve Order

Retrieves an Order by its ID.

Input	Comments	Default
Connection	The Square connection to use.
Order ID	The unique identifier for the order.

Retrieve Team Member

Retrieves a team member based on the provided ID.

Input	Comments	Default
Connection	The Square connection to use.
Team Member ID	The unique identifier for the team member.

Retrieve Webhook Subscription

Retrieves a webhook subscription identified by its ID.

Input	Comments	Default
Connection	The Square connection to use.
Subscription ID	The unique identifier for the webhook subscription.

Search Catalog Items

Searches for catalog items or item variations by matching supported search attribute values, including custom attribute values, against one or more of the specified query filters.

Input	Comments	Default
Connection	The Square connection to use.
Cursor	The pagination cursor returned by a previous call to this endpoint.
Limit	The maximum number of results to return in a single page.
Text Filter	The text filter expression used to return items or item variations containing the specified text.
Category IDs	An array of category IDs in JSON format used to filter items by category.	`[ "W62UWFY35CWMYGVWK6TWJDNI", "X73VXGZ46DXNZHXWL7UXKENJ" ]`
Stock Levels	An array of stock levels in JSON format used to filter items. Options: OUT, LOW.	`[ "OUT", "LOW" ]`
Enabled Location IDs	An array of location IDs in JSON format used to filter items by enabled locations.	`[ "LH2G9VFHJRWKR", "LK3H8WGIKSMLA" ]`
Sort Order	The order in which results are sorted.
Product Types	An array of product types in JSON format used to filter items. Options: REGULAR, APPOINTMENTS_SERVICE.	`[ "REGULAR", "APPOINTMENTS_SERVICE" ]`
Custom Attribute Filters	An array of custom attribute filters in JSON format used to match items with specific custom attributes.	`[ { "custom_attribute_definition_id": "W62UWFY35CWMYGVWK6TWJDNI", "key": "color", "string_filter": "blue", "bool_filter": true } ]`

Search Catalog Objects

Searches for CatalogObject of any type by matching supported search attribute values, excluding custom attribute values on items or item variations, against one or more of the specified query filters.

Input	Comments	Default
Connection	The Square connection to use.
Object Types	A comma-separated list of catalog object types to include in the search results. Options: ITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST.
Include Deleted Objects	When true, deleted objects are included in the results.	false
Include Related Objects	When true, the response includes additional objects that are related to the requested objects.	false
Begin Time	The timestamp marking the start of the time range. Format: RFC 3339.
Catalog Query	Query to filter or sort catalog results in JSON format. See Square Catalog Query for query options.	`{ "sorted_attribute_query": { "attribute_name": "name", "initial_attribute_value": "A", "sort_order": "ASC" }, "exact_query": { "attribute_name": "type", "attribute_value": "ITEM" } }`
Cursor	The pagination cursor returned by a previous call to this endpoint.
Limit	The maximum number of results to return in a single page.

Search Customers

Searches for customer profiles.

Input	Comments	Default
Connection	The Square connection to use.
Query	The query to search for customers. See Square Search Customers for filter and sort options.	`{ "query": { "filter": { "creation_source": { "values": [ "THIRD_PARTY" ], "rule": "INCLUDE" }, "created_at": { "start_at": "2024-01-01T00:00:00-00:00", "end_at": "2024-02-01T00:00:00-00:00" }, "email_address": { "fuzzy": "example.com" }, "group_ids": { "all": [ "JDKYHBWT1D4F8MFH63DBMEN8Y4" ] } }, "sort": { "field": "CREATED_AT", "order": "ASC" } } }`
Cursor	The pagination cursor returned by a previous call to this endpoint.
Limit	The maximum number of results to return in a single page.

Search Invoices

Searches for invoices from a location specified in the filter.

Input	Comments	Default
Connection	The Square connection to use.
Query	The query to search for invoices. See Square Search Invoices for filter and sort options.	`{ "filter": { "location_ids": [ "LH2G9VFHJRWKR" ], "customer_ids": [ "JDKYHBWT1D4F8MFH63DBMEN8Y4" ] }, "sort": { "field": "INVOICE_SORT_DATE", "order": "DESC" } }`
Cursor	The pagination cursor returned by a previous call to this endpoint.
Limit	The maximum number of results to return in a single page.

Search Orders

Searches all orders for one or more locations.

Input	Comments	Default
Connection	The Square connection to use.
Location IDs	An array of location IDs in JSON format used to filter results to specific locations.	`[ "LH2G9VFHJRWKR", "LK3H8WGIKSMLA" ]`
Query	The query to search for orders. See Square Search Orders for filter and sort options.	`{ "filter": { "state_filter": { "states": [ "COMPLETED" ] }, "date_time_filter": { "closed_at": { "start_at": "2024-01-01T00:00:00+00:00", "end_at": "2024-12-31T23:59:59+00:00" } }, "customer_filter": { "customer_ids": [ "JDKYHBWT1D4F8MFH63DBMEN8Y4" ] } }, "sort": { "sort_field": "CLOSED_AT", "sort_order": "DESC" } }`
Return Entries	When true, the entries associated with the orders are returned.	true
Cursor	The pagination cursor returned by a previous call to this endpoint.
Limit	The maximum number of results to return in a single page.

Search Team Members

Searches for team members based on the given filters.

Input	Comments	Default
Connection	The Square connection to use.
Search Query	The query parameters to filter team members. See Square Search Team Members for filter options.	`{ "filter": { "location_ids": [ "LH2G9VFHJRWKR" ], "status": "ACTIVE", "is_owner": false } }`
Cursor	The pagination cursor returned by a previous call to this endpoint.
Limit	The maximum number of results to return in a single page.

Update Customer

Updates a customer profile.

Input	Comments	Default
Connection	The Square connection to use.
Customer ID	The unique identifier for the customer.
Address	The customer's mailing address in JSON format. See Square Address Object for field details.	`{ "address_line_1": "1234 Main Street", "address_line_2": "Suite 100", "locality": "San Francisco", "administrative_district_level_1": "CA", "postal_code": "94102", "country": "US", "first_name": "John", "last_name": "Doe" }`
Birthday	The customer's date of birth. Format: YYYY-MM-DD.
Company Name	The name of the company associated with the customer.
Email Address	The email address of the customer.
Family Name	The last name of the customer.
Given Name	The first name of the customer.
Nickname	An informal name to associate with the customer.
Note	A free-form note to associate with the customer.
Phone Number	The phone number of the customer in E.164 format (e.g., +14155552671).
Reference ID	An optional external reference ID to associate with the customer.
Tax IDs	Tax identification numbers in JSON format. Only applicable for EU countries. See Square Tax IDs for supported formats.	`{ "eu_vat": "IE3426675K" }`

Update Invoice

Updates an invoice.

Input Comments Default

Connection The Square connection to use.

Invoice ID The unique identifier for the invoice.

Update Invoice

The invoice data to update in JSON format. See Square Update Invoice for field details.

{
 "invoice": {
 "version": 1,
 "payment_requests": [
 {
 "uid": "2da7964f-f3d2-4f43-81e8-5aa220bf3355",
 "tipping_enabled": false
 }
 ]
 },
 "idempotency_key": "4ee82288-0910-499e-ab4c-5d0071dad1be",
 "fields_to_clear": [
 "payment_requests[2da7964f-f3d2-4f43-81e8-5aa220bf3355].reminders"
 ]
}

Update Job

Updates the title or tip eligibility of a job. Changes propagate to all job assignments, shifts, and wage settings.

Input	Comments	Default
Connection	The Square connection to use.
Job ID	The unique identifier for the job.
Job Title	Updated job title. Only include if changing the title.
Is Tip Eligible	When true, employees in this job role are eligible to receive tips. Only include if changing tip eligibility.	true
Version	The version number used for optimistic concurrency control. Ensures the object has not been modified by another request.

Update Location

Updates a location associated with a Square account.

Input Comments Default

Connection The Square connection to use.

Location ID The unique identifier for the location.

Location Update

The location data to update in JSON format. See Square Location Object for field details.

{
 "id": "LH2G9VFHJRWKR",
 "name": "Downtown Store",
 "address": {
 "address_line_1": "1234 Main Street",
 "locality": "San Francisco",
 "administrative_district_level_1": "CA",
 "postal_code": "94102"
 },
 "timezone": "America/Los_Angeles",
 "status": "ACTIVE",
 "country": "US",
 "language_code": "en-US",
 "currency": "USD",
 "type": "PHYSICAL",
 "description": "Main downtown retail location",
 "coordinates": {
 "latitude": 37.7749,
 "longitude": -122.4194
 },
 "business_hours": {
 "periods": [
 {
 "day_of_week": "MON",
 "start_local_time": "09:00",
 "end_local_time": "18:00"
 },
 {
 "day_of_week": "TUE",
 "start_local_time": "09:00",
 "end_local_time": "18:00"
 }
 ]
 },
 "business_name": "Example Business",
 "mcc": "5999"
}

Update Order

Updates an open order by adding, replacing, or deleting fields.

Input	Comments	Default
Connection	The Square connection to use.
Order ID	The unique identifier for the order.
Order Object	The complete order object in JSON format. See Square Order Object for field details.	`{ "idempotency_key": "a7c8e4b1-3f5d-4e2a-9c1b-7d3e5f8a2c6b", "order": { "location_id": "LH2G9VFHJRWKR", "line_items": [ { "name": "Coffee Mug", "quantity": "1", "base_price_money": { "amount": 1500, "currency": "USD" } } ] } }`
Fields to Clear	Array of dot notation paths for fields to clear in JSON format. For example: line_items[uid].note or discounts[uid].	`[ "line_items[uid].note", "discounts[uid]" ]`
Idempotency Key	A unique string that identifies this request to ensure idempotent operations.

Update Payment

Updates a payment with the APPROVED status.

Input	Comments	Default
Connection	The Square connection to use.
Payment ID	The unique identifier for the payment.
Payment	Payment data in JSON format. Amounts are in cents (smallest currency unit). See Square Payment Object for field details.	`{ "amount_money": { "amount": 1500, "currency": "USD" }, "tip_money": { "amount": 300, "currency": "USD" } }`

Update Team Member

Updates a team member.

Input	Comments	Default
Connection	The Square connection to use.
Team Member ID	The unique identifier for the team member.
Team Member	The team member data in JSON format. See Square TeamMember Object for field details.

Update Webhook Subscription

Updates a webhook subscription.

Input	Comments	Default
Connection	The Square connection to use.
Subscription ID	The unique identifier for the webhook subscription.
Webhook Subscription	The updated webhook subscription data in JSON format. Include only the fields to modify.	`{ "name": "Updated Order Webhook", "enabled": true, "event_types": [ "order.created", "order.updated", "order.fulfilled" ], "notification_url": "https://your-webhook-endpoint.com/square/webhooks" }`

Upsert Catalog Object

Creates a new or updates the specified CatalogObject.

Input Comments Default

Connection The Square connection to use.

Idempotency Key A unique string that identifies this request to ensure idempotent operations.

Catalog Object

Catalog object data in JSON format. See Square Catalog Object for field details.

{
 "type": "ITEM",
 "id": "#temp-item-id",
 "item_data": {
 "name": "Coffee Mug",
 "description": "Ceramic coffee mug - 12oz capacity",
 "abbreviation": "MUG",
 "category_id": "W62UWFY35CWMYGVWK6TWJDNI",
 "variations": [
 {
 "type": "ITEM_VARIATION",
 "id": "#temp-variation-id",
 "item_variation_data": {
 "item_id": "#temp-item-id",
 "name": "Regular",
 "pricing_type": "FIXED_PRICING",
 "price_money": {
 "amount": 1500,
 "currency": "USD"
 }
 }
 }
 ]
 }
}

API Documentation​

Connections​

OAuth 2.0​

Prerequisites​

Setup Steps​

Configure the Connection​

Verify Connection​

Production Credentials​

Triggers​

New and Updated Payments​

Webhook​

Actions​

Batch Change Inventory​

Batch Delete Catalog Objects​

Batch Retrieve Catalog Objects​

Batch Retrieve Inventory Counts​

Batch Retrieve Orders​

Batch Upsert Catalog Objects​

Cancel Invoice​

Cancel Payment​

Clone Order​

Complete Payment​

Create Customer​

Create Job​

Create Order​

Create Payment​

Create Team Member​

Create Webhook Subscription​

Delete Catalog Object​

Delete Customer​

Delete Instance Webhooks​

Delete Invoice​

Delete Webhook Subscription​

Get Invoice​

Get Payment​

Get Payment Refund​

List Catalog​

List Customers​

List Invoices​

List Jobs​

List Locations​

List Payment Refunds​

List Payments​

List Webhook Subscriptions​

Publish Invoice​

Raw Request​

Refund Payment​

Retrieve Catalog Object​

Retrieve Customer​

Retrieve Job​

Retrieve Location​

Retrieve Order​

Retrieve Team Member​

Retrieve Webhook Subscription​

Search Catalog Items​

Search Catalog Objects​

Search Customers​

Search Invoices​

Search Orders​

Search Team Members​

Update Customer​

Update Invoice​

Update Job​

Update Location​

Update Order​

Update Payment​

Update Team Member​

Update Webhook Subscription​

Upsert Catalog Object​

API Documentation

Connections

OAuth 2.0

Prerequisites

Setup Steps

Configure the Connection

Verify Connection

Production Credentials

Triggers

New and Updated Payments

Webhook

Actions

Batch Change Inventory

Batch Delete Catalog Objects

Batch Retrieve Catalog Objects

Batch Retrieve Inventory Counts

Batch Retrieve Orders

Batch Upsert Catalog Objects

Cancel Invoice

Cancel Payment

Clone Order

Complete Payment

Create Customer

Create Job

Create Order

Create Payment

Create Team Member

Create Webhook Subscription

Delete Catalog Object

Delete Customer

Delete Instance Webhooks

Delete Invoice

Delete Webhook Subscription

Get Invoice

Get Payment

Get Payment Refund

List Catalog

List Customers

List Invoices

List Jobs

List Locations

List Payment Refunds

List Payments

List Webhook Subscriptions

Publish Invoice

Raw Request

Refund Payment

Retrieve Catalog Object

Retrieve Customer

Retrieve Job

Retrieve Location

Retrieve Order

Retrieve Team Member

Retrieve Webhook Subscription

Search Catalog Items

Search Catalog Objects

Search Customers

Search Invoices

Search Orders

Search Team Members

Update Customer

Update Invoice

Update Job

Update Location

Update Order

Update Payment

Update Team Member

Update Webhook Subscription

Upsert Catalog Object