This website uses cookies. By clicking Accept, you consent to the use of cookies. Click Here to learn more about how we use cookies.
Accept
Reject
Community FAQ
cancel
Turn on suggestions
Auto-suggest helps you quickly narrow down your search results by suggesting possible matches as you type.
Showing results for 
Show  only  | Search instead for 
Did you mean: 
Glossary

This documentation is for the new preview UI. It’s still being refined and is subject to change. For documentation for the old UI, see Knowledge Base.

Square Connector

Article link copied to clipboard
Updated

on ‎10-31-2025 12:28 PM - edited Friday by Lansweeper Employee

Published
‎10-31-2025 12:28 PM
19 min read
Note on third‑party tools

We aim to provide accurate and helpful details about third‑party tools, but we can’t guarantee that this information is always complete or up to date. If you notice any discrepancies, feel free to share them in the feedback section below. For the most reliable information, please always refer to the third‑party tool’s official documentation.

Square offers a suite of commerce products for retail stores.

Connections

Square OAuth 2.0

Authenticate requests to Square using values obtained from the Developer Console.

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

Prerequisites

Setup Steps

  1. Navigate to the Square Developer Portal and sign in
  2. Create a new application or select an existing application
  3. In the application settings, navigate to the OAuth section
  4. Add https://oauth2.flowbuilder.eu.lansweeper.com/callback for EU sites or https://oauth2.flowbuilder.us.lansweeper.com/callback for US sites as a Redirect URL
  5. Configure the required permissions (scopes) for the application based on the integration needs
  6. Copy the Application ID and Application Secret from the Credentials section

Configure the Connection

  • Enter the Application ID as the Client ID
  • Enter the Application Secret as the Client Secret
  • For Scopes, configure the OAuth permissions the application requires. Refer to the Square OAuth Permissions documentation for available scopes.

Verify Connection

After configuring the connection, users will be redirected to Square to authorize access to the account. Once authorized, the integration can interact with the Square API on behalf of the user.

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 Space separated list of OAuth permission scopes. These scopes should be configured in your 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 > Your App > 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

Webhook

Receive and validate webhook requests from Square for webhooks you configure.

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 The set of physical counts and inventory adjustments to be made. Changes are applied based on the client-supplied timestamp and may be sent out of order. [
{
"type": "PHYSICAL_COUNT",
"physical_count": {
"catalog_object_id": "object_id",
"state": "IN_STOCK",
"quantity": "10",
"location_id": "location_id",
"occurred_at": "2023-07-01T00:00:00Z",
"created_at": "2023-07-01T00:00:00Z"
}
},
{
"type": "ADJUSTMENT",
"adjustment": {
"catalog_object_id": "object_id",
"from_state": "IN_STOCK",
"to_state": "SOLD",
"quantity": "-1",
"location_id": "location_id",
"occurred_at": "2023-07-01T00:00:00Z",
"created_at": "2023-07-01T00:00:00Z",
"source": {
"product": "REGISTER",
"application_id": "app_id",
"name": "Register",
"type": "APP"
}
}
}
]
Ignore Unchanged Counts When true, unchanged inventory counts will be 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 The IDs of the CatalogObjects to be retrieved. [
"obj1",
"obj2",
"obj3"
]

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 The IDs of the CatalogObjects to be retrieved. [
"obj1",
"obj2",
"obj3"
]
Include Related Objects When true, the response will include additional objects that are related to the requested objects. false
Catalog Version The specific version of the catalog objects to be included in the response. This allows you to retrieve historical versions of objects. The specified version value is matched against the CatalogObjects' version attribute.
Include Deleted Objects When true, deleted objects will be included in the results. false

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 The filter to return results by CatalogObject ID. [
"object1",
"object2"
]
Location IDs Array of location IDs. These IDs will be used to filter the results to specific locations. [
"L2D9N2BTY6CDC",
"L3K7N2BTY6CDE"
]
Updated After The filter to return results with their calculated_at value after the given time as specified in an RFC 3339 timestamp.
Cursor A pagination cursor returned by a previous call to this endpoint.
States The filter to return results by InventoryState. [
"IN_STOCK",
"SOLD"
]
Limit The maximum number of results to be returned in a single page.

Batch Retrieve Orders

Retrieves a set of orders by their IDs.

Input Comments Default
Connection The Square connection to use.
Location ID The ID of the location to retrieve details for.
Order IDs The IDs of the orders to retrieve. A maximum of 100 orders can be retrieved per request. [
"OrderID1",
"OrderID2"
]

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 A list of batches of CatalogObjects to be inserted/updated atomically. Each batch may contain up to 1,000 objects. The total number of objects across all batches for a single request may not exceed 10,000. If either of these limits is violated, an error will be returned and no objects will be inserted or updated. [
{
"objects": [
{
"type": "exampleType",
"id": "#exampleId"
}
]
}
]

