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.

Bulk create or update custom attributes for multiple locations. This tool is used to create or update custom attributes for multiple locations in a Square seller account. It handles multiple upsert requests simultaneously, allowing you to efficiently manage location-specific data. 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 create or update of order custom attributes. This tool allows for creating or updating order custom attributes in bulk. It can handle up to 25 requests at once, each identified uniquely, and provides responses for each request. It is used to manage custom attributes based on definitions in a Square seller account, and may also delete attributes. Use this when multiple order custom attributes need simultaneous updating or creation. 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.

Calculate loyalty points a buyer can earn from a purchase. Use this tool to determine the number of loyalty points to reward a buyer after a purchase. Provide either the `order_id` or `transaction_amount_money` to calculate points based on the order or purchase amount, respectively. Points calculation considers the base loyalty program, and possibly a loyalty promotion if applicable.

Cancel an existing booking. Call this tool to cancel a booking using its unique ID. Requires specific OAuth permissions depending on user level. For seller-level cancellations, an Appointments Plus or Premium subscription is necessary.

Cancel an invoice to prevent further transactions. This tool cancels an invoice, ensuring that no payments can be collected. It cannot be used for invoices in the `DRAFT`, `PAID`, `REFUNDED`, `CANCELED`, or `FAILED` states.

Cancels an active or scheduled loyalty promotion early. Use this tool to cancel a loyalty promotion that is currently active or scheduled, either earlier than its end date or if no end date is specified.

Cancel or void an approved payment. Use this tool to cancel a payment that has an APPROVED status. Ideal for reversing payments that should not proceed.

Cancel a payment by idempotency key when status is unknown. Use this tool to cancel a payment when a CreatePayment request status is uncertain, typically due to network issues. Provide the same idempotency key used in the original CreatePayment request. If no payment is found, the tool confirms no action was taken.

Cancel an active subscription at the end of the billing period. This tool schedules a cancellation for an active subscription, setting the cancellation date to the end of the current billing cycle. After this date, the subscription changes from ACTIVE to CANCELED.

Cancel a terminal action request if possible. This tool cancels a terminal action request with SquareUp if the current status allows it. Use it when you need to abort a terminal action that is still pending or in progress.

Cancel a terminal checkout request if possible. Use this tool to cancel an ongoing Terminal checkout request if its status allows for cancellation.

Cancel a terminal refund request by its ID. Use this tool to cancel a terminal refund request when the status allows for cancellation. Provide the refund request ID to execute the cancellation.

Cancel a transfer order in progress for inventory locations. Use this tool to cancel a transfer order that is in either STARTED or PARTIALLY_RECEIVED status. This is useful in situations where items are no longer needed at the destination, the source location requires the inventory, or if the order was created by mistake. Cancelling the order will update inventory levels and trigger a transfer_order.updated webhook event.

Change the billing anchor date for a subscription. Use this tool to modify the billing anchor date for a specific subscription. This can be useful for adjusting billing cycles and ensuring proper timing for subscription charges.

Clone an existing order as a draft. This tool creates a new order in the DRAFT state by duplicating an existing order. It copies core fields such as line items, taxes, and discounts from the original order.

Complete an approved payment using Squareup. Use this tool to complete or capture a payment with an 'APPROVED' status, finalizing the transaction.

Create a new booking for a service. This tool creates a booking using specified details like location, start time, team member, and service variation. Ideal for scheduling appointments with buyer or seller permissions, ensuring necessary subscriptions are met. 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 a new BreakType template for a location. This tool creates a new BreakType, which is a template for establishing Break objects. Required inputs include location ID, break name, expected duration, and payment status. Note that each location can have a maximum of three BreakType instances.

Creates a new customer for a business in Square. This tool is used to create a new customer profile for a business in Square. You must provide at least one of the following details: 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.

Creates a new customer group for a business. Use this tool to create a new customer group by specifying the group's name. It should be called when a business needs to organize customers into a new group for targeted marketing or management purposes.

Enroll a customer in a subscription plan. This tool enrolls a customer in a subscription, either charging a card on file or sending an invoice to the customer's email. The subscription can start immediately or on a specified start date and is linked to a specific location. 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 a draft invoice for an order using Squareup. This tool creates a draft invoice for an order via Squareup. The invoice remains in draft status until published, at which point it can be emailed to the customer or a card on file can be charged. 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 and register digital or physical gift cards. This tool creates a digital or registers a physical gift card in a pending state. To activate the gift card for purchases, further action is needed using CreateGiftCardActivity for activation or RefundPayment for refunds. 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.

Creates a gift card activity to manage gift card balance or state. Use this tool to create activities such as activation for gift cards, to manage their balance or state. 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 a job for a seller account. This tool is used to create a job in a seller's account, specifying the job title and its tip eligibility. It should be called when you need to define a new job role for team members in a seller's business operations.

