Square MCP Server for Cloudflare Workers
Test Square tools directly in your browser. Select a tool and provide inputs to see the results.
Create a free account to test Square tools interactively. No credit card required.
square_list_merchantsList merchants associated with the access token. Args: - format: Response format Returns: List of merchants.
square_get_cash_drawer_shiftGet a cash drawer shift by ID. Args: - location_id: Location ID - shift_id: Shift ID - format: Response format Returns: The cash drawer shift.
square_get_merchantGet merchant information. Args: - merchant_id: Merchant ID (use 'me' for current merchant) - format: Response format Returns: The merchant record.
square_get_bookingGet a single booking by ID. Args: - booking_id: Booking ID - format: Response format Returns: The booking record.
square_list_bank_accountsList bank accounts linked to the Square account. Args: - cursor: Pagination cursor - limit: Maximum results - location_id: Filter by location ID - format: Response format Returns: List of bank accounts.
square_get_bank_accountGet a bank account by ID. Args: - bank_account_id: Bank account ID - format: Response format Returns: The bank account record.
square_get_bank_account_by_v1_idGet a bank account by its V1 ID. Args: - v1_bank_account_id: V1 bank account ID - format: Response format Returns: The bank account record.
square_list_payoutsList payouts for the Square account. Args: - location_id: Filter by location ID - status: Filter by payout status - begin_time: Filter by start time - end_time: Filter by end time - cursor: Pagination cursor - limit: Maximum results - format: Response format Returns: List of payouts.
square_get_payoutGet a payout by ID. Args: - payout_id: Payout ID - format: Response format Returns: The payout record.
square_list_disputesList disputes for the Square account. Args: - cursor: Pagination cursor - limit: Maximum results - states: Filter by dispute states - location_id: Filter by location ID - format: Response format Returns: List of disputes.
square_get_disputeGet a dispute by ID. Args: - dispute_id: Dispute ID - format: Response format Returns: The dispute record.
square_accept_disputeAccept a dispute (concede to the cardholder). Args: - dispute_id: Dispute ID to accept Returns: The accepted dispute.
square_list_vendorsList vendors. Args: - cursor: Pagination cursor - limit: Maximum results - format: Response format Returns: List of vendors.
square_get_vendorGet a vendor by ID. Args: - vendor_id: Vendor ID - format: Response format Returns: The vendor record.
square_create_vendorCreate a new vendor. Args: - name: Vendor name - address: Vendor address - contacts: Vendor contacts - account_number: Account number - note: Note about vendor - status: Vendor status Returns: The created vendor.
square_update_vendorUpdate an existing vendor. Args: - vendor_id: Vendor ID to update - vendor: Updated vendor fields Returns: The updated vendor.
square_list_cash_drawer_shiftsList cash drawer shifts. Args: - location_id: Location ID - begin_time: Filter by start time - end_time: Filter by end time - cursor: Pagination cursor - limit: Maximum results - format: Response format Returns: List of cash drawer shifts.
square_list_bookingsList bookings with optional filters. Args: - location_id: Filter by location - team_member_id: Filter by team member - start_at_min: Minimum start time (RFC 3339) - start_at_max: Maximum start time (RFC 3339) - cursor: Pagination cursor - limit: Maximum results - format: Response format Returns: Paginated list of bookings.
square_create_bookingCreate a new booking. Args: - start_at: Booking start time (RFC 3339) - location_id: Location ID - customer_id: Customer ID - customer_note: Note from customer - seller_note: Note from seller - appointment_segments: Appointment details Returns: The created booking.
square_update_bookingUpdate an existing booking. Args: - booking_id: Booking ID to update - version: Booking version - start_at: New start time - customer_note: New customer note - seller_note: New seller note Returns: The updated booking.
square_cancel_bookingCancel a booking. Args: - booking_id: Booking ID to cancel - version: Booking version (optional) Returns: The cancelled booking.
square_list_catalogList catalog objects with pagination. Args: - cursor: Pagination cursor - types: Filter by object types (ITEM, CATEGORY, TAX, DISCOUNT, etc.) - limit: Maximum results - format: Response format Returns: Paginated list of catalog objects.
square_get_catalog_objectGet a catalog object by ID. Args: - object_id: Catalog object ID - include_related_objects: Include related objects - format: Response format Returns: The catalog object.
square_search_catalog_objectsSearch for catalog objects. Args: - text_query: Text to search for - object_types: Filter by object types - cursor: Pagination cursor - limit: Maximum results - format: Response format Returns: Paginated list of catalog objects.
square_upsert_catalog_objectCreate or update a catalog object. Args: - object: Catalog object to upsert - type: Object type (ITEM, CATEGORY, TAX, etc.) - id: Object ID (use #temp_id for new objects) - item_data: Item data (for ITEM type) - category_data: Category data (for CATEGORY type) - tax_data: Tax data (for TAX type) - discount_data: Discount data (for DISCOUNT type) Returns: The upserted catalog object.
square_delete_catalog_objectDelete a catalog object. Args: - object_id: Catalog object ID to delete Returns: Confirmation of deletion.
square_batch_delete_catalog_objectsDelete multiple catalog objects. Args: - object_ids: Array of catalog object IDs to delete Returns: Confirmation of deletion.
square_batch_upsert_catalog_objectsCreate or update multiple catalog objects. Args: - objects: Array of catalog objects to upsert Returns: The upserted catalog objects.
square_list_gift_card_activitiesList gift card activities. Args: - gift_card_id: Filter by gift card ID - cursor: Pagination cursor - limit: Maximum results - format: Response format Returns: Paginated list of gift card activities.
square_get_refundGet a single refund by ID. Args: - refund_id: The refund ID - format: Response format Returns: The refund record.
square_list_customersList customers from Square with pagination. Returns a paginated list of customers. Use the cursor from the response to fetch the next page. Args: - limit: Number of customers to return (1-100, default: 20) - cursor: Pagination cursor from previous response - sort_field: Field to sort by (CREATED_AT or DEFAULT) - sort_order: Sort order (ASC or DESC) - format: Response format ('json' or 'markdown') Returns: JSON format: { items: Customer[], count, hasMore, nextCursor }
square_get_customerGet a single customer by ID. Args: - customer_id: The customer ID - format: Response format ('json' or 'markdown') Returns: The customer record with all available fields.
square_create_customerCreate a new customer in Square. Args: - given_name: First name - family_name: Last name - email_address: Email address - phone_number: Phone number (E.164 format recommended) - company_name: Company name - nickname: Nickname - address: Address object - birthday: Birthday (YYYY-MM-DD) - reference_id: Reference ID from external system - note: Note about the customer Returns: The created customer record.
square_update_customerUpdate an existing customer. Args: - customer_id: Customer ID to update - given_name: New first name - family_name: New last name - email_address: New email - phone_number: New phone - company_name: New company name - nickname: New nickname - address: New address - birthday: New birthday - note: New note Returns: The updated customer record.
square_delete_customerDelete a customer from Square. Args: - customer_id: Customer ID to delete Returns: Confirmation of deletion.
square_search_customersSearch for customers matching criteria. Args: - query: Search query object with filters - limit: Maximum results to return - cursor: Pagination cursor - format: Response format Returns: Paginated list of matching customers.
square_list_customer_groupsList all customer groups. Args: - cursor: Pagination cursor - limit: Maximum results - format: Response format Returns: List of customer groups.
square_create_customer_groupCreate a new customer group. Args: - name: Group name Returns: The created customer group.
square_list_gift_cardsList gift cards. Args: - type: Filter by type (DIGITAL, PHYSICAL) - state: Filter by state (ACTIVE, DEACTIVATED, etc.) - cursor: Pagination cursor - limit: Maximum results - format: Response format Returns: Paginated list of gift cards.
square_get_gift_cardGet a gift card by ID. Args: - gift_card_id: Gift card ID - format: Response format Returns: The gift card.
square_get_gift_card_by_ganGet a gift card by GAN (Gift card Account Number). Args: - gan: Gift card account number - format: Response format Returns: The gift card.
square_create_gift_cardCreate a new gift card. Args: - type: Gift card type (DIGITAL or PHYSICAL) - location_id: Location ID Returns: The created gift card.
square_link_customer_to_gift_cardLink a customer to a gift card. Args: - gift_card_id: Gift card ID - customer_id: Customer ID Returns: The updated gift card.
square_unlink_customer_from_gift_cardUnlink a customer from a gift card. Args: - gift_card_id: Gift card ID - customer_id: Customer ID Returns: The updated gift card.
square_create_gift_card_activityCreate a gift card activity (activate, load, redeem, etc.). Args: - gift_card_id: Gift card ID - location_id: Location ID - activity_type: Activity type (ACTIVATE, LOAD, REDEEM, etc.) - amount_money: Amount for LOAD activities { amount, currency } Returns: The created gift card activity.
square_get_inventory_countGet inventory count for a catalog object. Args: - catalog_object_id: Catalog object ID (item variation) - location_ids: Filter by location IDs - format: Response format Returns: Inventory counts.
square_batch_get_inventory_countsGet inventory counts for multiple catalog objects. Args: - catalog_object_ids: Array of catalog object IDs - location_ids: Filter by location IDs - format: Response format Returns: Inventory counts.
square_batch_change_inventoryBatch change inventory counts. Args: - changes: Array of inventory changes - type: Change type (PHYSICAL_COUNT, ADJUSTMENT, TRANSFER) - physical_count: Physical count data - adjustment: Adjustment data - transfer: Transfer data Returns: Updated inventory counts.
square_list_invoicesList invoices for a location. Args: - location_id: Location ID - cursor: Pagination cursor - limit: Maximum results - format: Response format Returns: Paginated list of invoices.
square_get_invoiceGet a single invoice by ID. Args: - invoice_id: Invoice ID - format: Response format Returns: The invoice record.
square_create_invoiceCreate a new invoice. Args: - location_id: Location ID - order_id: Order ID to invoice - customer_id: Customer ID for primary recipient - title: Invoice title - description: Invoice description - invoice_number: Custom invoice number - delivery_method: How to deliver (EMAIL, SHARE_MANUALLY, SMS) - payment_requests: Payment request details Returns: The created invoice.
square_update_invoiceUpdate an existing invoice. Args: - invoice_id: Invoice ID to update - version: Invoice version (required for concurrency) - title: New title - description: New description - delivery_method: New delivery method Returns: The updated invoice.
square_delete_invoiceDelete an invoice. Args: - invoice_id: Invoice ID to delete Returns: Confirmation of deletion.
square_publish_invoicePublish a draft invoice. Args: - invoice_id: Invoice ID to publish - version: Invoice version (required for concurrency) Returns: The published invoice.
square_cancel_invoiceCancel an invoice. Args: - invoice_id: Invoice ID to cancel - version: Invoice version (required for concurrency) Returns: The cancelled invoice.
square_list_locationsList all locations for the Square account. Returns all business locations associated with the account. Args: - format: Response format ('json' or 'markdown') Returns: List of locations with details like name, address, timezone, and status.
square_get_locationGet a single location by ID. Args: - location_id: The location ID - format: Response format ('json' or 'markdown') Returns: The location record with all available fields.
square_update_orderUpdate an existing order. Args: - order_id: Order ID to update - state: New order state - version: Order version Returns: The updated order.
square_create_locationCreate a new location. Args: - name: Business name for the location - address: Address object with address_line_1, locality, administrative_district_level_1, postal_code, country - timezone: IANA timezone (e.g., 'America/Los_Angeles') - description: Description of the location - phone_number: Phone number - business_email: Business email address - website_url: Website URL - business_hours: Business hours configuration Returns: The created location record.
square_update_locationUpdate an existing location. Args: - location_id: Location ID to update - name: New business name - address: New address - timezone: New timezone - description: New description - phone_number: New phone number - business_email: New email - website_url: New website URL - status: Location status (ACTIVE or INACTIVE) Returns: The updated location record.
square_get_loyalty_programGet a loyalty program by ID. Args: - program_id: Loyalty program ID - format: Response format Returns: The loyalty program.
square_list_loyalty_programsList all loyalty programs. Args: - format: Response format Returns: List of loyalty programs.
square_create_loyalty_accountCreate a loyalty account. Args: - program_id: Loyalty program ID - phone_number: Customer phone number Returns: The created loyalty account.
square_get_loyalty_accountGet a loyalty account by ID. Args: - account_id: Loyalty account ID - format: Response format Returns: The loyalty account.
square_search_loyalty_accountsSearch for loyalty accounts. Args: - phone_number: Search by phone number - customer_id: Search by customer ID - cursor: Pagination cursor - limit: Maximum results - format: Response format Returns: Paginated list of loyalty accounts.
square_accumulate_loyalty_pointsAccumulate points on a loyalty account. Args: - account_id: Loyalty account ID - points: Points to accumulate - order_id: Associated order ID Returns: The updated loyalty account.
square_adjust_loyalty_pointsAdjust points on a loyalty account (positive or negative). Args: - account_id: Loyalty account ID - points: Points adjustment (positive to add, negative to subtract) - reason: Reason for adjustment Returns: The updated loyalty account.
square_create_loyalty_rewardCreate a loyalty reward. Args: - loyalty_account_id: Loyalty account ID - reward_tier_id: Reward tier ID Returns: The created loyalty reward.
square_redeem_loyalty_rewardRedeem a loyalty reward. Args: - reward_id: Reward ID to redeem - location_id: Location ID Returns: The redeemed loyalty reward.
square_delete_loyalty_rewardDelete a loyalty reward. Args: - reward_id: Reward ID to delete Returns: Confirmation of deletion.
square_create_orderCreate a new order. Args: - location_id: Location ID for the order - line_items: Array of line items - customer_id: Customer ID - reference_id: External reference ID Returns: The created order record.
square_get_orderGet a single order by ID. Args: - order_id: The order ID - format: Response format Returns: The order record.
square_search_ordersSearch for orders. Args: - location_ids: Filter by location IDs - states: Filter by order states - cursor: Pagination cursor - limit: Maximum results - format: Response format Returns: Paginated list of orders.
square_pay_orderPay for an order using one or more payment IDs. Args: - order_id: Order ID to pay - payment_ids: Array of payment IDs Returns: The paid order.
square_list_paymentsList payments from Square with pagination. Returns a paginated list of payments. Use the cursor from the response to fetch the next page. Args: - begin_time: Start of time range (RFC 3339) - end_time: End of time range (RFC 3339) - location_id: Filter by location - cursor: Pagination cursor - limit: Number of payments to return (1-100, default: 20) - format: Response format ('json' or 'markdown') Returns: JSON format: { items: Payment[], count, hasMore, nextCursor }
square_get_paymentGet a single payment by ID. Args: - payment_id: The payment ID - format: Response format ('json' or 'markdown') Returns: The payment record with all available fields.
square_create_paymentCreate a new payment. Args: - source_id: Payment source ID (card nonce, card ID, or 'CASH') - amount_money: Amount to charge { amount: number (in cents), currency: string } - location_id: Location ID (uses default if not provided) - customer_id: Customer ID to associate with payment - reference_id: Reference ID from external system - note: Note for the payment - autocomplete: Whether to auto-complete (default: true) - buyer_email_address: Buyer's email for receipt Returns: The created payment record.
square_complete_paymentComplete a payment that was created with autocomplete=false. Args: - payment_id: Payment ID to complete Returns: The completed payment record.
square_cancel_paymentCancel a payment that has not been completed. Args: - payment_id: Payment ID to cancel Returns: The cancelled payment record.
square_list_refundsList refunds from Square with pagination. Args: - begin_time: Start of time range (RFC 3339) - end_time: End of time range (RFC 3339) - location_id: Filter by location - cursor: Pagination cursor - limit: Number of refunds to return - format: Response format Returns: Paginated list of refunds.
square_refund_paymentRefund a payment. Args: - payment_id: Payment ID to refund - amount_money: Amount to refund { amount: number (in cents), currency: string } - reason: Reason for refund Returns: The created refund record.
square_list_subscriptionsList subscriptions. Args: - customer_id: Filter by customer - location_id: Filter by location - cursor: Pagination cursor - limit: Maximum results - format: Response format Returns: Paginated list of subscriptions.
square_get_subscriptionGet a single subscription by ID. Args: - subscription_id: Subscription ID - format: Response format Returns: The subscription record.
square_create_subscriptionCreate a new subscription. Args: - location_id: Location ID - customer_id: Customer ID - plan_variation_id: Plan variation ID - start_date: Start date (YYYY-MM-DD) - card_id: Card ID for payment - timezone: Timezone Returns: The created subscription.
square_update_subscriptionUpdate an existing subscription. Args: - subscription_id: Subscription ID - card_id: New card ID - version: Subscription version Returns: The updated subscription.
square_cancel_subscriptionCancel a subscription. Args: - subscription_id: Subscription ID to cancel Returns: The cancelled subscription.
square_pause_subscriptionPause a subscription. Args: - subscription_id: Subscription ID to pause Returns: The paused subscription.
square_resume_subscriptionResume a paused subscription. Args: - subscription_id: Subscription ID to resume Returns: The resumed subscription.
square_list_team_membersList team members. Args: - status: Filter by status (ACTIVE or INACTIVE) - location_ids: Filter by location IDs - cursor: Pagination cursor - limit: Maximum results - format: Response format Returns: Paginated list of team members.
square_get_team_memberGet a team member by ID. Args: - team_member_id: Team member ID - format: Response format Returns: The team member.
square_create_team_memberCreate a new team member. Args: - given_name: First name - family_name: Last name - email_address: Email address - phone_number: Phone number - status: Status (ACTIVE or INACTIVE) - location_ids: Assigned location IDs Returns: The created team member.
square_update_team_memberUpdate a team member. Args: - team_member_id: Team member ID - given_name: New first name - family_name: New last name - email_address: New email - phone_number: New phone number - status: New status Returns: The updated team member.
square_create_terminal_actionCreate a Terminal action. Args: - device_id: Device ID to target - deadline_duration: Deadline for the action - save_card_options: Save card details - receipt_options: Receipt details - confirmation_options: Confirmation options - select_options: Select options - signature_options: Signature options - data_collection_options: Data collection options - qr_code_options: QR code options Returns: The created Terminal action.
square_get_terminal_actionGet a Terminal action by ID. Args: - action_id: Terminal action ID - format: Response format Returns: The Terminal action.
square_search_terminal_actionsSearch for Terminal actions. Args: - query: Search query with filters - cursor: Pagination cursor - limit: Maximum results - format: Response format Returns: List of Terminal actions.
square_cancel_terminal_actionCancel a Terminal action. Args: - action_id: Terminal action ID to cancel Returns: The cancelled Terminal action.
square_create_terminal_checkoutCreate a Terminal checkout to take a payment. Args: - amount_money: Amount to charge - device_options: Device configuration - device_id: Device ID - skip_receipt_screen: Skip receipt screen - collect_signature: Collect signature - tip_settings: Tip settings - show_itemized_cart: Show itemized cart - reference_id: Reference ID - note: Note for the checkout - order_id: Order ID to link - payment_options: Payment options - customer_id: Customer ID - app_fee_money: App fee amount - deadline_duration: Deadline in ISO 8601 format - payment_type: Payment type Returns: The created Terminal checkout.
square_get_terminal_checkoutGet a Terminal checkout by ID. Args: - checkout_id: Terminal checkout ID - format: Response format Returns: The Terminal checkout.
square_search_terminal_checkoutsSearch for Terminal checkouts. Args: - query: Search query with filters - cursor: Pagination cursor - limit: Maximum results - format: Response format Returns: List of Terminal checkouts.
square_cancel_terminal_checkoutCancel a Terminal checkout. Args: - checkout_id: Terminal checkout ID to cancel Returns: The cancelled Terminal checkout.
square_create_terminal_refundCreate a Terminal refund. Args: - payment_id: Payment ID to refund - amount_money: Amount to refund - reason: Reason for refund - device_id: Device ID for the refund - deadline_duration: Deadline in ISO 8601 format Returns: The created Terminal refund.
square_get_terminal_refundGet a Terminal refund by ID. Args: - terminal_refund_id: Terminal refund ID - format: Response format Returns: The Terminal refund.
square_cancel_terminal_refundCancel a Terminal refund. Args: - terminal_refund_id: Terminal refund ID to cancel Returns: The cancelled Terminal refund.
square_list_merchants{
"format": "example_format"
}square_get_cash_drawer_shift{
"format": "example_format",
"shift_id": "example_shift_id",
"location_id": "example_location_id"
}square_get_merchant{
"format": "example_format",
"merchant_id": "example_merchant_id"
}