Cancel Invoice

Cancel an invoice.

Input Comments Default
Connection The Square connection to use.
Invoice ID The ID of the invoice to retrieve.

Cancel Payment

Cancels (voids) a payment.

Input Comments Default
Connection The Square connection to use.
Payment ID A unique ID for the desired 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 ID of the order to retrieve.
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 A unique ID for the desired payment.
Version Token Used for optimistic concurrency. This token identifies the current Payment version.

Create Customer

Create a new customer profile.

Input Comments Default
Address Address in JSON format {
"address_line_1": "test",
"address_line_2": "test1",
"address_line_3": "test2",
"locality": "madero",
"sublocality": "one",
"sublocality_2": "two",
"sublocality_3": "three",
"administrative_district_level_1": "test3",
"administrative_district_level_2": "test3",
"administrative_district_level_3": "test4",
"postal_code": "89510",
"country": "MX",
"first_name": "Oscar",
"last_name": "Antonio"
}
Birthday The customer's birthday in YYYY-MM-DD format.
Company Name The name of the customer's company.
Email Address The customer's email address.
Family Name The customer's family name (last name).
Given Name The customer's given name (first name).
Nickname A nickname for the customer.
Note A note to associate with the customer.
Phone Number The customer's phone number in E.164 format (e.g., +14155552671).
Reference Id An optional reference ID to associate with the customer.
Tax IDs Tax IDs in JSON format {
"eu_vat": "IE3426675K"
}
Idempotency Key A unique string that identifies this request to ensure idempotent operations.
Connection The Square connection to use.

Create Job

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

Input Comments Default
Connection The Square connection to use.
Job Title The job designation (e.g., Cashier, Server, Manager).
Idempotency Key A unique string that identifies this CreateJob request.
Is Tip Eligible When true, the job is eligible for tips. Defaults to true if not specified. true

Create Order

Create a new order.

Input Comments Default
Location ID The ID of the location to retrieve details for.
Order Object The complete order object. Please refer to the Square API documentation for the structure of this object. {
"idempotency_key": "example_idempotency_key",
"order": {
"location_id": "example_location_id",
"line_items": [
{
"name": "Example item",
"quantity": "1",
"base_price_money": {
"amount": 100,
"currency": "USD"
}
}
]
}
}
Connection The Square connection to use.

Create Payment

Creates a payment using the provided source.

Input Comments Default
Connection The Square connection to use.
Payment Data The payment data object containing all necessary information for creating the payment. {
"source_id": "SOURCE_ID",
"idempotency_key": "IDEMPOTENCY_KEY",
"amount_money": {
"amount": 100,
"currency": "USD"
}
}

Create Team Member

Create a new team member.

Input Comments Default
Team Member The data which will be used to create the TeamMember object.
Idempotency Key A unique string that identifies this request to ensure idempotent operations.
Connection The Square connection to use.

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 Subscription to create.

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 object ID of any type of catalog objects to be retrieved.

Delete Customer

Delete a customer profile from a business.

Input Comments Default
Customer ID The ID of the customer to retrieve details for.
Connection The Square connection to use.

Delete Instance Webhooks

Delete all webhooks that point to a flow in this instance

Input Comments Default
Connection The Square connection to use.

Delete Invoice

Delete an invoice.

Input Comments Default
Connection The Square connection to use.
Invoice ID The ID of the invoice to retrieve.

Delete Webhook Subscription

Deletes a webhook subscription.

Input Comments Default
Connection The Square connection to use.
Subscription ID The ID of the Subscription to delete.

Get Invoice

Retrieve an invoice by its ID.

Input Comments Default
Connection The Square connection to use.
Invoice ID The ID of the invoice to retrieve.

Get Payment

Retrieves details for a specific payment.

Input Comments Default
Connection The Square connection to use.
Payment ID A unique ID for the desired 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 ID for the desired PaymentRefund.

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 A pagination cursor returned by a previous call to this endpoint.
Types An optional case-insensitive, comma-separated list of object types to retrieve. The valid values are defined in the CatalogObjectType enum, for example, ITEM, ITEM_VARIATION, CATEGORY, DISCOUNT, TAX, MODIFIER, MODIFIER_LIST, IMAGE, etc. ITEM, ITEM_VARIATION, CATEGORY, DISCOUNT, TAX, MODIFIER, MODIFIER_LIST, IMAGE
Catalog Version The specific version of the catalog objects to be included in the response. This allows you to retrieve historical versions of objects. The specified version value is matched against the CatalogObjects' version attribute.

