SquareUp API
Arcade Unoptimized
Tools that enable LLMs to interact directly with the squareup API.
286tools
Square (SquareupApi) Toolkit
Square is a commerce platform for payments, point-of-sale, and business management. This toolkit gives LLMs full programmatic access to the Square API — covering every major domain from payments and orders to team management and loyalty.
Capabilities
- Payments, Refunds & Checkout: Create, update, complete, cancel, and refund payments; generate payment links; manage Terminal checkouts, actions, and Interac refunds; handle disputes and evidence submission.
- Catalog & Inventory: Batch upsert, search, and delete catalog objects and items; manage modifier lists and taxes; track inventory counts, adjustments, transfers, and physical counts between locations.
- Orders, Invoices & Subscriptions: Create, update, search, and pay orders; manage draft and published invoices with attachments; enroll customers in subscription plans with support for pause, resume, cancel, and plan swaps.
- Customers, Loyalty & Gift Cards: CRUD operations on customer profiles and groups (bulk and individual); manage loyalty accounts, points, promotions, and rewards; create, activate, link, and unlink gift cards.
- Team, Labor & Scheduling: Create and manage team members, jobs, wages, timecards, break types, workweek configs, and scheduled shifts (including bulk publish); manage bookings and booking profiles with custom attributes.
- Merchant & Platform Operations: Manage locations, custom attributes (for bookings, orders, customers, locations, and merchants), webhooks, OAuth tokens, payouts, bank accounts, Square Online site snippets, Apple Pay domain activation, and sales channels.
OAuth
This toolkit uses OAuth 2.0 via Square for authorization. See the Square auth provider docs for configuration details.
Available tools(286)
286 of 286 tools
| Tool name | Description | Secrets | |
|---|---|---|---|
Accept the loss on a dispute and update its status to ACCEPTED.
This tool should be called when you need to accept the loss on a dispute for a transaction. It updates the dispute state to ACCEPTED and returns the disputed amount to the cardholder. Square debits the corresponding amount from the seller's account. Use this when a dispute resolution is finalized, and the seller agrees to the loss. | |||
Add points to a loyalty account for a purchase.
This tool adds loyalty points to a customer's account following a purchase. It can be used with or without the Orders API. If using the Orders API, provide the `order_id` for automatic point calculation based on the program and promotions. If not, manually compute and provide the `points` to add. | |||
Activates a domain for use with Apple Pay and Square.
Use this tool to activate a domain for Apple Pay on the Web with Square. It performs a validation to ensure the domain is Apple Pay enabled, allowing platforms to bulk activate Apple Pay for their merchants. Ensure a valid domain verification file is hosted as per the guidelines. | |||
Adds a card on file to an existing merchant.
This tool is used to store a new card on file for an existing merchant, facilitating future transactions. It provides confirmation once the card is successfully added.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | |||
Adds a customer to a specified group.
Use this tool to assign a customer to a specific group using their customer ID and the group ID. This helps in categorizing customers into different groups for better management. | |||
Add or update a snippet on a Square Online site.
This tool adds a new snippet to or updates an existing snippet on a Square Online site's `head` element. It excludes checkout pages and requires the site's ID. Use ListSites to find site IDs. | |||
Manually adjust loyalty points for a buyer's account.
Use this tool to manually add or subtract loyalty points from a buyer's account when automatic accumulation is not applied. Ideal for scenarios requiring manual point corrections. | |||
Apply batch adjustments to inventory quantities.
Use this tool to apply inventory adjustments and counts to item quantities. Returns updated quantities on success, or a list of errors if the operation fails.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | |||
Batch create or update up to 10,000 catalog objects.
The tool creates or updates catalog objects in batches, each containing up to 1,000 objects. It's an all-or-nothing operation for each batch, meaning if one object in a batch is invalid, the entire batch fails. The tool ensures consistency by processing one update request at a time per seller account.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | |||
Create multiple customer profiles in bulk.
Use this tool to create multiple customer profiles for a business at once. You need to provide at least one identifying value for each customer, such as given name, family name, company name, email address, or phone number.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | |||
Create multiple team members in bulk.
Use this tool to create multiple team member records at once. It processes each creation individually and returns details for successful operations, along with error information for any failures.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | |||
Create multiple vendor profiles for suppliers.
Use this tool to create one or more vendor profiles, representing suppliers for a seller, in bulk. Ideal for onboarding multiple vendors at once.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | |||
Bulk delete custom attributes for bookings.
Use this tool to delete multiple custom attributes associated with bookings in bulk. Ensure the proper OAuth permissions are set: 'APPOINTMENTS_WRITE' for buyer-level and both 'APPOINTMENTS_ALL_WRITE' and 'APPOINTMENTS_WRITE' for seller-level. Requires an active subscription to 'Appointments Plus' or 'Appointments Premium' for seller-level actions.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | |||
Deletes multiple customer profiles at once.
Use this tool to remove several customer profiles in a single action by providing their IDs. It returns a map of responses detailing the outcome for each profile. | |||
Delete custom attributes for multiple locations at once.
This tool deletes custom attributes for locations in bulk. It is used when the visibility setting is 'VISIBILITY_READ_WRITE_VALUES', allowing the deletion of attributes owned by other applications.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | |||
Bulk delete custom attributes for a merchant.
Use this tool to delete custom attributes for a merchant in bulk. It can only delete attributes with 'VISIBILITY_READ_WRITE_VALUES' if owned by another application.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | |||
Perform bulk deletion of custom attributes from orders.
Use this tool to delete multiple custom attributes from one or more orders in bulk. It processes a map of delete requests and returns a map of responses, each paired with a request ID.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | |||
Publish multiple scheduled shifts in bulk.
Use this tool to publish between 1 to 100 scheduled shifts at once. It processes a map of individual publish requests and provides corresponding responses. Ensure all shifts have start and end times within a two-week window.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | |||
Retrieve multiple bookings using booking IDs.
This tool retrieves a list of bookings by their IDs. It requires appropriate OAuth scopes for buyer or seller level permissions. | |||
Retrieve multiple customer profiles using IDs.
Use this tool to fetch detailed customer profiles by providing a list of customer IDs. It is useful for applications needing to access multiple customer data at once. | |||
Schedule a plan variation swap for multiple subscriptions.
This tool schedules a swap of plan variations for all active subscriptions under a specified plan variation. It is used when there is a need to change the plan variation for multiple subscriptions simultaneously. | |||
Update multiple team members in bulk.
This tool updates multiple team member objects at once. It should be called when you need to perform bulk updates to team members. While processing, if any updates fail, the tool still returns the updated members along with specific error details for the failed attempts.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | |||
Update multiple vendor records simultaneously.
Use this tool to update details of multiple vendors at once. It modifies existing vendor records that are suppliers to a seller, streamlining vendor management tasks.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | |||
Bulk upserts custom attributes for bookings.
Use this tool to update or insert multiple custom attributes for bookings at once. Requires specific OAuth permissions depending on whether you operate at the buyer or seller level. Ensure sellers are subscribed to necessary service tiers.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | |||
Bulk create or update custom attributes for customer profiles.
Use this tool to set or update the value of custom attributes for multiple customer profiles in a Square seller account. It handles up to 25 upsert requests, returning responses mapped to their request IDs. Useful for managing multiple custom attributes at once.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. |
Page 1 of 12(25 of 286)
Get Building
Last updated on