Create a loyalty account for a buyer. Create a loyalty account by providing a program ID and buyer's phone number mapping. 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 a new loyalty promotion for a program. This tool creates a loyalty promotion within a specified loyalty program, allowing buyers to earn additional points. It sets the promotion to either 'ACTIVE' or 'SCHEDULED' based on the available time setting. A program can have up to 10 active or scheduled promotions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. 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. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Create a loyalty reward by locking points for a customer. This tool creates a loyalty reward by using a specified reward tier ID to lock points. Optionally, it can add the reward and related discount to an existing order if an order ID is provided. After creation, the points are locked and unavailable for redemption.

Create a new location for sales and configuration. This tool creates a new location using the Square Locations API. It's useful for setting up separate configurations for receipt layouts, item prices, and sales reports. Ideal for developers integrating Square with their applications to manage distinct sales activities. 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.

Creates a new order for purchase with product details. Use this tool to create a new order, specifying products and settings for purchase. This tool is ideal for initiating a purchase order that includes specific product information. 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 a payment using credit/debit card or other sources. This tool is used to create a payment through a specified source, such as a credit/debit card or to record an external payment. It returns the details of the payment created. 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 a Square-hosted checkout page for payments. Use this tool to generate a Square-hosted payment link which can be shared with buyers to facilitate payments for goods and services. Ideal for businesses needing a simple online payment solution. 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 a scheduled shift with draft shift details. Use this tool to create a scheduled shift by providing necessary draft shift details such as location ID, job ID, and start and end times. It returns the details of the created shift. 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.

Generate a DeviceCode for Square Terminal login. Creates a code for logging into a Square Terminal device in connected terminal mode. Useful for setting up devices for point-of-sale operations. 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 a new team member with given and family names. This tool is used to create a single TeamMember object by providing the required given name and family name. It returns the created TeamMember object upon success. 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 a timecard for a team member's workday. This tool creates a new timecard representing a full workday for a specified team member. Use it when you need to log work hours for employees. Ensure no existing open timecard for the member, that the start time isn't future-dated, and that it doesn't overlap with other timecards. 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 and send a terminal action request to a device. This tool creates a terminal action request and sends it to the specified device using the SquareUp API. It should be called when you need to initiate an action on a terminal device. 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 a Terminal checkout request for payment. Initiates a Terminal checkout request to process a payment on a specified device using Square's Terminal API. 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.

Creates a refund request for Interac payments on Square Terminal. This tool creates a request to refund an Interac payment completed on a Square Terminal. It is specifically for Interac debit card payments in Canada. For other types of refunds, use the Refunds API. 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 a draft transfer order between locations. This tool creates a new transfer order in DRAFT status to move CatalogItemVariations between different locations within a Square account. It should be called when there's a need to initiate the transfer of items, allowing you to add or remove items, modify quantities, or update shipping information before finalizing. 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 a vendor for a supplier to a seller. This tool creates a new vendor object to represent a supplier in the system. Use it when you need to add or register a vendor for business operations. 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.

Creates a webhook subscription. Use this tool to establish a webhook subscription for receiving event notifications from the service.

Deletes a custom attribute from a booking. Use this tool to delete a specific custom attribute from a booking. Requires appropriate OAuth permissions depending on user level. Seller-level usage requires a subscription to Appointments Plus or Appointments Premium.

Deletes a booking's custom attribute definition. Use this tool to delete a custom attribute definition for bookings. Ensure appropriate OAuth scopes are set: 'APPOINTMENTS_WRITE' for buyer-level permissions, or 'APPOINTMENTS_ALL_WRITE' and 'APPOINTMENTS_WRITE' for seller-level permissions. Seller-level permissions require a subscription to Appointments Plus or Premium.

Deletes an existing BreakType. Use this tool to delete an existing BreakType, even if it is referenced in a Shift.

Deletes catalog items and their children by IDs. Use this tool to delete a set of catalog items by providing their IDs. Deletion is cascading, removing both the items and their associated variations. The tool succeeds even if only part of the requested deletions can be processed, returning only the successfully deleted item IDs.

Delete a catalog object and its children by ID. This tool deletes a catalog object in the Squareup catalog using the provided ID. The deletion is cascading, removing all child objects as well. Only one delete request is processed at a time per seller account.

Delete a customer custom attribute definition from Square. Deletes a custom attribute definition linked to customer profiles from a Square seller account, removing it from all associated customer profiles. Only the owner of the definition can perform this action.

Deletes a custom attribute from a customer profile. Use this tool to delete a custom attribute associated with a customer profile. Applicable when removing attributes with visibility set to READ_WRITE.

Deletes a customer group by its ID. Use this tool to delete a customer group in your database by specifying the group ID. It confirms the successful deletion of the group.

Delete a customer profile from a business system. Use this tool to delete a customer profile from a business's records. It requires the customer ID, especially if the profile was created by merging existing profiles.

Delete a draft transfer order and trigger webhook event. Use this tool to delete a transfer order in DRAFT status. Only applicable to orders that have not yet been started. A webhook event 'transfer_order.deleted' is triggered upon deletion.

