Square

Square MCP Server for Cloudflare Workers

Available Tools

103 tools available in the Square MCP server. Each tool can be called by AI assistants to perform specific actions.

square_list_merchants

List merchants associated with the access token.

Args:

format: Response format

Returns: List of merchants.

{
  "type": "object",
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    }
  }
}

square_get_cash_drawer_shift

Get a cash drawer shift by ID.

Args:

location_id: Location ID
shift_id: Shift ID
format: Response format

Returns: The cash drawer shift.

{
  "type": "object",
  "required": [
    "location_id",
    "shift_id"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "shift_id": {
      "type": "string",
      "description": "Shift ID"
    },
    "location_id": {
      "type": "string",
      "description": "Location ID"
    }
  }
}

square_get_merchant

Get merchant information.

Args:

merchant_id: Merchant ID (use 'me' for current merchant)
format: Response format

Returns: The merchant record.

{
  "type": "object",
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "merchant_id": {
      "type": "string",
      "default": "me",
      "description": "Merchant ID"
    }
  }
}

square_get_booking

Get a single booking by ID.

Args:

booking_id: Booking ID
format: Response format

Returns: The booking record.

{
  "type": "object",
  "required": [
    "booking_id"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "booking_id": {
      "type": "string",
      "description": "Booking ID"
    }
  }
}

square_list_bank_accounts

List 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.

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "default": 20,
      "maximum": 100,
      "minimum": 1
    },
    "cursor": {
      "type": "string"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "location_id": {
      "type": "string"
    }
  }
}

square_get_bank_account

Get a bank account by ID.

Args:

bank_account_id: Bank account ID
format: Response format

Returns: The bank account record.

{
  "type": "object",
  "required": [
    "bank_account_id"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "bank_account_id": {
      "type": "string",
      "description": "Bank account ID"
    }
  }
}

square_get_bank_account_by_v1_id

Get a bank account by its V1 ID.

Args:

v1_bank_account_id: V1 bank account ID
format: Response format

Returns: The bank account record.

{
  "type": "object",
  "required": [
    "v1_bank_account_id"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "v1_bank_account_id": {
      "type": "string",
      "description": "V1 bank account ID"
    }
  }
}

square_list_payouts

List 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.

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "default": 20,
      "maximum": 100,
      "minimum": 1
    },
    "cursor": {
      "type": "string"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "status": {
      "enum": [
        "SENT",
        "FAILED",
        "PAID"
      ],
      "type": "string"
    },
    "end_time": {
      "type": "string"
    },
    "begin_time": {
      "type": "string"
    },
    "location_id": {
      "type": "string"
    }
  }
}

square_get_payout

Get a payout by ID.

Args:

payout_id: Payout ID
format: Response format

Returns: The payout record.

{
  "type": "object",
  "required": [
    "payout_id"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "payout_id": {
      "type": "string",
      "description": "Payout ID"
    }
  }
}

square_list_disputes

List 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.

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "default": 20,
      "maximum": 100,
      "minimum": 1
    },
    "cursor": {
      "type": "string"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "states": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "location_id": {
      "type": "string"
    }
  }
}

square_get_dispute

Get a dispute by ID.

Args:

dispute_id: Dispute ID
format: Response format

Returns: The dispute record.

{
  "type": "object",
  "required": [
    "dispute_id"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "dispute_id": {
      "type": "string",
      "description": "Dispute ID"
    }
  }
}

square_accept_dispute

Accept a dispute (concede to the cardholder).

Args:

dispute_id: Dispute ID to accept

Returns: The accepted dispute.

{
  "type": "object",
  "required": [
    "dispute_id"
  ],
  "properties": {
    "dispute_id": {
      "type": "string",
      "description": "Dispute ID"
    }
  }
}

square_list_vendors

List vendors.

Args:

cursor: Pagination cursor
limit: Maximum results
format: Response format

Returns: List of vendors.

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "default": 20,
      "maximum": 100,
      "minimum": 1
    },
    "cursor": {
      "type": "string"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    }
  }
}

square_get_vendor

Get a vendor by ID.

Args:

vendor_id: Vendor ID
format: Response format

Returns: The vendor record.

{
  "type": "object",
  "required": [
    "vendor_id"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "vendor_id": {
      "type": "string",
      "description": "Vendor ID"
    }
  }
}

square_create_vendor

Create 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.

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Vendor name"
    },
    "note": {
      "type": "string"
    },
    "status": {
      "enum": [
        "ACTIVE",
        "INACTIVE"
      ],
      "type": "string"
    },
    "account_number": {
      "type": "string"
    }
  }
}

square_update_vendor

Update an existing vendor.

Args:

vendor_id: Vendor ID to update
vendor: Updated vendor fields

Returns: The updated vendor.

