Square Integration

Pro v1.0.0

Integrate with Square APIs for payments, orders, catalog, inventory, and customer management

Requires Claude Code CLI

This skill integrates with Square through Claude Code. Install Claude Code and add this skill to use it.

Available Actions

List Locations

Get all business locations associated with your Square account

Returns

array Array of location objects with details like ID, name, address, timezone, and capabilities

Try saying...

  • "Show me all my Square locations"
  • "List my business locations"
  • "What locations do I have in Square?"

List Payments

Retrieve recent payments processed through Square

Parameters

Name Type Required Description
limit integer Optional Number of payments to return
location_id string Optional Filter payments by specific location ID

Returns

array Array of payment objects with amount, status, timestamps, and metadata

Try saying...

  • "Show me the last 10 payments"
  • "List recent transactions"
  • "What are my recent Square payments?"

List Customers

Get customer profiles from your Square account

Parameters

Name Type Required Description
limit integer Optional Number of customers to return

Returns

array Array of customer objects with profile information

Try saying...

  • "Show me my customers"
  • "List all customer profiles"
  • "Get customer list from Square"

List Catalog Items

Retrieve products and items from your Square catalog

Returns

array Array of catalog item objects with product details, variations, and pricing

Try saying...

  • "Show me all catalog items"
  • "List products in my Square catalog"
  • "What items are in my catalog?"

Get Inventory Count

Check inventory levels for a specific catalog item

Parameters

Name Type Required Description
catalog_object_id string Required The catalog object ID to check inventory for

Returns

array Array of inventory count objects with quantities and states

Try saying...

  • "What's the inventory count for item X?"
  • "Check stock levels for this product"
  • "How many units do I have in stock?"

Create Payment

Process a payment through Square

Parameters

Name Type Required Description
amount integer Required Payment amount in cents (e.g., 1000 = $10.00)
source_id string Required Payment source ID (card token or nonce)
currency string Optional Currency code
location_id string Optional Location ID for the payment
idempotency_key string Optional Idempotency key (auto-generated if not provided)

Returns

object Payment object with status, receipt details, and transaction ID

Try saying...

  • "Create a payment for $10.00"
  • "Process a card payment"
  • "Charge a customer's card"

Getting Started

API Key Easy Setup
  1. 1 Sign in to Square Developer Console at https://developer.squareup.com/console
  2. 2 Create a new application or select an existing one
  3. 3 In the left pane, choose Credentials
  4. 4 At the top of the page, choose Production
  5. 5 In the Production Access token box, choose Show and copy your token
  6. 6 Add to shell config: echo 'export SQUARE_ACCESS_TOKEN="YOUR_TOKEN"' >> ~/.zshrc
  7. 7 Restart terminal or run: source ~/.zshrc

Verify Setup

python scripts/client.py list-locations

Success: Returns JSON array of locations

View full setup guide

Security & Access

Access Scope

Full access to all Square account resources including payments, customers, catalog, inventory, orders, and business settings

  • Never commit your access token to version control
  • Personal access tokens grant complete account access - treat them like passwords
  • Use Sandbox tokens for testing to avoid affecting production data
  • Consider using OAuth for third-party integrations to limit scope
  • Store tokens securely using cloud provider secrets managers
  • Rotate access tokens periodically for security

Limitations

  • Personal access tokens don't expire but should be rotated regularly
  • Sandbox environment has separate credentials and data
  • Some features require specific Square plan subscriptions
  • Payment processing requires PCI compliance considerations

Get This Skill

Requires Pro subscription ($9/month)

Quick Reference

Type
PYTHON_SDK
Auth
API Key
Setup
Easy Setup
Tools Required
Bash
Python Dependencies
squareup

Documentation

Have Feedback?

Help us improve this skill by sharing your ideas and suggestions.

Request Improvements