List Customers

List customer profiles associated with a Square account.

Input Comments Default
Cursor A pagination cursor returned by a previous call to this endpoint.
Limit The maximum number of results to be returned in a single page.
Sort Field Field to sort the customers on.
Sort Order Order to sort the customers.
Connection The Square connection to use.

List Invoices

Returns a list of invoices for a given location.

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

List Jobs

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

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

List Locations

List 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 Return objects modified after this timestamp, in RFC 3339 format.
End Time Indicates the end of the time range to retrieve payments for, in RFC 3339 format. The range is determined using the created_at field for each Payment.
Sort Order Order to sort the customers.
Cursor A pagination cursor returned by a previous call to this endpoint.
Location ID The ID of the location to retrieve details for.
Status If provided, only refunds with the given status are returned.
Source Type If provided, only returns refunds whose payments have the indicated source type.
Limit The maximum number of results to be returned in a single page.

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 Return objects modified after this timestamp, in RFC 3339 format.
End Time Indicates the end of the time range to retrieve payments for, in RFC 3339 format. The range is determined using the created_at field for each Payment.
Sort Order Order to sort the customers.
Cursor A pagination cursor returned by a previous call to this endpoint.
Location ID The ID of the location to retrieve details for.
Total The exact amount in the total_money for a payment (in the smallest currency unit, e.g., cents).
Last 4 digits of Card The last four digits of a payment card.
Card Brand The brand of the payment card (for example, VISA, MASTERCARD, AMEX).
Limit The maximum number of results to be returned in a single page.

List Webhook Subscriptions

Lists all webhook subscriptions owned by your application.

Input Comments Default
Connection The Square connection to use.
Cursor A pagination cursor returned by a previous call to this endpoint.
Include Disabled When true, includes disabled Subscriptions. By default, only enabled Subscriptions are returned. false
Sort Order Sorts the returned list by when the Subscription was created with the specified order. Options: ASC, DESC
Limit The maximum number of results to be returned in a single page.

Publish Invoice

Publish an invoice.

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

Raw Request

Send raw HTTP request to Square

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 A unique ID for the desired payment.
Idempotency Key A unique string that identifies this request to ensure idempotent operations.
Refund Amount The amount of money to refund. This amount cannot be more than the total_money value of the payment minus the total amount of all previously completed refunds for this payment.
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 object ID of any type of catalog objects to be retrieved.
Include Related Objects When true, the response will include additional objects that are related to the requested objects. false
Catalog Version The specific version of the catalog objects to be included in the response. This allows you to retrieve historical versions of objects. The specified version value is matched against the CatalogObjects' version attribute.

Retrieve Customer

Retrieve details for a single customer.

Input Comments Default
Customer ID The ID of the customer to retrieve details for.
Connection The Square connection to use.

Retrieve Job

Retrieve a specified job by ID.

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

Retrieve Location

Retrieves details of a specific location.

Input Comments Default
Location ID The ID of the location to retrieve details for.
Connection The Square connection to use.

Retrieve Order

Retrieves an Order by its ID.

Input Comments Default
Connection The Square connection to use.
Order ID The ID of the order to retrieve.

Retrieve Team Member

Retrieve a team member based on the provided ID.

Input Comments Default
Team Member ID The ID of the TeamMember to be retrieved.
Connection The Square connection to use.

Retrieve Webhook Subscription

Retrieves a webhook subscription identified by its ID.