{
  "type": "object",
  "required": [
    "vendor_id"
  ],
  "properties": {
    "vendor_id": {
      "type": "string",
      "description": "Vendor ID"
    }
  }
}

square_list_cash_drawer_shifts

List 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.

{
  "type": "object",
  "required": [
    "location_id"
  ],
  "properties": {
    "limit": {
      "type": "integer",
      "default": 20,
      "maximum": 100,
      "minimum": 1
    },
    "cursor": {
      "type": "string"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "end_time": {
      "type": "string"
    },
    "begin_time": {
      "type": "string"
    },
    "location_id": {
      "type": "string",
      "description": "Location ID"
    }
  }
}

square_list_bookings

List 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.

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "default": 20,
      "maximum": 100,
      "minimum": 1
    },
    "cursor": {
      "type": "string"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "location_id": {
      "type": "string"
    },
    "start_at_max": {
      "type": "string"
    },
    "start_at_min": {
      "type": "string"
    },
    "team_member_id": {
      "type": "string"
    }
  }
}

square_create_booking

Create 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.

{
  "type": "object",
  "required": [
    "start_at"
  ],
  "properties": {
    "start_at": {
      "type": "string",
      "description": "Booking start time (RFC 3339)"
    },
    "customer_id": {
      "type": "string"
    },
    "location_id": {
      "type": "string"
    },
    "seller_note": {
      "type": "string"
    },
    "customer_note": {
      "type": "string"
    }
  }
}

square_update_booking

Update 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.

{
  "type": "object",
  "required": [
    "booking_id"
  ],
  "properties": {
    "version": {
      "type": "number"
    },
    "start_at": {
      "type": "string"
    },
    "booking_id": {
      "type": "string",
      "description": "Booking ID"
    },
    "seller_note": {
      "type": "string"
    },
    "customer_note": {
      "type": "string"
    }
  }
}

square_cancel_booking

Cancel a booking.

Args:

booking_id: Booking ID to cancel
version: Booking version (optional)

Returns: The cancelled booking.

{
  "type": "object",
  "required": [
    "booking_id"
  ],
  "properties": {
    "version": {
      "type": "number"
    },
    "booking_id": {
      "type": "string",
      "description": "Booking ID"
    }
  }
}

square_list_catalog

List 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.

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "default": 20,
      "maximum": 100,
      "minimum": 1
    },
    "types": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "cursor": {
      "type": "string"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    }
  }
}

square_get_catalog_object

Get a catalog object by ID.

Args:

object_id: Catalog object ID
include_related_objects: Include related objects
format: Response format

Returns: The catalog object.

{
  "type": "object",
  "required": [
    "object_id"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "object_id": {
      "type": "string",
      "description": "Catalog object ID"
    },
    "include_related_objects": {
      "type": "boolean",
      "default": false
    }
  }
}

square_search_catalog_objects

Search 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.

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "default": 20,
      "maximum": 100,
      "minimum": 1
    },
    "cursor": {
      "type": "string"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "text_query": {
      "type": "string",
      "description": "Text to search for"
    },
    "object_types": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}

square_upsert_catalog_object

Create 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.

{
  "type": "object",
  "required": [
    "id",
    "id"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "sku": {
      "type": "string"
    },
    "object": {
      "type": "object",
      "description": "Object ID (use #temp_id for new objects)"
    },
    "tax_ids": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "tax_data": {
      "type": "object"
    },
    "item_data": {
      "type": "object"
    },
    "percentage": {
      "type": "string"
    },
    "variations": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "category_id": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "pricing_type": {
      "enum": [
        "FIXED_PRICING",
        "VARIABLE_PRICING"
      ],
      "type": "string"
    },
    "category_data": {
      "type": "object"
    },
    "discount_data": {
      "type": "object"
    },
    "discount_type": {
      "enum": [
        "FIXED_PERCENTAGE",
        "FIXED_AMOUNT",
        "VARIABLE_PERCENTAGE",
        "VARIABLE_AMOUNT"
      ],
      "type": "string"
    },
    "inclusion_type": {
      "enum": [
        "ADDITIVE",
        "INCLUSIVE"
      ],
      "type": "string"
    },
    "item_variation_data": {
      "type": "object"
    },
    "present_at_location_ids": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "present_at_all_locations": {
      "type": "boolean"
    }
  }
}

square_delete_catalog_object

Delete a catalog object.

Args:

object_id: Catalog object ID to delete

Returns: Confirmation of deletion.

{
  "type": "object",
  "required": [
    "object_id"
  ],
  "properties": {
    "object_id": {
      "type": "string",
      "description": "Catalog object ID"
    }
  }
}

square_batch_delete_catalog_objects

Delete multiple catalog objects.

Args:

object_ids: Array of catalog object IDs to delete

Returns: Confirmation of deletion.

{
  "type": "object",
  "required": [
    "object_ids"
  ],
  "properties": {
    "object_ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Catalog object IDs"
    }
  }
}

square_batch_upsert_catalog_objects

Create or update multiple catalog objects.

Args:

objects: Array of catalog objects to upsert

Returns: The upserted catalog objects.

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "objects": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "tax_data": {},
    "item_data": {},
    "category_data": {},
    "discount_data": {},
    "present_at_all_locations": {
      "type": "boolean"
    }
  }
}

square_list_gift_card_activities

List 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.

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "default": 20,
      "maximum": 100,
      "minimum": 1
    },
    "cursor": {
      "type": "string"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "gift_card_id": {
      "type": "string"
    }
  }
}

square_get_refund

Get a single refund by ID.

Args:

refund_id: The refund ID
format: Response format

Returns: The refund record.

{
  "type": "object",
  "required": [
    "refund_id"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "refund_id": {
      "type": "string",
      "description": "Refund ID"
    }
  }
}

square_list_customers

List 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 }

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "default": 20,
      "maximum": 100,
      "minimum": 1,
      "description": "Number of customers to return"
    },
    "cursor": {
      "type": "string",
      "description": "Pagination cursor"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "sort_field": {
      "enum": [
        "CREATED_AT",
        "DEFAULT"
      ],
      "type": "string"
    },
    "sort_order": {
      "enum": [
        "ASC",
        "DESC"
      ],
      "type": "string"
    }
  }
}

square_get_customer

Get 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.

{
  "type": "object",
  "required": [
    "customer_id"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "customer_id": {
      "type": "string",
      "description": "Customer ID"
    }
  }
}

square_create_customer

Create 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.

{
  "type": "object",
  "properties": {
    "note": {
      "type": "string"
    },
    "birthday": {
      "type": "string",
      "description": "Birthday (YYYY-MM-DD)"
    },
    "nickname": {
      "type": "string"
    },
    "given_name": {
      "type": "string",
      "description": "First name"
    },
    "family_name": {
      "type": "string",
      "description": "Last name"
    },
    "company_name": {
      "type": "string"
    },
    "phone_number": {
      "type": "string",
      "description": "Phone number"
    },
    "reference_id": {
      "type": "string"
    },
    "email_address": {
      "type": "string",
      "description": "Email address"
    }
  }
}

square_update_customer

Update 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.

{
  "type": "object",
  "required": [
    "customer_id"
  ],
  "properties": {
    "note": {
      "type": "string"
    },
    "birthday": {
      "type": "string"
    },
    "nickname": {
      "type": "string"
    },
    "given_name": {
      "type": "string"
    },
    "customer_id": {
      "type": "string",
      "description": "Customer ID to update"
    },
    "family_name": {
      "type": "string"
    },
    "company_name": {
      "type": "string"
    },
    "phone_number": {
      "type": "string"
    },
    "email_address": {
      "type": "string"
    }
  }
}

square_delete_customer

Delete a customer from Square.

Args:

customer_id: Customer ID to delete

Returns: Confirmation of deletion.

{
  "type": "object",
  "required": [
    "customer_id"
  ],
  "properties": {
    "customer_id": {
      "type": "string",
      "description": "Customer ID to delete"
    }
  }
}

square_search_customers

Search 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.

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "default": 20,
      "maximum": 100,
      "minimum": 1
    },
    "cursor": {
      "type": "string"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    }
  }
}

square_list_customer_groups

List all customer groups.

Args:

cursor: Pagination cursor
limit: Maximum results
format: Response format

Returns: List of customer groups.

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "default": 20,
      "maximum": 100,
      "minimum": 1
    },
    "cursor": {
      "type": "string"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    }
  }
}

square_create_customer_group

Create a new customer group.

Args:

name: Group name

Returns: The created customer group.

{
  "type": "object",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Group name"
    }
  }
}

square_list_gift_cards

List 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.

{
  "type": "object",
  "properties": {
    "type": {
      "enum": [
        "DIGITAL",
        "PHYSICAL"
      ],
      "type": "string"
    },
    "limit": {
      "type": "integer",
      "default": 20,
      "maximum": 100,
      "minimum": 1
    },
    "state": {
      "enum": [
        "ACTIVE",
        "DEACTIVATED",
        "PENDING",
        "BLOCKED"
      ],
      "type": "string"
    },
    "cursor": {
      "type": "string"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    }
  }
}

square_get_gift_card

Get a gift card by ID.

Args:

gift_card_id: Gift card ID
format: Response format

Returns: The gift card.

{
  "type": "object",
  "required": [
    "gift_card_id"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "gift_card_id": {
      "type": "string",
      "description": "Gift card ID"
    }
  }
}