Delete a draft invoice and change order status to CANCELED. This tool deletes a specified draft invoice. Once deleted, the associated order status changes to CANCELED. It cannot delete a published invoice, including those scheduled for processing.

Delete a custom attribute definition from a location. This tool deletes a location-related custom attribute definition from a Square seller account. It also removes the corresponding custom attribute from all locations. Only the definition owner can perform this action.

Deletes a loyalty reward and restores points to the account. This tool deletes a specified loyalty reward, restoring the corresponding points to the user's account. It also updates any associated order to remove the reward and related discounts, if an order ID was specified upon reward creation. Cannot be used on rewards that have been redeemed.

Delete a custom attribute definition for a Square merchant. Deletes a merchant-specific custom attribute definition from a Square seller account, including the associated custom attribute. Only the definition owner can perform this deletion.

Delete a custom attribute from an order profile. Use this tool to delete a custom attribute associated with an order. Ensure that the visibility setting is 'VISIBILITY_READ_WRITE_VALUES' for attributes owned by other applications.

Delete a custom attribute definition from an order. This tool deletes an order-related custom attribute definition from a Square seller account. Only the definition owner has the permission to perform this action.

Deletes a specified payment link. Use this tool to delete a payment link by its ID when it is no longer needed or was created in error.

Delete a snippet from a Square Online site. Use this tool to remove a snippet from a specified Square Online site. Useful when you need to update or clean up content on a site. Make sure to retrieve the site IDs using the ListSites API beforehand.

Delete a scheduled action for a subscription. Use this tool to delete a specific scheduled action related to a subscription when changes or cancellations are needed.

Delete a specific timecard entry. This tool deletes a specified timecard entry using its unique identifier. Use it when a timecard needs to be permanently removed from the system.

Deletes a specified webhook subscription. Use this tool to delete an existing webhook subscription by providing the subscription ID. It should be called when there is a need to remove a webhook subscription.

Disable a credit card to prevent further charges. Use this tool to disable a credit card, which will prevent any further updates or charges on the card. Attempting to disable an already disabled card is allowed but will have no effect.

Disable events to prevent them from being searchable. Use this tool to disable events, ensuring they cannot be searched. Useful for controlling event visibility during specific time periods.

Dismiss a Terminal action request if permitted. This tool dismisses a Terminal action request when the status and type allow it. Use it for canceling or dismissing actions on a Square Terminal. Refer to the Square documentation for more about linking and dismissing actions.

Dismiss a Terminal checkout request. Use this tool to dismiss a Terminal checkout request when the status and type allow dismissal.

Dismiss a Terminal refund request. Use this tool to dismiss a Terminal refund request if it's allowable based on the status and type of the request.

Enable events to make them searchable. This tool should be called to enable events, allowing them to be searchable from this point onward. Only events that occur while in the enabled state will be searchable.

Retrieve historical inventory changes and adjustments. Use this tool to access historical physical counts and inventory adjustments based on specific filter criteria. The results are paginated and sorted by the `occurred_at` timestamp in ascending order, providing a comprehensive log of inventory changes.

Retrieve a list of disputes for an account. Use this tool to obtain a list of disputes related to a specific account. It is useful for managing and reviewing disputes.

Retrieve details of a bank account linked to a Square account. Use this tool to obtain detailed information about a specific bank account associated with a Square account by providing the bank account ID.

Fetches bank account details using a V1 ID. Use this tool to retrieve details of a bank account by providing the V1 bank account ID. Useful for obtaining specific bank account information from the Squareup service.

Retrieve details of a specific BreakType by ID. Use this tool to get information about a specific BreakType using its unique ID. It should be called when details about a particular break type in the system are required.

Retrieve detailed information for a specific catalog item. This tool retrieves a single catalog item as a CatalogObject based on the provided ID. It includes all relevant information, such as CatalogItemVariation children, references to CatalogModifierList objects, and applicable CatalogTax IDs.

Retrieve a custom attribute from a customer profile. Retrieves a custom attribute associated with a customer profile in Squareup. Optionally, also retrieves the custom attribute definition using a query parameter. Useful for accessing specific customer data fields set by sellers or other applications.

Retrieve a customer's custom attribute definition from Square. Use this tool to get a specific customer-related custom attribute definition from a Square seller account. It retrieves details about the attribute, provided it has the correct visibility settings.

Retrieve details of a specific customer group by group ID. Use this tool to get information about a specific customer group using its unique group ID.

Retrieve specific customer segment information. Use this tool to get information about a specific customer segment using the segment ID.

Retrieve evidence for a specific dispute. Use this tool to obtain a list of all evidence linked to a particular dispute, identified by its dispute ID.

Get metadata for specified dispute evidence. Use this tool to retrieve the metadata of a specific piece of evidence related to a dispute by providing the dispute ID and evidence ID. Useful for managing and reviewing evidence details.

Retrieve current stock count for a specific catalog item. Use this tool to get the current calculated inventory count for a specific CatalogObject at specified locations. This is useful for tracking stock levels in real-time.

