square · 122 tools · no triggers
Connect it
run auth square
run auth square --scope team # shared with the organization
Use it
run square # common commands
run square --all # every command
import { square } from "@boxd/run";
Common tools
| Tool | What it does |
|---|---|
create-batch-inventory-changes | Applies multiple inventory adjustments and physical counts in a single batch request. |
create-bulk-customers | Tool to create multiple customer profiles in a single request. |
create-customer | Tool to create a new customer profile in Square. Use when you need to add a customer to the Square account. |
create-gift-card-activity | Creates a gift card activity to manage gift card balances. This action supports multiple activity types including ACTIVATE (initiate a gift card with… |
create-location | Tool to create a new business location in a Square account. Use when you need to add a new physical or mobile location for the merchant. |
create-order | Creates a new Square order with line items, taxes, discounts, and fulfillment details. |
create-refund | Refunds a Square payment in full or partially. Use this action when you need to return funds to a customer for a completed payment, such as for… |
create-team-member | Tool to create a new team member in Square. Creates a team member profile that can be used to assign permissions and track employee data. |
delete-catalog-object | Tool to delete a Square catalog object by ID. When an object is deleted, other objects in the graph that depend on that object will be deleted as… |
delete-customers-bulk | Tool to bulk delete customer profiles from Square. Use when you need to delete multiple customer profiles at once (1-100 customers per request). |
get-booking | Retrieves detailed information about a specific Square booking by its ID. |
get-current-merchant | Tool to retrieve merchant information associated with the access token using Square’s GraphQL API. |
get-loyalty-account | Tool to retrieve detailed information about a specific Square loyalty account by ID. |
get-merchant | Tool to retrieve detailed information about a specific Square merchant by ID. |
get-refund | Retrieves a specific payment refund by its unique ID from Square. |
get-subscription | Retrieves detailed information about a specific Square customer subscription by its ID. |
get-team-member | Tool to retrieve detailed information about a specific Square team member by ID. |
list-cards | Tool to retrieve cards on file associated with a Square account. |
list-channels | Tool to list requested channels from Square. Use when you need to retrieve channel information for a specific reference type, reference ID, or status. |
list-customer-groups | Tool to retrieve the list of customer groups of a business. Use when you need to discover customer group IDs or list all customer groups for… |
list-customers | Tool to retrieve customer profiles associated with a Square account. |
list-customer-segments | Tool to retrieve the list of customer segments of a business. |
list-locations | Tool to retrieve all business locations from a Square account. |
list-merchants | Tool to retrieve merchant account information associated with the access token. |
list-payments | Tool to list payments by location and time range to enable reconciliation and net sales reporting from Square POS. |
All 122 tools
All 122 tools
| Tool | What it does |
|---|---|
accept-dispute | Accept a dispute and acknowledge liability, returning funds to the cardholder. |
add-group-to-customer | Tool to add a customer to a customer group. Use when you need to associate a customer with a specific group for targeted marketing, loyalty programs… |
calculate-order | Tool to preview order pricing without creating an order. Use when you need to calculate the total cost, taxes, discounts, and other pricing details… |
cancel-booking | Cancels an existing Square booking, terminating the reservation. |
cancel-invoice | Cancels a Square invoice, preventing further payments from being collected. |
cancel-payment | Cancels (voids) a payment that is in APPROVED status. This is typically used in delayed capture scenarios where a payment was authorized but not yet… |
create-batch-inventory-changes | Applies multiple inventory adjustments and physical counts in a single batch request. |
create-bulk-customers | Tool to create multiple customer profiles in a single request. |
create-card | Tool to create a card on file. Use when you need to securely store a customer’s card for future payments. |
create-customer | Tool to create a new customer profile in Square. Use when you need to add a customer to the Square account. |
create-customer-custom-attribute-definition | Tool to create a customer-related custom attribute definition. |
create-customer-group | Tool to create a new customer group for a business. Use when you need to organize customers into groups for targeted marketing or segmentation. |
create-dispute-evidence-file | Tool to upload a file as dispute evidence. Use when you need to attach supporting documents (PDF, image, etc.) to an existing dispute. |
create-dispute-evidence-text | Upload text evidence for a dispute challenge. Use this to submit textual information (up to 500 characters) that supports your case in a payment dispute. |
create-gift-card-activity | Creates a gift card activity to manage gift card balances. This action supports multiple activity types including ACTIVATE (initiate a gift card with… |
create-invoice-attachment | Upload and attach a file to a Square invoice. Use this action to add supplementary documents (receipts, contracts, supporting documentation) to an existing invoice. |
create-location | Tool to create a new business location in a Square account. Use when you need to add a new physical or mobile location for the merchant. |
create-location-custom-attribute-definition | Tool to create a location-related custom attribute definition. |
create-order | Creates a new Square order with line items, taxes, discounts, and fulfillment details. |
create-refund | Refunds a Square payment in full or partially. Use this action when you need to return funds to a customer for a completed payment, such as for… |
create-team-member | Tool to create a new team member in Square. Creates a team member profile that can be used to assign permissions and track employee data. |
delete-catalog-object | Tool to delete a Square catalog object by ID. When an object is deleted, other objects in the graph that depend on that object will be deleted as… |
delete-catalog-objects-batch | Deletes a set of CatalogObjects based on a list of target object IDs and returns a set of successfully deleted IDs in the response. |
delete-customer | Tool to delete a Square customer profile. Use when you need to permanently remove a customer record from Square. |
delete-customer-custom-attribute | Tool to delete a custom attribute from a customer profile. Use when you need to remove custom data associated with a specific customer. |
delete-customer-custom-attribute-definition | Tool to delete a customer-related custom attribute definition. |
delete-customer-group | Tool to delete a customer group by its ID. Use when you need to permanently remove a customer group from Square. |
delete-customers-bulk | Tool to bulk delete customer profiles from Square. Use when you need to delete multiple customer profiles at once (1-100 customers per request). |
delete-dispute-evidence | Removes a specific piece of evidence from a dispute. Evidence that is removed will NOT be sent to the bank. |
delete-invoice | Tool to delete a Square invoice (only DRAFT invoices can be deleted). |
delete-invoice-attachment | Tool to delete an attachment from a Square invoice. Endpoint: DELETE /v2/invoices/{invoice_id}/attachments/{attachment_id} |
delete-location-custom-attribute | Tool to delete a custom attribute from a location. Use when you need to remove custom data associated with a specific business location. |
delete-location-custom-attribute-definition | Tool to delete a location-related custom attribute definition. |
delete-locations-custom-attributes-batch | Tool to delete custom attributes from multiple locations in a single batch request. |
delete-merchant-custom-attribute | Tool to delete a custom attribute from a merchant profile. Use when you need to remove custom data associated with a specific merchant. |
delete-merchant-custom-attribute-definition | Tool to delete a merchant-related custom attribute definition. |
delete-merchants-custom-attributes-batch | Tool to delete custom attributes from multiple merchants in a single batch request. |
delete-webhook-subscription | Permanently deletes a webhook subscription by its ID. Once deleted, the subscription will no longer receive event notifications. |
get-booking | Retrieves detailed information about a specific Square booking by its ID. |
get-business-booking-profile | Tool to retrieve the business booking profile for a Square merchant via GraphQL. |
get-current-merchant | Tool to retrieve merchant information associated with the access token using Square’s GraphQL API. |
get-customer-custom-attribute | Retrieves a custom attribute from a customer profile in Square. |
get-customers-custom-attribute-definitions | Tool to retrieve a customer-related custom attribute definition from Square. |
get-customers-graphql | Tool to retrieve customer profiles from Square Customer Directory using GraphQL API. |
get-dispute-evidence | Retrieves detailed information about a specific piece of evidence that was uploaded for a dispute. |
get-gift-card-from-gan | Retrieves detailed information about a gift card by its GAN (gift card account number). |
get-invoice | Retrieves detailed information about a specific Square invoice by its ID. |
get-loyalty-account | Tool to retrieve detailed information about a specific Square loyalty account by ID. |
get-merchant | Tool to retrieve detailed information about a specific Square merchant by ID. |
get-online-checkout-location-settings | Tool to retrieve location-level settings for Square online checkout. |
get-refund | Retrieves a specific payment refund by its unique ID from Square. |
get-subscription | Retrieves detailed information about a specific Square customer subscription by its ID. |
get-team-member | Tool to retrieve detailed information about a specific Square team member by ID. |
link-customer-to-gift-card | Tool to link a customer to a gift card in Square. Links the customer profile to the gift card, adding their ID to the gift card’s customer_ids list. |
list-cards | Tool to retrieve cards on file associated with a Square account. |
list-channels | Tool to list requested channels from Square. Use when you need to retrieve channel information for a specific reference type, reference ID, or status. |
list-customer-custom-attribute-definitions | Tool to list customer-related custom attribute definitions from Square. |
list-customer-custom-attribute-definitions-graph-ql | Tool to retrieve customer custom attribute definitions via Square’s GraphQL API. |
list-customer-custom-attributes | Tool to list custom attributes for a customer profile. Use when you need to retrieve all custom data associated with a specific customer, including… |
list-customer-groups | Tool to retrieve the list of customer groups of a business. Use when you need to discover customer group IDs or list all customer groups for… |
list-customers | Tool to retrieve customer profiles associated with a Square account. |
list-customer-segments | Tool to retrieve the list of customer segments of a business. |
list-dispute-evidence | Tool to list evidence items associated with a given dispute. |
list-invoices | Tool to list invoices for a Square location. |
list-location-custom-attribute-definitions | Tool to list location-related custom attribute definitions from Square. |
list-locations | Tool to retrieve all business locations from a Square account. |
list-locations-custom-attributes | Tool to list custom attributes for a specific location in Square. |
list-merchant-custom-attribute-definitions | Tool to list merchant-related custom attribute definitions from Square. |
list-merchants | Tool to retrieve merchant account information associated with the access token. |
list-merchants-custom-attributes | Tool to list custom attributes for a specific merchant in Square. |
list-payments | Tool to list payments by location and time range to enable reconciliation and net sales reporting from Square POS. |
list-subscriptions | Tool to search and list Square customer billing subscriptions. |
list-webhook-event-types | Tool to list available webhook event types. Use when you need to discover event types before creating or updating a webhook subscription. |
list-webhook-subscriptions | List all webhook subscriptions owned by your application. Returns webhook subscriptions with their event types, notification URLs, and status. |
pay-order | Pays an existing Square order by processing approved payments and completing the transaction. |
remove-group-from-customer | Removes a customer from a customer group. Use this when you need to disassociate a customer from a specific group. |
retrieve-bulk-customers | Tool to retrieve multiple customer profiles in a single request. |
retrieve-channel | Retrieve a Square channel by its ID. Channels represent different distribution points for catalog content, including physical locations and online platforms. |
retrieve-channels-bulk | Tool to bulk retrieve multiple Square channels by their IDs in a single request. |
retrieve-customer | Tool to retrieve detailed information about a specific Square customer by ID. |
retrieve-customer-group | Tool to retrieve a specific Square customer group by ID. Use when you need to fetch details about a customer group including its name and timestamps. |
retrieve-customer-segment | Tool to retrieve a specific customer segment by its ID. Use when you need to get details about a customer segment including its name and timestamps. |
retrieve-dispute | Tool to retrieve a Square dispute by ID. Endpoint: GET /v2/disputes/{dispute_id} |
retrieve-inventory-changes | Retrieves the inventory change history for a catalog object at specified locations. |
retrieve-inventory-counts-batch | Retrieve inventory counts for multiple catalog objects and locations in a single batch request. |
retrieve-location | Tool to retrieve detailed information about a specific Square location by ID. |
retrieve-location-custom-attribute | Retrieves a custom attribute associated with a location in Square. |
retrieve-location-custom-attribute-definition | Tool to retrieve a location-related custom attribute definition. |
retrieve-merchant-custom-attribute | Retrieves a custom attribute associated with a merchant in Square. |
retrieve-merchant-custom-attribute-definition | Tool to retrieve a merchant-related custom attribute definition from Square. |
retrieve-merchants | Tool to retrieve merchant information including status, main location details, and capabilities using Square’s GraphQL API. |
retrieve-order | Retrieves detailed information about a specific Square order by its ID. |
retrieve-payment-link | Retrieves a Square-hosted payment link by ID. Returns complete payment link details including the checkout URL, associated order ID, checkout… |
retrieve-token-status | Tool to retrieve information about an OAuth access token or personal access token. |
retrieve-webhook-subscription | Retrieve a Square webhook subscription by its ID. Returns subscription details including name, enabled status, event types, notification URL, and signature key. |
search-booking-availability | Searches for available appointment time slots for booking services at Square locations. |
search-catalog-objects | Searches for catalog objects (items, categories, taxes, discounts, etc.) in the Square catalog. |
search-customers | Tool to search customer profiles in Square Customer Directory. |
search-orders | Tool to search orders across one or more Square locations with filters. |
submit-dispute-evidence | Submits evidence for a dispute to the cardholder’s bank. IMPORTANT: You must upload evidence FIRST using CreateDisputeEvidenceText or… |
test-webhook-subscription | Tests a webhook subscription by sending a test event to the configured notification URL. |
update-booking | Updates an existing Square booking with new appointment details, times, notes, or team members. |
update-customer | Tool to update an existing Square customer profile. Use when you need to modify customer details like name, email, address, or phone number. |
update-customer-custom-attribute-definition | Tool to update a customer-related custom attribute definition in Square. |
update-customer-group | Tool to update a customer group’s information by its ID. Use when you need to modify the name or other attributes of an existing customer group in Square. |
update-customers-bulk | Tool to update multiple customer profiles in a single batch operation. |
update-location | Tool to update an existing business location in a Square account. |
update-location-custom-attribute-definition | Tool to update a location-related custom attribute definition in Square. |
update-merchant-custom-attribute-definition | Tool to update a merchant-related custom attribute definition in Square. |
update-online-checkout-location-settings | Tool to update location-level settings for Square online checkout. |
update-order | Updates an existing Square order by adding, modifying, or removing fields. |
update-team-member | Tool to update an existing Square team member’s information. |
update-webhook-subscription | Tool to update a Square webhook subscription. Use when you need to modify subscription settings such as name, enabled state, event types… |
update-webhook-subscription-signature-key | Tool to rotate the signature key for a webhook subscription. |
upsert-catalog-object | Creates or updates a catalog object in the Square catalog. Use when you need to add or modify items, variations, categories, taxes, discounts, or… |
upsert-catalog-objects-batch | Creates or updates multiple catalog objects in a single batch operation. |
upsert-customer-custom-attribute | Tool to create or update a custom attribute for a customer profile. |
upsert-customer-custom-attributes-batch | Tool to create or update custom attributes for multiple customers in a single batch request. |
upsert-location-custom-attribute | Tool to create or update a custom attribute for a location. Use when you need to store custom data on a location record, such as capacity limits… |
upsert-locations-custom-attributes-batch | Tool to create or update custom attributes for multiple locations in a single batch request. |
upsert-merchant-custom-attribute | Tool to create or update a custom attribute for a merchant profile. |
upsert-merchants-custom-attributes-batch | Tool to create or update custom attributes for multiple merchants in a single batch request. |