square_get_gift_card_by_gan

Get a gift card by GAN (Gift card Account Number).

Args:

gan: Gift card account number
format: Response format

Returns: The gift card.

{
  "type": "object",
  "required": [
    "gan"
  ],
  "properties": {
    "gan": {
      "type": "string",
      "description": "Gift card account number"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    }
  }
}

square_create_gift_card

Create a new gift card.

Args:

type: Gift card type (DIGITAL or PHYSICAL)
location_id: Location ID

Returns: The created gift card.

{
  "type": "object",
  "required": [
    "type",
    "location_id"
  ],
  "properties": {
    "type": {
      "enum": [
        "DIGITAL",
        "PHYSICAL"
      ],
      "type": "string",
      "description": "Gift card type"
    },
    "location_id": {
      "type": "string",
      "description": "Location ID"
    }
  }
}

square_link_customer_to_gift_card

Link a customer to a gift card.

Args:

gift_card_id: Gift card ID
customer_id: Customer ID

Returns: The updated gift card.

{
  "type": "object",
  "required": [
    "gift_card_id",
    "customer_id"
  ],
  "properties": {
    "customer_id": {
      "type": "string",
      "description": "Customer ID"
    },
    "gift_card_id": {
      "type": "string",
      "description": "Gift card ID"
    }
  }
}

square_unlink_customer_from_gift_card

Unlink a customer from a gift card.

Args:

gift_card_id: Gift card ID
customer_id: Customer ID

Returns: The updated gift card.

{
  "type": "object",
  "required": [
    "gift_card_id",
    "customer_id"
  ],
  "properties": {
    "customer_id": {
      "type": "string",
      "description": "Customer ID"
    },
    "gift_card_id": {
      "type": "string",
      "description": "Gift card ID"
    }
  }
}

square_create_gift_card_activity

Create 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.

{
  "type": "object",
  "required": [
    "gift_card_id",
    "location_id"
  ],
  "properties": {
    "location_id": {
      "type": "string",
      "description": "Location ID"
    },
    "gift_card_id": {
      "type": "string",
      "description": "Gift card ID"
    },
    "activity_type": {
      "enum": [
        "ACTIVATE",
        "LOAD",
        "REDEEM",
        "CLEAR_BALANCE",
        "DEACTIVATE"
      ],
      "type": "string",
      "description": "Activity type"
    }
  }
}

square_get_inventory_count

Get 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.

{
  "type": "object",
  "required": [
    "catalog_object_id"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "location_ids": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "catalog_object_id": {
      "type": "string",
      "description": "Catalog object ID"
    }
  }
}

square_batch_get_inventory_counts

Get 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.

{
  "type": "object",
  "required": [
    "catalog_object_ids"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "location_ids": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "catalog_object_ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Catalog object IDs"
    }
  }
}

square_batch_change_inventory

Batch 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.

{
  "type": "object",
  "properties": {
    "state": {
      "type": "string"
    },
    "changes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Inventory changes"
    },
    "quantity": {
      "type": "string"
    },
    "to_state": {
      "type": "string"
    },
    "transfer": {
      "type": "object"
    },
    "adjustment": {
      "type": "object"
    },
    "from_state": {
      "type": "string"
    },
    "location_id": {
      "type": "string"
    },
    "occurred_at": {
      "type": "string"
    },
    "reference_id": {
      "type": "string"
    },
    "physical_count": {
      "type": "object"
    },
    "to_location_id": {
      "type": "string"
    },
    "from_location_id": {
      "type": "string"
    }
  }
}

square_list_invoices

List invoices for a location.

Args:

location_id: Location ID
cursor: Pagination cursor
limit: Maximum results
format: Response format

Returns: Paginated list of invoices.