Retrieve details of a specific inventory physical count. Use this tool to get details of an inventory physical count using the provided physical count ID.

Retrieve a custom attribute for a specific location. This tool fetches a custom attribute linked with a specific location. It can also include the attribute definition if specified. Use this when you need details about a location's custom attributes.

Retrieve the loyalty program details for a seller. Use this tool to get information about the loyalty program in a seller's account. You can specify the program by its ID or use the keyword 'main' to access the primary program. This is useful for understanding how buyers earn points and redeem rewards in the loyalty program.

Retrieve details of a specific loyalty reward. Use this tool to fetch details about a particular loyalty reward by providing the reward ID. This can help understand customer incentives or verify reward status.

Retrieves custom attribute definition for a Square seller account. This tool retrieves a custom attribute definition related to a merchant from a Square seller account. It is useful for obtaining detailed attribute information created by other applications, provided the visibility settings are set to allow access.

Retrieve details about a specific merchant. This tool provides information about the merchant associated with a given access token, returning a list with a single merchant object. Useful for acquiring merchant details when the merchant ID is unknown.

Retrieve detailed information about a specific payment. This tool retrieves details for a specific payment using its ID. It should be called when information about a particular payment is needed, such as transaction details, status, and other relevant data.

Retrieve details of a specific payout using payout ID. Use this tool to obtain detailed information about a specific payout by providing its payout ID. Ensure that the required OAuth scope `PAYOUTS_READ` is set before calling this tool.

Retrieve Square Catalog API information and batch size limits. This tool fetches details about the Square Catalog API, including information on batch size limits for the `BatchUpsertCatalogObjects` endpoint. Use this to understand API constraints and capabilities.

Retrieve a team member's booking profile from Square. Use this tool to get specific booking information for a team member by their unique ID. Ideal for checking availability or scheduling details.

Retrieve details for a specific team member by ID. Use this tool to get information about a specific team member using their ID. Useful for managing team details and troubleshooting within the Squareup platform.

Retrieve wage details for a specific team member. Use this tool to obtain wage information for a specific team member by their ID. Useful for managing payroll or reviewing individual compensation.

Retrieve details of an Interac Terminal refund by ID. Call this tool to get information about a specific Interac Terminal refund using its ID. Refund details are available for 30 days after the refund is processed.

Fetch details of a specific timecard by ID. Use this tool to retrieve information about a specific timecard using its unique ID. This is useful for accessing detailed timecard records for employees.

Link a customer to a gift card for future use. This tool is used to link a specific customer to a gift card, which allows storing the card on file for the customer. Use it when you want to associate a gift card with a customer for tracking and usage purposes.

Fetch details of all seller's locations, including inactive ones. This tool retrieves and provides information about all of the seller's locations from SquareUp, including those with inactive status. Locations are listed alphabetically by name and can be used to gain insights into the seller's business locations.

Fetches bank accounts linked to a Square account. Use this tool to get a list of all bank accounts associated with a Square account. It retrieves relevant bank account details.

Retrieve all custom attribute definitions for bookings. Use this tool to get all custom attribute definitions associated with bookings. It requires appropriate OAuth permissions based on buyer or seller level access. This tool is ideal for managing and understanding the custom attributes tied to booking data.

Retrieve a booking's custom attributes. Use this tool to list custom attributes associated with a specific booking. Ensure proper OAuth scope with 'APPOINTMENTS_READ' for buyer-level permissions or both 'APPOINTMENTS_ALL_READ' and 'APPOINTMENTS_READ' for seller-level permissions.

Retrieve booking profiles for team members. Use this tool to obtain a list of booking profiles associated with team members. Ideal for viewing or managing team schedules and bookings.

Retrieve a paginated list of break types for a business. Use this tool to obtain a list of different break types defined in a business. Ideal for accessing and managing labor-related break policies.

Retrieve events for a specific cash drawer shift. Use this tool to get a list of events related to a specific cash drawer shift. This is useful for tracking activities during the shift.

Retrieve cash drawer shift details for a location and date range. Use this tool to obtain detailed information about cash drawer shifts for a specific location during a specified date range. Ideal for managing and auditing cash flows in business operations.

Retrieve a list of catalog objects by type from Square catalog. Use this tool to get a list of catalog objects from Square, specifying desired types such as ITEM, ITEM_VARIATION, MODIFIER, etc. Note: It does not include deleted items.

Retrieve customer custom attribute definitions for a Square seller. Lists customer-related custom attribute definitions of a Square seller account, including those visible to the requesting app. This includes custom attributes that are read-only or read-write.

Retrieve custom attributes of a customer profile. This tool lists the custom attributes associated with a customer profile, with an option to include custom attribute definitions. It retrieves all custom attributes visible to the requesting application, including those owned by other applications with shared visibility settings.

Retrieve a list of customer groups for a business. Call this tool to get the customer groups associated with a business. Useful for understanding customer segments or managing customer-related operations.

Retrieve customer profiles from a Square account. Use this tool to list customer profiles linked to a Square account. It is useful when you need to access or manage customer data stored on Square. Newly created or updated profiles may take up to a minute to be available for listing during network incidents.

