Square Connector
Quickly build integrations connecting your B2B SaaS to Square.
About the Square Connector
Manage payments, customers, orders, invoices, and team members in Square.
Actions
| Action Name | Action Description |
|---|---|
| List Customers | Lists customer profiles associated with a Square account. |
| Retrieve Customer | Retrieves details for a single customer. |
| Update Customer | Updates a customer profile. |
| Create Customer | Creates a new customer profile. |
| Search Customers | Searches for customer profiles. |
| Delete Customer | Deletes a customer profile from a business. |
| Create Team Member | Creates a new team member. |
| Search Team Members | Searches for team members based on the given filters. |
| Retrieve Team Member | Retrieves a team member based on the provided ID. |
| Update Team Member | Updates a team member. |
| List Locations | Lists all of the seller's locations, including those with an inactive status. |
| Retrieve Location | Retrieves details of a specific location. |
| Update Location | Updates a location associated with a Square account. |
| Raw Request | Sends a raw HTTP request to the Square API. |
| List Invoices | Returns a list of invoices for a given location. |
| Search Invoices | Searches for invoices from a location specified in the filter. |
| Get Invoice | Retrieves an invoice by its ID. |
| Update Invoice | Updates an invoice. |
| Publish Invoice | Publishes an invoice. |
| Cancel Invoice | Cancels an invoice. |
| Delete Invoice | Deletes an invoice. |
| Search Orders | Searches all orders for one or more locations. |
| Retrieve Order | Retrieves an order by its ID. |
| Batch Retrieve Orders | Retrieves a set of orders by their IDs. |
| Create Order | Creates a new order. |
| Update Order | Updates an open order by adding, replacing, or deleting fields. |
| Clone Order | Creates a new order, in the DRAFT state, by duplicating an existing order. |
| List Catalog | Returns a list of all catalog objects of the specified types in the catalog. |
| 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. |
| Search Catalog Objects | Searches for catalog objects 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. |
| Batch Retrieve Catalog Objects | Returns a set of catalog objects based on the provided IDs. |
| Upsert Catalog Object | Creates or updates the specified catalog object. |
| Batch Upsert Catalog Objects | Creates or updates up to 10,000 catalog objects based on the provided list of objects. |
| Retrieve Catalog Object | Returns a single catalog object based on the provided ID. |
| Delete Catalog Object | Deletes a single catalog object based on the provided ID and returns the set of successfully deleted IDs in the response. |
| Batch Delete Catalog Objects | Deletes a set of catalog objects based on the provided list of target IDs and returns a set of successfully deleted IDs in the response. |
| Batch Change Inventory | Applies adjustments and counts to the provided item quantities. |
| Batch Retrieve Inventory Counts | Returns current inventory counts for the provided catalog objects at the requested locations. |
| List Payments | Retrieves a list of payments taken by the account making the request. |
| Get Payment | Retrieves details for a specific payment. |
| Update Payment | Updates a payment with the APPROVED status. |
| Create Payment | Creates a payment using the provided source. |
| Complete Payment | Completes (captures) a payment. |
| Cancel Payment | Cancels (voids) a payment. |
| Refund Payment | Refunds a payment, either the entire amount or a portion of it. |
| Get Payment Refund | Retrieves a specific refund using the refund_id. |
| List Payment Refunds | Retrieves a list of refunds for the account making the request. |
| List Webhook Subscriptions | Lists all webhook subscriptions owned by your application. |
| Retrieve Webhook Subscription | Retrieves a webhook subscription identified by its ID. |
| Create Webhook Subscription | Creates a webhook subscription. |
| Update Webhook Subscription | Updates a webhook subscription. |
| Delete Webhook Subscription | Deletes a webhook subscription. |
| Delete Instance Webhooks | Deletes all webhooks that point to a flow in this instance. |
| Create Job | Creates a job in a seller account with a title and tip eligibility. |
| List Jobs | Lists jobs in a seller account, sorted by title in ascending order. |
| Retrieve Job | Retrieves a specified job by ID. |
| Update Job | Updates the title or tip eligibility of a job. Changes propagate to all job assignments, shifts, and wage settings. |
Triggers
| Trigger Name | Trigger Description |
|---|---|
| Webhook | Receive and validate webhook requests from Square for manually configured webhook subscriptions. |
| New and Updated Payments | Fetches Square payments created or updated since the last poll on a recurring schedule, separated into new and updated buckets. |