{
  "type": "object",
  "required": [
    "location_id"
  ],
  "properties": {
    "limit": {
      "type": "integer",
      "default": 20,
      "maximum": 100,
      "minimum": 1
    },
    "cursor": {
      "type": "string"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "location_id": {
      "type": "string",
      "description": "Location ID"
    }
  }
}

square_get_invoice

Get a single invoice by ID.

Args:

invoice_id: Invoice ID
format: Response format

Returns: The invoice record.

{
  "type": "object",
  "required": [
    "invoice_id"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "invoice_id": {
      "type": "string",
      "description": "Invoice ID"
    }
  }
}

square_create_invoice

Create 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.

{
  "type": "object",
  "required": [
    "location_id"
  ],
  "properties": {
    "title": {
      "type": "string"
    },
    "order_id": {
      "type": "string",
      "description": "Order ID"
    },
    "customer_id": {
      "type": "string",
      "description": "Customer ID"
    },
    "description": {
      "type": "string"
    },
    "location_id": {
      "type": "string",
      "description": "Location ID"
    },
    "invoice_number": {
      "type": "string"
    },
    "delivery_method": {
      "enum": [
        "EMAIL",
        "SHARE_MANUALLY",
        "SMS"
      ],
      "type": "string"
    }
  }
}

square_update_invoice

Update 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.

{
  "type": "object",
  "required": [
    "invoice_id",
    "version"
  ],
  "properties": {
    "title": {
      "type": "string"
    },
    "version": {
      "type": "number",
      "description": "Invoice version"
    },
    "invoice_id": {
      "type": "string",
      "description": "Invoice ID"
    },
    "description": {
      "type": "string"
    },
    "delivery_method": {
      "enum": [
        "EMAIL",
        "SHARE_MANUALLY",
        "SMS"
      ],
      "type": "string"
    }
  }
}

square_delete_invoice

Delete an invoice.

Args:

invoice_id: Invoice ID to delete

Returns: Confirmation of deletion.

{
  "type": "object",
  "required": [
    "invoice_id"
  ],
  "properties": {
    "invoice_id": {
      "type": "string",
      "description": "Invoice ID"
    }
  }
}

square_publish_invoice

Publish a draft invoice.

Args:

invoice_id: Invoice ID to publish
version: Invoice version (required for concurrency)

Returns: The published invoice.

{
  "type": "object",
  "required": [
    "invoice_id",
    "version"
  ],
  "properties": {
    "version": {
      "type": "number",
      "description": "Invoice version"
    },
    "invoice_id": {
      "type": "string",
      "description": "Invoice ID"
    }
  }
}

square_cancel_invoice

Cancel an invoice.

Args:

invoice_id: Invoice ID to cancel
version: Invoice version (required for concurrency)

Returns: The cancelled invoice.

{
  "type": "object",
  "required": [
    "invoice_id",
    "version"
  ],
  "properties": {
    "version": {
      "type": "number",
      "description": "Invoice version"
    },
    "invoice_id": {
      "type": "string",
      "description": "Invoice ID"
    }
  }
}

square_list_locations

List 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.

{
  "type": "object",
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    }
  }
}

square_get_location

Get 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.

{
  "type": "object",
  "required": [
    "location_id"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "location_id": {
      "type": "string",
      "description": "Location ID"
    }
  }
}

square_update_order

Update an existing order.

Args:

order_id: Order ID to update
state: New order state
version: Order version

Returns: The updated order.

{
  "type": "object",
  "required": [
    "order_id"
  ],
  "properties": {
    "state": {
      "enum": [
        "OPEN",
        "COMPLETED",
        "CANCELED",
        "DRAFT"
      ],
      "type": "string"
    },
    "version": {
      "type": "number"
    },
    "order_id": {
      "type": "string",
      "description": "Order ID"
    }
  }
}

square_create_location

Create 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.

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Business name for the location"
    },
    "timezone": {
      "type": "string",
      "description": "IANA timezone"
    },
    "description": {
      "type": "string"
    },
    "website_url": {
      "type": "string"
    },
    "phone_number": {
      "type": "string"
    },
    "business_email": {
      "type": "string"
    }
  }
}

square_update_location

Update 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.

{
  "type": "object",
  "required": [
    "location_id"
  ],
  "properties": {
    "name": {
      "type": "string"
    },
    "status": {
      "enum": [
        "ACTIVE",
        "INACTIVE"
      ],
      "type": "string"
    },
    "timezone": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "location_id": {
      "type": "string",
      "description": "Location ID to update"
    },
    "website_url": {
      "type": "string"
    },
    "phone_number": {
      "type": "string"
    },
    "business_email": {
      "type": "string"
    }
  }
}

square_get_loyalty_program

Get a loyalty program by ID.

Args:

program_id: Loyalty program ID
format: Response format

Returns: The loyalty program.

{
  "type": "object",
  "required": [
    "program_id"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "program_id": {
      "type": "string",
      "description": "Loyalty program ID"
    }
  }
}

square_list_loyalty_programs

List all loyalty programs.

Args:

format: Response format

Returns: List of loyalty programs.

{
  "type": "object",
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    }
  }
}

square_create_loyalty_account

Create a loyalty account.

Args:

program_id: Loyalty program ID
phone_number: Customer phone number

Returns: The created loyalty account.

{
  "type": "object",
  "required": [
    "program_id"
  ],
  "properties": {
    "program_id": {
      "type": "string",
      "description": "Loyalty program ID"
    },
    "phone_number": {
      "type": "string",
      "description": "Customer phone number"
    }
  }
}

square_get_loyalty_account

Get a loyalty account by ID.

Args:

account_id: Loyalty account ID
format: Response format

Returns: The loyalty account.