Retrieve customer segments for a business. Use this tool to get the current list of customer segments associated with a business. Ideal for understanding customer categorization and segmentation.

List all device codes for a merchant. Fetches all device codes linked to a merchant, providing access to their associated data.

Retrieve available event types for webhooks and API queries. Fetches all event types that can be subscribed to as webhooks or queried via the Events API using Squareup.

Retrieve and filter gift card activities. Fetches gift card activities for the seller's account, allowing optional filters for specific cards, regions, or timeframes.

Retrieve and filter a list of gift cards. This tool calls the API to list all available gift cards, with the option to apply filters for a more specific subset. Results are returned sorted by their creation date in ascending order.

Retrieve a list of invoices for a specified location. This tool retrieves a list of invoices associated with a particular location. It supports pagination, so if the response is too large, a cursor is provided for subsequent requests to fetch the remaining invoices.

Retrieve jobs from a seller's account, sorted by title. Use this tool to obtain a list of jobs associated with a seller's account. The jobs are organized in ascending order by their title.

Get location-related custom attribute definitions for a Square account. Use this tool to retrieve all location-related custom attribute definitions associated with a Square seller account, including those with different visibility settings.

Retrieve custom attributes for a specific location. This tool retrieves custom attributes associated with a specific location from Square. Optionally, custom attribute definitions can be included. It returns attributes visible to the requester, including those with varying visibility settings.

Retrieve promotions from a specific loyalty program. Call this tool to list loyalty promotions associated with a specific loyalty program, sorted by the most recent creation date.

Retrieve merchant custom attribute definitions. Fetch all merchant-related custom attribute definitions for a Square seller account, including those visible to the requesting application, even if created by other applications.

Retrieve custom attributes for a specified merchant. This tool retrieves the custom attributes associated with a specific merchant, including those visible to the requesting application and owned by other applications. Useful for managing and analyzing merchant-specific data.

Retrieve a list of devices for a merchant's terminal API. This tool is used to list all devices associated with a merchant, specifically for the Terminal API. It is helpful for businesses needing an overview of their registered devices.

Retrieve order-related custom attribute definitions for a Square seller. Lists all order-related custom attribute definitions for a Square seller account, including those with read-only or read-write visibility set by other applications.

Retrieve custom attributes associated with an order. This tool fetches the custom attributes linked to a specific order, optionally including their definitions. It provides all visible custom attributes, including those owned by other applications with specific visibility settings.

Lists all online payment links for Squareup. Use this tool to retrieve a list of all payment links created in Squareup's online checkout system.

Retrieve a list of payment refunds for the account. Use this tool to get a list of refunds associated with the account. This is useful for checking all refund transactions. Note that results are eventually consistent and may take a few seconds to update.

Retrieve all payout entries for a specific payout. Use this tool to get a list of payout entries related to a specific payout ID. Ensure the `PAYOUTS_READ` OAuth scope is set before calling this tool.

Retrieve a list of payouts for the default location. This tool retrieves all payouts for the default location. It allows filtering by location ID, status, time range, and ordering results. Ensure that `PAYOUTS_READ` is set for the OAuth scope.

Retrieve a list of available sales channels. Use this tool to obtain a list of all available sales channels through which transactions can be processed. Useful for managing sales operations and integrations.

Retrieve a list of scheduled shifts with filtering options. Fetch a paginated list of scheduled work shifts. You can apply filters and sort the results, which are by default ordered by start time in ascending order. 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 booking profiles for seller locations. Call this tool to obtain a list of booking profiles for a seller's locations. Useful for understanding how bookings are managed across different locations of a seller.

List all Square Online sites for a seller. Fetches a list of Square Online sites associated with a seller account, ordered by creation date. Useful for managing or reviewing existing sites.

Retrieve all events for a specific subscription. This tool retrieves all events related to a specific subscription, providing insight into its activities and changes.

Retrieve paginated list of team member wages for a business. This tool retrieves a paginated list of wage details for team members in a business. It can be called when specific information about team member wages is needed.

Retrieve a list of cards owned by the account. This tool fetches up to 25 cards associated with the user's account. It should be called when there is a need to view all cards linked to the account making the request.

Retrieve all webhook event types available for subscription. This tool is used to fetch a list of all available webhook event types that can be subscribed to. It helps users identify which events they can set up webhooks for in order to receive notifications.

Lists all webhook subscriptions owned by the application. Use this tool to retrieve all webhook subscriptions associated with your Square application. It provides a comprehensive list of active webhook subscriptions.

Retrieve workweek configurations for a business. This tool retrieves a list of workweek configurations, providing details about the workweek setup for a business.

Obtain OAuth access and refresh tokens. This tool is used to obtain an OAuth access token and refresh token using either the authorization_code or refresh_token grant type. It's applicable for both code flow and PKCE flow scenarios, depending on the credentials and additional parameters provided.