Input Comments Default
Connection The Square connection to use.
Subscription ID The ID of the Subscription to retrieve.

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.
Text Filter The text filter expression to return items or item variations containing specified text.
Category IDs The category id query expression to return items containing the specified category IDs. [
"categoryId1",
"categoryId2"
]
Stock Levels The stock-level query expression to return item variations with the specified stock levels. [
"OUT",
"LOW"
]
Enabled Location IDs The enabled-location query expression to return items and item variations having specified enabled locations. [
"locationId1",
"locationId2"
]
Cursor A pagination cursor returned by a previous call to this endpoint.
Limit The maximum number of results to be returned in a single page.
Sort Order Order to sort the customers.
Product Types The product types query expression to return items or item variations having the specified product types. [
"REGULAR",
"APPOINTMENTS_SERVICE"
]
Custom Attribute Filters The customer-attribute filter to return items or item variations matching the specified custom attribute expressions. [
{
"custom_attribute_definition_id": "attributeId",
"key": "exampleKey",
"string_filter": "exampleString",
"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.
Cursor A pagination cursor returned by a previous call to this endpoint.
Object Types The desired set of object types to appear in the search results.
Include Deleted Objects When true, deleted objects will be included in the results. false
Include Related Objects When true, the response will include additional objects that are related to the requested objects. false
Begin Time Return objects modified after this timestamp, in RFC 3339 format.
Catalog Query A query to be used to filter or sort the results. If no query is specified, the entire catalog will be returned. {
"sorted_attribute_query": {
"attribute_name": "exampleAttributeName",
"initial_attribute_value": "exampleInitialValue",
"sort_order": "ASC"
},
"exact_query": {
"attribute_name": "exampleAttributeName",
"attribute_value": "exampleAttributeValue"
}
}
Limit The maximum number of results to be returned in a single page.

Search Customers

Search customer profiles.

Input Comments Default
Limit The maximum number of results to be returned in a single page.
Query The query to search for customers. Please refer to the Square API documentation for the structure and options of this query. {
"query": {
"filter": {
"creation_source": {
"values": [
"THIRD_PARTY"
],
"rule": "INCLUDE"
},
"created_at": {
"start_at": "2018-01-01T00:00:00-00:00",
"end_at": "2018-02-01T00:00:00-00:00"
},
"email_address": {
"fuzzy": "example.com"
},
"group_ids": {
"all": [
"545AXB44B4XXWMVQ4W8SBT3HHF"
]
}
},
"sort": {
"field": "CREATED_AT",
"order": "ASC"
}
}
}
Cursor A pagination cursor returned by a previous call to this endpoint.
Connection The Square connection to use.

Search Invoices

Searches for invoices from a location specified in the filter.

Input Comments Default
Limit The maximum number of results to be returned in a single page.
Query The query to search for invoices. Please refer to the Square API documentation for the structure and options of this query. {
"filter": {
"location_ids": [
"L2D9N2BTY6CDC"
],
"customer_ids": [
"SSRAQAX223WXC422K2443PS494"
]
},
"sort": {
"field": "INVOICE_SORT_DATE",
"order": "DESC"
}
}
Cursor A pagination cursor returned by a previous call to this endpoint.
Connection The Square connection to use.

Search Orders

Search all orders for one or more locations.

Input Comments Default
Connection The Square connection to use.
Location IDs Array of location IDs. These IDs will be used to filter the results to specific locations. [
"L2D9N2BTY6CDC",
"L3K7N2BTY6CDE"
]
Query The query to search for orders. Please refer to the Square API documentation for the structure and options of this query. {
"filter": {
"state_filter": {
"states": [
"COMPLETED"
]
},
"date_time_filter": {
"closed_at": {
"start_at": "2023-01-01T00:00:00+00:00",
"end_at": "2023-12-31T23:59:59+00:00"
}
},
"customer_filter": {
"customer_ids": [
"SSRAQAX223WXC422K2443PS494"
]
}
},
"sort": {
"sort_field": "CLOSED_AT",
"sort_order": "DESC"
}
}
Limit The maximum number of results to be returned in a single page.
Return Entries When true, the entries associated with the orders will be returned. true
Cursor A pagination cursor returned by a previous call to this endpoint.

Search Team Members

Search for team members based on given filters.

Input Comments Default
Search Query The query parameters to filter the TeamMember objects. {
"filter": {
"location_ids": [
"L2D9N2BTY6CDC"
],
"status": "ACTIVE",
"is_owner": true
}
}
Connection The Square connection to use.
Limit The maximum number of results to be returned in a single page.
Cursor A pagination cursor returned by a previous call to this endpoint.

Update Customer

Update a customer profile.

Input Comments Default
Connection The Square connection to use.
Customer ID The ID of the customer to retrieve details for.
Address Address in JSON format {
"address_line_1": "test",
"address_line_2": "test1",
"address_line_3": "test2",
"locality": "madero",
"sublocality": "one",
"sublocality_2": "two",
"sublocality_3": "three",
"administrative_district_level_1": "test3",
"administrative_district_level_2": "test3",
"administrative_district_level_3": "test4",
"postal_code": "89510",
"country": "MX",
"first_name": "Oscar",
"last_name": "Antonio"
}
Birthday The customer's birthday in YYYY-MM-DD format.
Company Name The name of the customer's company.
Email Address The customer's email address.
Family Name The customer's family name (last name).
Given Name The customer's given name (first name).
Nickname A nickname for the customer.
Note A note to associate with the customer.
Phone Number The customer's phone number in E.164 format (e.g., +14155552671).
Reference Id An optional reference ID to associate with the customer.
Tax IDs Tax IDs in JSON format {
"eu_vat": "IE3426675K"
}

Update Invoice

Update an invoice.

Input Comments Default
Connection The Square connection to use.
Invoice ID The ID of the invoice to retrieve.
Update Invoice The data to update an invoice. Please refer to the Square API documentation for the structure and options of this update. {
"invoice": {
"version": 1,
"paymentRequests": [
{
"uid": "2da7964f-f3d2-4f43-81e8-5aa220bf3355",
"tippingEnabled": false
}
]
},
"idempotencyKey": "4ee82288-0910-499e-ab4c-5d0071dad1be",
"fieldsToClear": [
"payments_requests[2da7964f-f3d2-4f43-81e8-5aa220bf3355].reminders"
]
}

Update Job

Update 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 of the job.
Job Title Updated job title. Only include if changing the title.
Is Tip Eligible Updated tip eligibility. Only include if changing tip eligibility. true
Version The current version of the object for optimistic concurrency control.

Update Location

Updates a location associated with a Square account.

Input Comments Default
Location ID The ID of the location to retrieve details for.
Location Update The data which will be used to update the Location object. {
"id": "L2D9N2BTY6CDC",
"name": "Acme",
"address": {
"address_line_1": "1234 Peachtree St. NE",
"locality": "Atlanta",
"administrative_district_level_1": "GA",
"postal_code": "30309"
},
"timezone": "America/New_York",
"status": "ACTIVE",
"country": "US",
"language_code": "en-US",
"currency": "USD",
"type": "PHYSICAL",
"comments": "Midtown Atlanta store - Open weekends",
"coordinates": {
"latitude": 33.7889,
"longitude": -84.3841
},
"business_hours": {
"periods": [
{
"day_of_week": "FRI",
"start_local_time": "07:00",
"end_local_time": "18:00"
},
{
"day_of_week": "SAT",
"start_local_time": "07:00",
"end_local_time": "18:00"
},
{
"day_of_week": "SUN",
"start_local_time": "09:00",
"end_local_time": "15:00"
}
]
},
"business_name": "Jet Fuel Coffee",
"mcc": "7299"
}
Connection The Square connection to use.

Update Order

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

Input Comments Default
Order ID The ID of the order to retrieve.
Order Object The complete order object. Please refer to the Square API documentation for the structure of this object. {
"idempotency_key": "example_idempotency_key",
"order": {
"location_id": "example_location_id",
"line_items": [
{
"name": "Example item",
"quantity": "1",
"base_price_money": {
"amount": 100,
"currency": "USD"
}
}
]
}
}
Fields to Clear The dot notation paths of fields to clear. For example, line_items[uid].note. This is optional. [
"field1",
"field2"
]
Idempotency Key A unique string that identifies this request to ensure idempotent operations.
Connection The Square connection to use.

Update Payment

Updates a payment with the APPROVED status.

Input Comments Default
Connection The Square connection to use.
Payment ID A unique ID for the desired payment.
Payment The payment object containing the amount_money and tip_money to be updated. The amount is specified in the smallest denomination of the applicable currency (for example, US dollar amounts are specified in cents). {
"amount_money": {
"amount": 1000,
"currency": "USD"
},
"tip_money": {
"amount": 200,
"currency": "USD"
}
}

Update Team Member

Update a team member.

Input Comments Default
Team Member ID The ID of the TeamMember to be retrieved.
Team Member The data which will be used to create the TeamMember object.
Connection The Square connection to use.

Update Webhook Subscription

Updates a webhook subscription.

Input Comments Default
Connection The Square connection to use.
Subscription ID The ID of the Subscription to retrieve.
Webhook Subscription The updated webhook subscription object. It should include properties that you want to update. {
"name": "Updated Subscription Name",
"enabled": true,
"event_types": [
"event_type1",
"event_type2"
],
"notification_url": "http://example.com/notification-url"
}

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 A CatalogObject to be created or updated. {
"type": "ITEM",
"id": "#temp-item-id",
"item_data": {
"name": "Example Item",
"comments": "This is an example item.",
"abbreviation": "E",
"category_id": "example-category-id",
"variations": [
{
"type": "ITEM_VARIATION",
"id": "#temp-variation-id",
"item_variation_data": {
"item_id": "#temp-item-id",
"name": "Example Variation",
"pricing_type": "FIXED_PRICING",
"price_money": {
"amount": 100,
"currency": "USD"
}
}
}
]
}
}