{
  "type": "object",
  "required": [
    "account_id"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "account_id": {
      "type": "string",
      "description": "Loyalty account ID"
    }
  }
}

square_search_loyalty_accounts

Search 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.

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "default": 20,
      "maximum": 100,
      "minimum": 1
    },
    "cursor": {
      "type": "string"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "customer_id": {
      "type": "string"
    },
    "phone_number": {
      "type": "string"
    }
  }
}

square_accumulate_loyalty_points

Accumulate 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.

{
  "type": "object",
  "required": [
    "account_id",
    "points"
  ],
  "properties": {
    "points": {
      "type": "integer",
      "description": "Points to accumulate"
    },
    "order_id": {
      "type": "string"
    },
    "account_id": {
      "type": "string",
      "description": "Loyalty account ID"
    }
  }
}

square_adjust_loyalty_points

Adjust 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.

{
  "type": "object",
  "required": [
    "account_id",
    "points",
    "reason"
  ],
  "properties": {
    "points": {
      "type": "integer",
      "description": "Points adjustment"
    },
    "reason": {
      "type": "string",
      "description": "Reason for adjustment"
    },
    "account_id": {
      "type": "string",
      "description": "Loyalty account ID"
    }
  }
}

square_create_loyalty_reward

Create a loyalty reward.

Args:

loyalty_account_id: Loyalty account ID
reward_tier_id: Reward tier ID

Returns: The created loyalty reward.

{
  "type": "object",
  "required": [
    "loyalty_account_id",
    "reward_tier_id"
  ],
  "properties": {
    "reward_tier_id": {
      "type": "string",
      "description": "Reward tier ID"
    },
    "loyalty_account_id": {
      "type": "string",
      "description": "Loyalty account ID"
    }
  }
}

square_redeem_loyalty_reward

Redeem a loyalty reward.

Args:

reward_id: Reward ID to redeem
location_id: Location ID

Returns: The redeemed loyalty reward.

{
  "type": "object",
  "required": [
    "reward_id",
    "location_id"
  ],
  "properties": {
    "reward_id": {
      "type": "string",
      "description": "Reward ID"
    },
    "location_id": {
      "type": "string",
      "description": "Location ID"
    }
  }
}

square_delete_loyalty_reward

Delete a loyalty reward.

Args:

reward_id: Reward ID to delete

Returns: Confirmation of deletion.

{
  "type": "object",
  "required": [
    "reward_id"
  ],
  "properties": {
    "reward_id": {
      "type": "string",
      "description": "Reward ID"
    }
  }
}

square_create_order

Create 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.

{
  "type": "object",
  "required": [
    "location_id"
  ],
  "properties": {
    "line_items": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "customer_id": {
      "type": "string"
    },
    "location_id": {
      "type": "string",
      "description": "Location ID"
    },
    "reference_id": {
      "type": "string"
    }
  }
}

square_get_order

Get a single order by ID.

Args:

order_id: The order ID
format: Response format

Returns: The order record.

{
  "type": "object",
  "required": [
    "order_id"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "order_id": {
      "type": "string",
      "description": "Order ID"
    }
  }
}

square_search_orders

Search 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.

{
  "type": "object",
  "required": [
    "location_ids"
  ],
  "properties": {
    "limit": {
      "type": "integer",
      "default": 20,
      "maximum": 100,
      "minimum": 1
    },
    "cursor": {
      "type": "string"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "states": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "location_ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Location IDs to search"
    }
  }
}

square_pay_order

Pay 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.

{
  "type": "object",
  "required": [
    "order_id",
    "payment_ids"
  ],
  "properties": {
    "order_id": {
      "type": "string",
      "description": "Order ID"
    },
    "payment_ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Payment IDs"
    }
  }
}

square_list_payments

List 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 }

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "default": 20,
      "maximum": 100,
      "minimum": 1
    },
    "cursor": {
      "type": "string"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "end_time": {
      "type": "string",
      "description": "End of time range (RFC 3339)"
    },
    "begin_time": {
      "type": "string",
      "description": "Start of time range (RFC 3339)"
    },
    "location_id": {
      "type": "string",
      "description": "Filter by location"
    }
  }
}

square_get_payment

Get 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.

{
  "type": "object",
  "required": [
    "payment_id"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "payment_id": {
      "type": "string",
      "description": "Payment ID"
    }
  }
}

square_create_payment

Create 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.

{
  "type": "object",
  "required": [
    "source_id"
  ],
  "properties": {
    "note": {
      "type": "string"
    },
    "source_id": {
      "type": "string",
      "description": "Payment source ID"
    },
    "customer_id": {
      "type": "string"
    },
    "location_id": {
      "type": "string"
    },
    "autocomplete": {
      "type": "boolean",
      "default": true
    },
    "reference_id": {
      "type": "string"
    },
    "buyer_email_address": {
      "type": "string"
    }
  }
}