Schedule a pause for an active subscription. Use this tool to pause an active subscription by scheduling a `PAUSE` action. Call it when you need to temporarily halt a subscription's services.

Settle an order using approved payments. This tool is used to pay for an order with approved payments, or to mark an order with a total of 0 as paid. Ensure all payments reference the order correctly. Useful for completing transactions with delayed capture payments.

Preview order pricing without creating an order. Call this tool to obtain an estimate of the pricing for an order without the need to actually create the order. Useful for displaying potential costs to customers before finalizing the transaction. 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 a draft invoice with Square, updating its status. This tool publishes a specified draft invoice using Square's service, updating its status and triggering configured actions such as sending emails or charging stored cards. The tool should be called when an invoice needs to be finalized and sent or processed according to its settings.

Publish a scheduled shift to make it official. Use this tool to publish a scheduled shift, confirming its details. The draft shift details are finalized and moved to the published shift details, marking the shift as official.

Record received items for a transfer order. Use this tool to record the receipt of items for a transfer order, including handling partial receipts and damaged items. It updates the inventory based on item condition and progresses the order status. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. 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. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Redeem a loyalty reward for a customer purchase. Use this tool to mark a loyalty reward as redeemed after a customer has completed a purchase. Suitable for use when processing orders outside the Orders API. Once redeemed, rewards cannot be reversed.

Refund a payment partially or fully using Square. Use this tool to refund the entire amount or a portion of a payment. It supports card payments as well as cash or external payments. Relevant for reversing transactions in case of errors or customer returns. 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.

Remove a group membership from a customer. Call this tool to remove a specific group association from a customer using their customer ID and group ID.

Removes specified evidence from a dispute in Square. This tool should be called when there's a need to remove specific evidence from a dispute in the Square platform. It ensures the evidence is not sent to the bank by Square.

Removes an attachment from an invoice. Use this tool to permanently delete an attachment from an invoice. Applicable only for invoices in 'DRAFT', 'SCHEDULED', 'UNPAID', or 'PARTIALLY_PAID' states.

Delete a custom attribute from a location. Use this tool to delete a custom attribute associated with a specific location. The attribute must have a visibility setting of `VISIBILITY_READ_WRITE_VALUES` if owned by another application.

Delete a custom attribute from a merchant. Use this tool to remove a custom attribute associated with a merchant in Squareup. Deletion is possible if the attribute's visibility setting is 'VISIBILITY_READ_WRITE_VALUES' when owned by another application.

Resume a paused or deactivated subscription. Use this tool to schedule a resume action for subscriptions that are currently paused or deactivated.

Retrieve detailed information about a booking. Use this tool to get comprehensive details of a specific booking by providing the booking ID. It requires appropriate OAuth permissions to access booking data.

Retrieve custom attributes of a booking. This tool retrieves a specific custom attribute for a booking using the booking ID and custom attribute key. Ensure proper OAuth permissions are set: `APPOINTMENTS_READ` for buyer-level, and `APPOINTMENTS_ALL_READ` with `APPOINTMENTS_READ` for seller-level.

