SquareUp API

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.

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.