square_complete_payment

Complete a payment that was created with autocomplete=false.

Args:

payment_id: Payment ID to complete

Returns: The completed payment record.

{
  "type": "object",
  "required": [
    "payment_id"
  ],
  "properties": {
    "payment_id": {
      "type": "string",
      "description": "Payment ID"
    }
  }
}

square_cancel_payment

Cancel a payment that has not been completed.

Args:

payment_id: Payment ID to cancel

Returns: The cancelled payment record.

{
  "type": "object",
  "required": [
    "payment_id"
  ],
  "properties": {
    "payment_id": {
      "type": "string",
      "description": "Payment ID"
    }
  }
}

square_list_refunds

List 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.

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "default": 20,
      "maximum": 100,
      "minimum": 1
    },
    "cursor": {
      "type": "string"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "end_time": {
      "type": "string"
    },
    "begin_time": {
      "type": "string"
    },
    "location_id": {
      "type": "string"
    }
  }
}

square_refund_payment

Refund 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.

{
  "type": "object",
  "required": [
    "payment_id"
  ],
  "properties": {
    "reason": {
      "type": "string",
      "description": "Reason for refund"
    },
    "payment_id": {
      "type": "string",
      "description": "Payment ID to refund"
    }
  }
}

square_list_subscriptions

List 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.

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "default": 20,
      "maximum": 100,
      "minimum": 1
    },
    "cursor": {
      "type": "string"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "customer_id": {
      "type": "string"
    },
    "location_id": {
      "type": "string"
    }
  }
}

square_get_subscription

Get a single subscription by ID.

Args:

subscription_id: Subscription ID
format: Response format

Returns: The subscription record.

{
  "type": "object",
  "required": [
    "subscription_id"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "subscription_id": {
      "type": "string",
      "description": "Subscription ID"
    }
  }
}

square_create_subscription

Create 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.

{
  "type": "object",
  "required": [
    "location_id",
    "customer_id",
    "plan_variation_id"
  ],
  "properties": {
    "card_id": {
      "type": "string"
    },
    "timezone": {
      "type": "string"
    },
    "start_date": {
      "type": "string"
    },
    "customer_id": {
      "type": "string",
      "description": "Customer ID"
    },
    "location_id": {
      "type": "string",
      "description": "Location ID"
    },
    "plan_variation_id": {
      "type": "string",
      "description": "Plan variation ID"
    }
  }
}

square_update_subscription

Update an existing subscription.

Args:

subscription_id: Subscription ID
card_id: New card ID
version: Subscription version

Returns: The updated subscription.

{
  "type": "object",
  "required": [
    "subscription_id"
  ],
  "properties": {
    "card_id": {
      "type": "string"
    },
    "version": {
      "type": "number"
    },
    "subscription_id": {
      "type": "string",
      "description": "Subscription ID"
    }
  }
}

square_cancel_subscription

Cancel a subscription.

Args:

subscription_id: Subscription ID to cancel

Returns: The cancelled subscription.

{
  "type": "object",
  "required": [
    "subscription_id"
  ],
  "properties": {
    "subscription_id": {
      "type": "string",
      "description": "Subscription ID"
    }
  }
}

square_pause_subscription

Pause a subscription.

Args:

subscription_id: Subscription ID to pause

Returns: The paused subscription.

{
  "type": "object",
  "required": [
    "subscription_id"
  ],
  "properties": {
    "subscription_id": {
      "type": "string",
      "description": "Subscription ID"
    }
  }
}

square_resume_subscription

Resume a paused subscription.

Args:

subscription_id: Subscription ID to resume

Returns: The resumed subscription.

{
  "type": "object",
  "required": [
    "subscription_id"
  ],
  "properties": {
    "subscription_id": {
      "type": "string",
      "description": "Subscription ID"
    }
  }
}

square_list_team_members

List 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.

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "default": 20,
      "maximum": 100,
      "minimum": 1
    },
    "cursor": {
      "type": "string"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "status": {
      "enum": [
        "ACTIVE",
        "INACTIVE"
      ],
      "type": "string"
    },
    "location_ids": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}

square_get_team_member

Get a team member by ID.

Args:

team_member_id: Team member ID
format: Response format

Returns: The team member.

{
  "type": "object",
  "required": [
    "team_member_id"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "team_member_id": {
      "type": "string",
      "description": "Team member ID"
    }
  }
}

square_create_team_member

Create 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.

{
  "type": "object",
  "properties": {
    "status": {
      "enum": [
        "ACTIVE",
        "INACTIVE"
      ],
      "type": "string"
    },
    "given_name": {
      "type": "string"
    },
    "family_name": {
      "type": "string"
    },
    "location_ids": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "phone_number": {
      "type": "string"
    },
    "email_address": {
      "type": "string"
    }
  }
}

