Square Component
Square offers a suite of commerce products for retail stores.
Component key: square
Description
Square: https://squareup.com/ is a comprehensive commerce solution that provides a wide array of services like payments, point-of-sale (POS) system, online store builder, and more. It's trusted by millions of businesses for enabling seamless transactions and providing powerful business tools.
Use the Square component to manage payments, items, orders, customer data, and more in your Square account.
A Note on Square Pagination
Square's API supports pagination. This means that the API will return up to a specific limit of items for any query. If additional results are available, the API response includes a cursor field that can be used to retrieve the next page of data.
{
"objects": [],
"cursor": "next_page_cursor"
}
The cursor can be used in a subsequent query to fetch additional results.
See Square's Docs(https://developer.squareup.com/explorer/square) for information about Square's paginated API, and this quickstart for information on looping over a paginated API in Prismatic.
Connections
Square OAuth 2.0
Access Tokens are necessary for interacting with the Square API. Access tokens are unique to each application you create on Square.
To generate an Access Token, you should log in to Square and navigate to your application's page. Within the application settings, you can find your access tokens.
Square provides two types of access tokens:
Application Token: This token is used to send requests and perform other application-related actions in Square.
Personal Access Token: This token is used to perform account-level actions, such as creating and managing applications.
For your integration, you will need both the Application Token and the Personal Access Token.
For more information about access tokens, refer to the Square Docs.(https://developer.squareup.com/explorer/square).
| Input | Default | Notes |
|---|---|---|
Authorize URL string / Required authorizeUrl | https://connect.squareup.com/oauth2/authorize | The OAuth 2.0 Authorization URL for Square |
Base URL string / Required Hidden Field baseUrl | https://connect.squareup.com | The base URL for Square's API |
Application ID string / Required clientId | ||
Application Secret password / Required clientSecret | ||
Scopes string / Required scopes | MERCHANT_PROFILE_READ PAYMENTS_READ PAYMENTS_WRITE | A space-delimited set of one or more scopes to get the user's permission to access. |
Token URL string / Required tokenUrl | https://connect.squareup.com/oauth2/token | The OAuth 2.0 Token URL for Square |
Triggers
Webhook
Receive and validate webhook requests from Square for webhooks you configure. | key: squareWebhookTrigger
Data Sources
Select Bank Accounts
List and select from all of the bank accounts linked to a Square account. | key: selectBankAccounts | type: picklist
| Input | Notes |
|---|---|
Cursor string cursor | A pagination cursor returned by a previous call to this endpoint. |
Limit string limit | The maximum number of results to be returned in a single page. |
Location ID string location_id | The ID of the location to retrieve details for. |
Square Connection connection / Required squareConnection |
Select Catalog
List and select from all of the catalog objects of the specified types. | key: selectCatalog | type: picklist
| Input | Default | Notes |
|---|---|---|
Catalog Version string catalogVersion | 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. | |
Cursor string cursor | A pagination cursor returned by a previous call to this endpoint. | |
Square Connection connection / Required squareConnection | ||
Types string types | ITEM, ITEM_VARIATION, CATEGORY, DISCOUNT, TAX, MODIFIER, MODIFIER_LIST, IMAGE | 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. |
Select Customers
List and select from all customer profiles associated with a Square account. | key: selectCustomers | type: picklist
| Input | Notes |
|---|---|
Cursor string cursor | A pagination cursor returned by a previous call to this endpoint. |
Limit string limit | The maximum number of results to be returned in a single page. |
Sort Field string sortField | Field to sort the customers on. |
Sort Order string sortOrder | Order to sort the customers. |
Square Connection connection / Required squareConnection |
Select Locations
List and select from all of the seller's locations. | key: selectLocations | type: picklist
| Input | Notes |
|---|---|
Square Connection connection / Required squareConnection |
Select Merchants
List and select from all of the seller's merchants. | key: selectMerchants | type: picklist
| Input | Notes |
|---|---|
Square Connection connection / Required squareConnection |
Select Webhook Event Types
List all webhook event types that can be subscribed to. | key: selectWebhookEventTypes | type: picklist
| Input | Notes |
|---|---|
API Version string api_version | The API version to be used in the request. |
Square Connection connection / Required squareConnection |
Actions
Batch Change Inventory
Applies adjustments and counts to the provided item quantities. | key: batchChangeInventory
| Input | Default | Notes |
|---|---|---|
Inventory Changes code / Required 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. | |
Idempotency Key string idempotencyKey | ||
Ignore Unchanged Counts boolean ignoreUnchangedCounts | false | |
Square Connection connection / Required squareConnection |
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. | key: batchDeleteCatalogObjects
| Input | Default | Notes |
|---|---|---|
Object IDs code / Required objectIds | The IDs of the CatalogObjects to be retrieved. | |
Square Connection connection / Required squareConnection |
Batch Retrieve Catalog Objects
Returns a set of objects based on the provided ID. | key: batchRetrieveCatalogObjects
| Input | Default | Notes |
|---|---|---|
Catalog Version string catalogVersion | 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 boolean / Required includeDeletedObjects | false | If true, deleted objects will be included in the results. |
Include Related Objects boolean / Required includeRelatedObjects | false | If true, the response will include additional objects that are related to the requested objects. |
Object IDs code / Required objectIds | The IDs of the CatalogObjects to be retrieved. | |
Square Connection connection / Required squareConnection |
Batch Retrieve Inventory Counts
Returns current counts for the provided CatalogObjects at the requested Locations. | key: batchRetrieveInventoryCounts
| Input | Default | Notes |
|---|---|---|
Catalog Object IDs code / Required catalogObjectIds | The filter to return results by CatalogObject ID. | |
Cursor string cursor | A pagination cursor returned by a previous call to this endpoint. | |
Limit string limit | The maximum number of results to be returned in a single page. | |
Location IDs code / Required locationIds | Array of location IDs. These IDs will be used to filter the results to specific locations. | |
Square Connection connection / Required squareConnection | ||
States code states | The filter to return results by InventoryState. | |
Updated After string updatedAfter | The filter to return results with their calculated_at value after the given time as specified in an RFC 3339 timestamp. |
Batch Retrieve Orders
Retrieves a set of orders by their IDs. | key: batchRetrieveOrders
| Input | Default | Notes |
|---|---|---|
Location ID string / Required locationId | The ID of the location to retrieve details for. | |
Order IDs code / Required orderIds | The IDs of the orders to retrieve. A maximum of 100 orders can be retrieved per request. | |
Square Connection connection / Required squareConnection |
Batch Upsert Catalog Objects
Creates or updates up to 10,000 target objects based on the provided list of objects. | key: batchUpsertCatalogObjects
| Input | Default | Notes |
|---|---|---|
Batches code / Required 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. | |
Idempotency Key string idempotencyKey | ||
Square Connection connection / Required squareConnection |
Cancel Invoice
Cancel an invoice. | key: cancelInvoice
| Input | Notes |
|---|---|
Invoice ID string / Required invoiceId | The ID of the invoice to retrieve. |
Square Connection connection / Required squareConnection | |
Version string version |
Cancel Payment
Cancels (voids) a payment. | key: cancelPayment
| Input | Notes |
|---|---|
Payment ID string / Required paymentId | A unique ID for the desired payment. |
Square Connection connection / Required squareConnection |
Clone Order
Creates a new order, in the DRAFT state, by duplicating an existing order. | key: cloneOrder
| Input | Notes |
|---|---|
Idempotency Key string idempotencyKey | |
Order ID string / Required orderId | The ID of the order to retrieve. |
Square Connection connection / Required squareConnection | |
Version string version |
Complete Payment
Completes (captures) a payment. | key: completePayment
| Input | Notes |
|---|---|
Payment ID string / Required paymentId | A unique ID for the desired payment. |
Square Connection connection / Required squareConnection | |
Version Token string versionToken | Used for optimistic concurrency. This token identifies the current Payment version. |
Create Customer
Create a new customer profile. | key: createCustomer
| Input | Default | Notes |
|---|---|---|
Address code address | Address in JSON format | |
Birthday string birthday | ||
Company Name string companyName | ||
Email Address string emailAddress | ||
Family Name string familyName | ||
Given Name string givenName | ||
Idempotency Key string idempotencyKey | ||
Nickname string nickname | ||
Note string note | ||
Phone Number string phoneNumber | ||
Reference Id string referenceId | ||
Square Connection connection / Required squareConnection | ||
Tax IDs code taxIds | Tax IDs in JSON format |
Create Order
Create a new order. | key: createOrder
| Input | Default | Notes |
|---|---|---|
Location ID string / Required locationId | The ID of the location to retrieve details for. | |
Order Object code / Required orderObject | The complete order object. Please refer to the Square API documentation for the structure of this object. | |
Square Connection connection / Required squareConnection |
Create Payment
Creates a payment using the provided source. | key: createPayment
| Input | Default | Notes |
|---|---|---|
Payment Data code / Required paymentData | The payment data object containing all necessary information for creating the payment. | |
Square Connection connection / Required squareConnection |
Create Team Member
Create a new team member. | key: createTeamMember
| Input | Default | Notes |
|---|---|---|
Idempotency Key string idempotencyKey | ||
Square Connection connection / Required squareConnection | ||
Team Member code / Required teamMember | The data which will be used to create the TeamMember object. |
Create Webhook Subscription
Creates a webhook subscription. | key: createWebhookSubscription
| Input | Default | Notes |
|---|---|---|
Idempotency Key string idempotencyKey | ||
Square Connection connection / Required squareConnection | ||
Webhook Subscription code webhookSubscription | 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. | key: deleteCatalogObject
| Input | Notes |
|---|---|
Object ID string objectId | The object ID of any type of catalog objects to be retrieved. |
Square Connection connection / Required squareConnection |
Delete Customer
Delete a customer profile from a business. | key: deleteCustomer
| Input | Notes |
|---|---|
Customer ID string / Required customerId | The ID of the customer to retrieve details for. |
Square Connection connection / Required squareConnection | |
Version string version |
Delete Instance Webhooks
Delete all webhooks that point to a flow in this instance | key: deleteInstanceWebhooks
| Input | Notes |
|---|---|
Square Connection connection / Required squareConnection |
Delete Invoice
Delete an invoice. | key: deleteInvoice
| Input | Notes |
|---|---|
Invoice ID string / Required invoiceId | The ID of the invoice to retrieve. |
Square Connection connection / Required squareConnection | |
Version string version |
Delete Webhook Subscription
Deletes a webhook subscription. | key: deleteWebhookSubscription
| Input | Notes |
|---|---|
Subscription ID string / Required deleteSubscriptionId | The ID of the Subscription to delete. |
Square Connection connection / Required squareConnection |
Get Invoice
Retrieve an invoice by its ID. | key: getInvoice
| Input | Notes |
|---|---|
Invoice ID string / Required invoiceId | The ID of the invoice to retrieve. |
Square Connection connection / Required squareConnection |
Get Payment
Retrieves details for a specific payment. | key: getPayment
| Input | Notes |
|---|---|
Payment ID string / Required paymentId | A unique ID for the desired payment. |
Square Connection connection / Required squareConnection |
Get Payment Refund
Retrieves a specific refund using the refund_id. | key: getPaymentRefund
| Input | Notes |
|---|---|
Refund ID string / Required refundId | The unique ID for the desired PaymentRefund. |
Square Connection connection / Required squareConnection |
List Catalog
Returns a list of all CatalogObjects of the specified types in the catalog. | key: listCatalog
| Input | Default | Notes |
|---|---|---|
Catalog Version string catalogVersion | 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. | |
Cursor string cursor | A pagination cursor returned by a previous call to this endpoint. | |
Square Connection connection / Required squareConnection | ||
Types string types | ITEM, ITEM_VARIATION, CATEGORY, DISCOUNT, TAX, MODIFIER, MODIFIER_LIST, IMAGE | 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. |
List Customers
List customer profiles associated with a Square account. | key: listCustomers
| Input | Notes |
|---|---|
Cursor string cursor | A pagination cursor returned by a previous call to this endpoint. |
Limit string limit | The maximum number of results to be returned in a single page. |
Sort Field string sortField | Field to sort the customers on. |
Sort Order string sortOrder | Order to sort the customers. |
Square Connection connection / Required squareConnection |
List Invoices
Returns a list of invoices for a given location. | key: listInvoices
| Input | Notes |
|---|---|
Cursor string cursor | A pagination cursor returned by a previous call to this endpoint. |
Limit string limit | The maximum number of results to be returned in a single page. |
Location ID string / Required locationId | The ID of the location to retrieve details for. |
Square Connection connection / Required squareConnection |
List Locations
List all of the seller's locations, including those with an inactive status. | key: listLocations
| Input | Notes |
|---|---|
Square Connection connection / Required squareConnection |
List Payment Refunds
Retrieves a list of refunds for the account making the request. | key: listPaymentRefunds
| Input | Notes |
|---|---|
Begin Time text / Required beginTime | Return objects modified after this timestamp, in RFC 3339 format. |
Cursor string cursor | A pagination cursor returned by a previous call to this endpoint. |
End Time string endTime | 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. |
Limit string limit | The maximum number of results to be returned in a single page. |
Location ID string / Required locationId | The ID of the location to retrieve details for. |
Sort Order string sortOrder | Order to sort the customers. |
Source Type string sourceType | If provided, only returns refunds whose payments have the indicated source type. |
Square Connection connection / Required squareConnection | |
Status string status | If provided, only refunds with the given status are returned. |
List Payments
Retrieves a list of payments taken by the account making the request. | key: listPayments
| Input | Notes |
|---|---|
Begin Time text / Required beginTime | Return objects modified after this timestamp, in RFC 3339 format. |
Card Brand string cardBrand | The brand of the payment card (for example, VISA). |
Cursor string cursor | A pagination cursor returned by a previous call to this endpoint. |
End Time string endTime | 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. |
Last 4 digits of Card string last4 | The last four digits of a payment card. |
Limit string limit | The maximum number of results to be returned in a single page. |
Location ID string / Required locationId | The ID of the location to retrieve details for. |
Sort Order string sortOrder | Order to sort the customers. |
Square Connection connection / Required squareConnection | |
Total string total | The exact amount in the total_money for a payment. |
List Webhook Subscriptions
Lists all webhook subscriptions owned by your application. | key: listWebhookSubscriptions
| Input | Default | Notes |
|---|---|---|
Cursor string cursorSubscriptions | A pagination cursor returned by a previous call to this endpoint. | |
Include Disabled boolean includeDisabled | false | Includes disabled Subscriptions. By default, all enabled Subscriptions are returned. |
Limit string limitSubscriptions | The maximum number of results to be returned in a single page. | |
Sort Order string sortOrderSubscriptions | Sorts the returned list by when the Subscription was created with the specified order. Options: ASC, DESC | |
Square Connection connection / Required squareConnection |
Publish Invoice
Publish an invoice. | key: publishInvoice
| Input | Notes |
|---|---|
Idempotency Key string idempotencyKey | |
Invoice ID string / Required invoiceId | The ID of the invoice to retrieve. |
Square Connection connection / Required squareConnection | |
Version string version |
Raw Request
Send raw HTTP request to Square | key: rawRequest
| Input | Default | Notes | Example |
|---|---|---|---|
Data string data | The HTTP body payload to send to the URL. | {"exampleKey": "Example Data"} | |
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
File Data string Key Value List fileData | File Data to be sent as a multipart form upload. | [{key: "example.txt", value: "My File Contents"}] | |
File Data File Names string Key Value List fileDataFileNames | File names to apply to the file data inputs. Keys must match the file data keys above. | ||
Form Data string Key Value List formData | The Form Data to be sent as a multipart form upload. | [{"key": "Example Key", "value": new Buffer("Hello World")}] | |
Header string Key Value List headers | A list of headers to send with the request. | User-Agent: curl/7.64.1 | |
Max Retry Count string maxRetries | 0 | The maximum number of retries to attempt. | |
Method string / Required method | The HTTP method to use. | ||
Query Parameter string Key Value List queryParams | 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. | ||
Response Type string / Required responseType | json | The type of data you expect in the response. You can request json, text, or binary data. | |
Retry On All Errors boolean retryAllErrors | false | If true, retries on all erroneous responses regardless of type. | |
Retry Delay (ms) string retryDelayMS | 0 | The delay in milliseconds between retries. | |
Square Connection connection / Required squareConnection | |||
Timeout string timeout | The maximum time that a client will await a response to its request | 2000 | |
URL string / Required url | This is the URL to call. | /v2/locations | |
Use Exponential Backoff boolean useExponentialBackoff | false | Specifies whether to use a pre-defined exponential backoff strategy for retries. |
Refund Payment
Refunds a payment. You can refund the entire payment amount or a portion of it. | key: refundPayment
| Input | Notes |
|---|---|
Idempotency Key string idempotencyKey | |
Payment ID string / Required paymentId | A unique ID for the desired payment. |
Reason string reason | A description of the reason for the refund. |
Refund Amount code / Required refundAmount | 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. |
Square Connection connection / Required squareConnection |
Retrieve Catalog Object
Returns a single CatalogObject based on the provided ID. | key: retrieveCatalogObject
| Input | Default | Notes |
|---|---|---|
Catalog Version string catalogVersion | 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 Related Objects boolean / Required includeRelatedObjects | false | If true, the response will include additional objects that are related to the requested objects. |
Object ID string objectId | The object ID of any type of catalog objects to be retrieved. | |
Square Connection connection / Required squareConnection |
Retrieve Customer
Retrieve details for a single customer. | key: retrieveCustomer
| Input | Notes |
|---|---|
Customer ID string / Required customerId | The ID of the customer to retrieve details for. |
Square Connection connection / Required squareConnection |
Retrieve Location
Retrieves details of a specific location. | key: retrieveLocation
| Input | Notes |
|---|---|
Location ID string / Required locationId | The ID of the location to retrieve details for. |
Square Connection connection / Required squareConnection |
Retrieve Order
Retrieves an Order by its ID. | key: retrieveOrder
| Input | Notes |
|---|---|
Order ID string / Required orderId | The ID of the order to retrieve. |
Square Connection connection / Required squareConnection |
Retrieve Team Member
Retrieve a team member based on the provided ID. | key: retrieveTeamMember
| Input | Default | Notes |
|---|---|---|
Square Connection connection / Required squareConnection | ||
Team Member ID string / Required teamMemberId | TMFnLDlvT9Nfwal7 | The ID of the TeamMember to be retrieved. |
Retrieve Webhook Subscription
Retrieves a webhook subscription identified by its ID. | key: retrieveWebhookSubscription
| Input | Notes |
|---|---|
Square Connection connection / Required squareConnection | |
Subscription ID string / Required subscriptionId | 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. | key: searchCatalogItems
| Input | Default | Notes |
|---|---|---|
Category IDs code categoryIds | The category id query expression to return items containing the specified category IDs. | |
Cursor string cursor | A pagination cursor returned by a previous call to this endpoint. | |
Custom Attribute Filters code customAttributeFilters | The customer-attribute filter to return items or item variations matching the specified custom attribute expressions. | |
Enabled Location IDs code enabledLocationIds | The enabled-location query expression to return items and item variations having specified enabled locations. | |
Limit string limit | The maximum number of results to be returned in a single page. | |
Product Types code productTypes | The product types query expression to return items or item variations having the specified product types. | |
Sort Order string sortOrder | Order to sort the customers. | |
Square Connection connection / Required squareConnection | ||
Stock Levels code stockLevels | The stock-level query expression to return item variations with the specified stock levels. | |
Text Filter string textFilter | The text filter expression to return items or item variations containing specified text. |
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. | key: searchCatalogObjects
| Input | Default | Notes |
|---|---|---|
Begin Time text / Required beginTime | Return objects modified after this timestamp, in RFC 3339 format. | |
Catalog Query code / Required catalogQuery | A query to be used to filter or sort the results. If no query is specified, the entire catalog will be returned. | |
Cursor string cursor | A pagination cursor returned by a previous call to this endpoint. | |
Include Deleted Objects boolean / Required includeDeletedObjects | false | If true, deleted objects will be included in the results. |
Include Related Objects boolean / Required includeRelatedObjects | false | If true, the response will include additional objects that are related to the requested objects. |
Limit string limit | The maximum number of results to be returned in a single page. | |
Object Types text / Required objectTypes | The desired set of object types to appear in the search results. | |
Square Connection connection / Required squareConnection |
Search Customers
Search customer profiles. | key: searchCustomers
| Input | Default | Notes |
|---|---|---|
Cursor string cursor | A pagination cursor returned by a previous call to this endpoint. | |
Limit string limit | The maximum number of results to be returned in a single page. | |
Query code / Required query | The query to search for customers. Please refer to the Square API documentation for the structure and options of this query. | |
Square Connection connection / Required squareConnection |
Search Invoices
Searches for invoices from a location specified in the filter. | key: searchInvoices
| Input | Default | Notes |
|---|---|---|
Cursor string cursor | A pagination cursor returned by a previous call to this endpoint. | |
Query code / Required invoiceQuery | The query to search for invoices. Please refer to the Square API documentation for the structure and options of this query. | |
Limit string limit | The maximum number of results to be returned in a single page. | |
Square Connection connection / Required squareConnection |
Search Orders
Search all orders for one or more locations. | key: searchOrders
| Input | Default | Notes |
|---|---|---|
Cursor string cursor | A pagination cursor returned by a previous call to this endpoint. | |
Limit string limit | The maximum number of results to be returned in a single page. | |
Location IDs code / Required locationIds | Array of location IDs. These IDs will be used to filter the results to specific locations. | |
Query code / Required orderQuery | The query to search for orders. Please refer to the Square API documentation for the structure and options of this query. | |
Return Entries boolean / Required returnEntries | Flag that indicates whether the entries associated with the orders should be returned. | |
Square Connection connection / Required squareConnection |
Search Team Members
Search for team members based on given filters. | key: searchTeamMembers
| Input | Default | Notes |
|---|---|---|
Cursor string cursor | A pagination cursor returned by a previous call to this endpoint. | |
Limit string limit | The maximum number of results to be returned in a single page. | |
Search Query code / Required searchQuery | The query parameters to filter the TeamMember objects. | |
Square Connection connection / Required squareConnection |
Update Customer
Update a customer profile. | key: updateCustomer
| Input | Default | Notes |
|---|---|---|
Address code address | Address in JSON format | |
Birthday string birthday | ||
Company Name string companyName | ||
Customer ID string / Required customerId | The ID of the customer to retrieve details for. | |
Email Address string emailAddress | ||
Family Name string familyName | ||
Given Name string givenName | ||
Nickname string nickname | ||
Note string note | ||
Phone Number string phoneNumber | ||
Reference Id string referenceId | ||
Square Connection connection / Required squareConnection | ||
Tax IDs code taxIds | Tax IDs in JSON format | |
Version string version |
Update Invoice
Update an invoice. | key: updateInvoice
| Input | Default | Notes |
|---|---|---|
Invoice ID string / Required invoiceId | The ID of the invoice to retrieve. | |
Square Connection connection / Required squareConnection | ||
Update Invoice code / Required updateInvoiceInput | The data to update an invoice. Please refer to the Square API documentation for the structure and options of this update. |
Update Location
Updates a location associated with a Square account. | key: updateLocation
| Input | Default | Notes |
|---|---|---|
Location ID string / Required locationId | The ID of the location to retrieve details for. | |
Location Update code / Required locationUpdate | The data which will be used to update the Location object. | |
Square Connection connection / Required squareConnection |
Update Order
Updates an open order by adding, replacing, or deleting fields. | key: updateOrder
| Input | Default | Notes |
|---|---|---|
Fields to Clear code fieldsToClear | The dot notation paths of fields to clear. For example, line_items[uid].note. This is optional. | |
Idempotency Key string idempotencyKey | ||
Order ID string / Required orderId | The ID of the order to retrieve. | |
Order Object code / Required orderObject | The complete order object. Please refer to the Square API documentation for the structure of this object. | |
Square Connection connection / Required squareConnection |
Update Payment
Updates a payment with the APPROVED status. | key: updatePayment
| Input | Default | Notes |
|---|---|---|
Payment code / Required 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). | |
Payment ID string / Required paymentId | A unique ID for the desired payment. | |
Square Connection connection / Required squareConnection |
Update Team Member
Update a team member. | key: updateTeamMember
| Input | Default | Notes |
|---|---|---|
Square Connection connection / Required squareConnection | ||
Team Member code / Required teamMember | The data which will be used to create the TeamMember object. | |
Team Member ID string / Required teamMemberId | TMFnLDlvT9Nfwal7 | The ID of the TeamMember to be retrieved. |
Update Webhook Subscription
Updates a webhook subscription. | key: updateWebhookSubscription
| Input | Default | Notes |
|---|---|---|
Square Connection connection / Required squareConnection | ||
Subscription ID string / Required subscriptionId | The ID of the Subscription to retrieve. | |
Webhook Subscription code / Required updatedWebhookSubscription | The updated webhook subscription object. It should include properties that you want to update. |
Upsert Catalog Object
Creates a new or updates the specified CatalogObject. | key: upsertCatalogObject
| Input | Default | Notes |
|---|---|---|
Catalog Object code / Required catalogObject | A CatalogObject to be created or updated. | |
Idempotency Key string idempotencyKey | ||
Square Connection connection / Required squareConnection |