Retrieve a booking's custom attribute definition. Use this tool to retrieve detailed information about a specific booking's custom attribute definition. Ensure proper OAuth scope: `APPOINTMENTS_READ` for buyer-level or `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for seller-level permissions.

Retrieve a seller's booking profile information. Use this tool to obtain details about a seller's booking profile. Ideal for acquiring booking-related information for businesses.

Retrieve a collection of bookings. Call this tool to get a list of bookings. Ensure appropriate OAuth scopes are set depending on buyer-level or seller-level permissions.

Retrieve details for a specific card. Use this tool to get information about a specific card by providing the card ID.

Retrieve summary details for a specific cash drawer shift. This tool fetches summary details for a single cash drawer shift. It should be used when you need to know the specifics of a particular shift, such as its total cash movements and status. Ideal for financial reconciliations and auditing tasks.

Retrieve detailed catalog objects by provided IDs. This tool retrieves a set of catalog objects based on provided IDs, including comprehensive details like item variations, modifier lists, and applicable tax IDs.

Retrieve detailed information about a specific channel. Use this tool to obtain detailed information about a channel using its channel ID.

Retrieve detailed information for a specific customer. Use this tool to obtain detailed information about a single customer by their ID. Ideal for cases where customer-specific information is needed, such as contact details, purchase history, or personalized service.

Retrieve specific device information using its ID. Call this tool to obtain details about a specific device using its unique ID. Useful for accessing device-related information in Square's system.

Retrieve device code details by ID. Use this tool to obtain device code details when given a specific ID.

Retrieve details about a specific dispute using its ID. Call this tool to obtain information about a particular dispute, including its details, by providing the dispute ID.

Retrieve a gift card using its account number. This tool retrieves details of a gift card by using the gift card account number (GAN). It should be called when you need to access information about a specific gift card.

Retrieve a gift card using a secure token. Call this tool to obtain gift card details using a secure payment token.

Retrieve gift card details using a gift card ID. Use this tool to obtain information about a specific gift card by providing its ID. Ideal for checking balance, status, or other gift card details.

Fetches inventory adjustment details by ID. Use this tool to get details of a specific inventory adjustment by its ID. Ideal for tracking changes in inventory levels.

Retrieve current inventory counts for specific items and locations. Call this tool to get current inventory counts for specified catalog objects at specific locations. Results are sorted by newest first and can be filtered by changes since a given timestamp to facilitate synchronization.

Retrieve detailed inventory transfer information. Use this tool to obtain information about a specific inventory transfer using the transfer ID.

Retrieve invoice details using an invoice ID. Use this tool to get detailed information of an invoice by providing a specific invoice ID.

Retrieve details of a specified job. Use this tool to fetch detailed information about a specific job using the job's unique identifier.

Retrieve a location's custom attribute definition. Use this tool to obtain the custom attribute definition for a specified location in a Square seller account. Ensure the attribute's visibility is set appropriately to access it.

Retrieve details of a specific business location. Use this tool to get information about a specific location by providing its ID. Specify 'main' to get details of the main location.

Retrieve settings for a Square-hosted checkout page location. Call this tool to get the specific settings configured for a location's Square-hosted checkout page. Useful for understanding location-specific checkout configurations.

Retrieve details of a specific loyalty account. This tool fetches the information of a specific loyalty account using the account ID. Use it to access a member's loyalty details and activities.

Retrieve details of a specific loyalty promotion. Use this tool to obtain information about a particular loyalty promotion by providing the program and promotion IDs. It should be called when you need to view the specifics of a loyalty promotion.

Retrieve a custom attribute associated with a merchant. Use this tool to get a specific custom attribute of a merchant, optionally including the attribute's definition. This can be used when you need to access merchant-specific settings or details defined by custom attributes.

Retrieve merchant details using their ID. Use this tool to get comprehensive information about a merchant by providing the merchant ID. This is useful for obtaining merchant-specific data, such as business details or other relevant merchant information.

Retrieve multiple orders using their IDs. This tool retrieves details of multiple orders from Square using their IDs. It ignores any non-existent order IDs, ensuring no errors are returned for invalid IDs.

Retrieve a specific snippet from a Square Online site. Use this tool to get the snippet added by your application to a specific Square Online site. Ensure you have the site ID, which can be obtained by calling the ListSites API.

Retrieve an order's details using its ID. Use this tool to fetch the details of a specific order by providing its ID. It simplifies the process of obtaining order information from the Square API.

Retrieve a custom attribute for a specified order. Use this tool to get a custom attribute linked to an order. It can also retrieve the custom attribute definition if needed. Visibility settings determine if attributes from other applications can be accessed.

Retrieve a custom attribute definition for an order. This tool retrieves an order-related custom attribute definition from a Square seller account. It should be called when you need to access specific custom attribute information related to orders. Custom attributes must have visibility settings of VISIBILITY_READ_ONLY or VISIBILITY_READ_WRITE_VALUES unless defined by the seller.

Retrieve a payment link using its ID. This tool retrieves details of a payment link by its unique ID. It's useful for getting information about a specific payment link set up in your Square account.

Retrieve a list of payments from your account. Use this tool to access a list of payments made through your account. It provides a consistent overview of payment transactions, with a maximum of 100 results per page. Note that changes to payments may take a few seconds to reflect.

Retrieve details of a specific refund using the refund ID. Use this tool to get detailed information about a refund by providing the refund ID. It's useful for checking the status and details of a refund processed through Square.

Retrieve bulk information about sales channels. Use this tool to fetch detailed information about multiple sales channels for business operations.

Retrieve details of a scheduled shift by ID. Use this tool to obtain information about a specific scheduled shift using its ID. This is useful for accessing shift details in scheduling and labor management systems.

Retrieve a seller's location booking profile. Use this tool to get details about a seller's location booking profile by providing the location ID.

Retrieve Square merchant settings for checkout pages. Use this tool to get the settings for a merchant's Square-hosted checkout page, which could be useful for understanding or managing the checkout configuration.

Retrieve details of a specific subscription using its ID. Use this tool to obtain information about a subscription by providing its unique subscription ID. Useful for accessing current subscription status, billing, and service details.

Retrieve booking profiles for one or more team members. Use this tool to get booking profiles of specified team members. Useful for accessing and managing team members' booking information.

Retrieve wage settings for a specified team member. This tool retrieves the wage settings of a team member using their TeamMember ID. It's useful for accessing specific wage details related to a team member. If troubleshooting is needed, refer to the linked Square documentation.

Retrieve a Terminal action request by action ID. Call this tool to get detailed information about a specific Terminal action using its action ID. Terminal action requests are available for retrieval up to 30 days.

Retrieve a Terminal checkout request by checkout ID. Use this tool to get details of a Terminal checkout request using a specific checkout ID. Ideal for accessing checkout information within a 30-day period.

Retrieve the status of an OAuth or personal access token. Use this tool to get information on the validity and status of an OAuth access token or a personal access token. Call this tool to check if a token is expired or unauthorized.

Retrieve detailed information of a specific transfer order. Use this tool to get comprehensive details of a transfer order by providing its ID. This includes status, dates, notes, line items, source and destination locations, and tracking info if available.

Retrieve detailed information about a vendor by ID. This tool retrieves information about a specific vendor using their Vendor ID and should be called when vendor details are needed.

Retrieve detailed information about specific vendors. Use this tool to obtain detailed information for vendors by their IDs. Ideal for managing vendor relationships or verifying vendor details.

Retrieve details of a specific webhook subscription. This tool retrieves information about a specific webhook subscription using its unique ID. It should be called when you need to access details of a webhook provided by the subscription ID.

Revoke all OAuth access tokens for an account. This tool revokes all OAuth access tokens for a given account associated with your application. It should be called when you need to invalidate the access tokens generated through the OAuth flow. Note that all tokens will be revoked regardless of which one is specified.

Find available booking slots for appointments. Use this tool to search for available booking slots. It requires appropriate permissions depending on user level (buyer or seller). 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.

Find catalog items or variations based on search filters. Use this tool to search for catalog items or item variations by matching supported search attributes and custom attribute values against specified query filters. This tool is specifically for searching items or item variations, unlike the broader SearchCatalogObjects endpoint. 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.

Search for catalog objects using specified query filters. Use this tool to search for any type of catalog object through the Squareup API by matching supported search attribute values. This tool is ideal for retrieving catalog objects, including deleted ones, based on provided query filters. It's useful for comprehensive catalog searches excluding custom attribute values. 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.

Search for invoices based on location and optional customer. This tool searches for invoices from a specified location and can filter by customer. It supports pagination; if results are truncated, a cursor is provided for retrieving more invoices.

Search for loyalty accounts by phone number or customer ID. This tool searches for loyalty accounts within a loyalty program. Use it when you need to find accounts based on a phone number or customer ID. To retrieve all accounts, you can leave the query empty. The results are sorted by the account creation date. 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 and search for Square loyalty events. This tool allows you to search for loyalty events within a Square loyalty program, which logs events such as points earned, redeemed, or expired. Use this tool to get details of these events sorted by creation date.

Search for loyalty rewards with optional filters. This tool searches for loyalty rewards and can retrieve results for all loyalty accounts when no filters are applied. If a query object is used, the `loyalty_account_id` is required, while `status` is optional. Results are sorted by `updated_at` in descending order.

Search customer profiles in a Square account. Use this tool to search for customer profiles in a Square account by applying various query filters. If no filters are provided, it returns all profiles sorted alphabetically by name. 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.

Search for Square API events within a specified timeframe. Use this tool to find events from the Square API that have occurred within a 28-day period. Ideal for tracking event history and obtaining specific event details.

Search and retrieve orders from Square locations. Use this tool to search for all orders across specified Square locations, including sales, returns, and exchanges. The search can include filters, sorting, and specify whether to return detailed order information or a summary. 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.

Search for subscriptions by location and customer IDs. This tool searches for subscriptions, ordering them by creation date, location, and optionally by customer IDs. If no location or customer IDs are provided, it searches across all available locations and customers.

Retrieve a filtered list of team members for a business. This tool retrieves a paginated list of `TeamMember` objects associated with a business. It allows filtering by location IDs, status (`ACTIVE` or `INACTIVE`), or whether the team member is the Square account owner. Use this to manage or view team member details based on specific criteria.

Retrieve a filtered list of terminal action requests. Use this tool to get a list of terminal action requests created by your account. Terminal actions are accessible for 30 days.

Retrieve filtered Terminal checkout requests for the merchant. This tool returns a filtered list of Terminal checkout requests created specifically by the application making the request. It should be called when there's a need to access Terminal checkout requests for the merchant associated with the OAuth token. Requests are available for 30 days.

Retrieve a filtered list of Interac Terminal refund requests. Use this tool to get Interac Terminal refund requests created by the seller, available for up to 30 days. Ideal for managing recent refund activities or auditing transactions.

Retrieve filtered and sorted timecard records for a business. Use to get a list of timecard records filtered by location IDs, team member IDs, status, start and end times, or workday details. The records can also be sorted by start, end, creation, or update times. 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.

Search for transfer orders using specific filters. This tool searches for transfer orders using various filters, returning a paginated list of matching orders sorted by creation date. It can find orders by source or destination location or by a specific transfer order status.

Search for vendors using filters and sorters. Use this tool to find vendors by applying filters to vendor properties and sorting the results as needed. It is useful for retrieving vendor information based on specific criteria.

Upserts a custom attribute for a booking. Use this tool to update or insert a custom attribute for a specific booking. Requires appropriate OAuth scopes and seller subscriptions to Appointments Plus or Premium. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. 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. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Start a transfer order to mark it as in-transit. Use this tool to change a draft transfer order to started status, which decrements inventory at the source location and marks the order as in-transit. Once started, the order is locked from deletion but can be canceled. A webhook event is created upon starting the order.