square_update_team_member

Update 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.

{
  "type": "object",
  "required": [
    "team_member_id"
  ],
  "properties": {
    "status": {
      "enum": [
        "ACTIVE",
        "INACTIVE"
      ],
      "type": "string"
    },
    "given_name": {
      "type": "string"
    },
    "family_name": {
      "type": "string"
    },
    "phone_number": {
      "type": "string"
    },
    "email_address": {
      "type": "string"
    },
    "team_member_id": {
      "type": "string",
      "description": "Team member ID"
    }
  }
}

square_create_terminal_action

Create 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.

{
  "type": "object",
  "required": [
    "device_id"
  ],
  "properties": {
    "device_id": {
      "type": "string",
      "description": "Device ID"
    },
    "deadline_duration": {
      "type": "string",
      "description": "Duration in ISO 8601 format"
    }
  }
}

square_get_terminal_action

Get a Terminal action by ID.

Args:

action_id: Terminal action ID
format: Response format

Returns: The Terminal action.

{
  "type": "object",
  "required": [
    "action_id"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "action_id": {
      "type": "string",
      "description": "Action ID"
    }
  }
}

square_search_terminal_actions

Search for Terminal actions.

Args:

query: Search query with filters
cursor: Pagination cursor
limit: Maximum results
format: Response format

Returns: List of Terminal actions.

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "default": 20,
      "maximum": 100,
      "minimum": 1
    },
    "cursor": {
      "type": "string"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    }
  }
}

square_cancel_terminal_action

Cancel a Terminal action.

Args:

action_id: Terminal action ID to cancel

Returns: The cancelled Terminal action.

{
  "type": "object",
  "required": [
    "action_id"
  ],
  "properties": {
    "action_id": {
      "type": "string",
      "description": "Action ID"
    }
  }
}

square_create_terminal_checkout

Create 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.

{
  "type": "object",
  "properties": {
    "note": {
      "type": "string"
    },
    "order_id": {
      "type": "string"
    },
    "customer_id": {
      "type": "string"
    },
    "payment_type": {
      "enum": [
        "CARD_PRESENT",
        "FELICA_ID",
        "FELICA_QUICPAY",
        "FELICA_TRANSPORTATION_GROUP",
        "FELICA_ALL"
      ],
      "type": "string"
    },
    "reference_id": {
      "type": "string"
    },
    "deadline_duration": {
      "type": "string"
    }
  }
}

square_get_terminal_checkout

Get a Terminal checkout by ID.

Args:

checkout_id: Terminal checkout ID
format: Response format

Returns: The Terminal checkout.

{
  "type": "object",
  "required": [
    "checkout_id"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "checkout_id": {
      "type": "string",
      "description": "Checkout ID"
    }
  }
}

square_search_terminal_checkouts

Search for Terminal checkouts.

Args:

query: Search query with filters
cursor: Pagination cursor
limit: Maximum results
format: Response format

Returns: List of Terminal checkouts.

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "default": 20,
      "maximum": 100,
      "minimum": 1
    },
    "cursor": {
      "type": "string"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    }
  }
}

square_cancel_terminal_checkout

Cancel a Terminal checkout.

Args:

checkout_id: Terminal checkout ID to cancel

Returns: The cancelled Terminal checkout.

{
  "type": "object",
  "required": [
    "checkout_id"
  ],
  "properties": {
    "checkout_id": {
      "type": "string",
      "description": "Checkout ID"
    }
  }
}

square_create_terminal_refund

Create 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.

{
  "type": "object",
  "required": [
    "payment_id",
    "device_id"
  ],
  "properties": {
    "reason": {
      "type": "string"
    },
    "device_id": {
      "type": "string",
      "description": "Device ID"
    },
    "payment_id": {
      "type": "string",
      "description": "Payment ID"
    },
    "deadline_duration": {
      "type": "string"
    }
  }
}

square_get_terminal_refund

Get a Terminal refund by ID.

Args:

terminal_refund_id: Terminal refund ID
format: Response format

Returns: The Terminal refund.

{
  "type": "object",
  "required": [
    "terminal_refund_id"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "terminal_refund_id": {
      "type": "string",
      "description": "Terminal refund ID"
    }
  }
}

square_cancel_terminal_refund

Cancel a Terminal refund.

Args:

terminal_refund_id: Terminal refund ID to cancel

Returns: The cancelled Terminal refund.

{
  "type": "object",
  "required": [
    "terminal_refund_id"
  ],
  "properties": {
    "terminal_refund_id": {
      "type": "string",
      "description": "Terminal refund ID"
    }
  }
}