Square
Comprehensive Square connector for commerce operations including payments, customers, orders, catalog, inventory, invoices, subscriptions, loyalty, and gift cards.
Categories: Payment Processing, E-Commerce, Commerce, Point of Sale
What you can ask
- List transactions over $500 last week, by location.
- Issue a refund for the transaction at the SF location for
TXN-12345. - Pull total revenue by item category for Q1.
Set up
Square is ready to enable, and an admin doesn't need to create anything first.
- Go to Organization > Connectors and find Square.
- Click Enable and choose which tools to allow.
- Each member connects their own account the first time they use it.
To use one account for the whole organization, turn on Share one connection with everyone. Every member's agents then act as that account, with exactly the access it has.
You can also use your own OAuth application instead of the shared one. Create it in the Square developer portal, then enter its details under Use your own OAuth application.
Tools
Square offers 273 tools. Admins choose which ones agents can use. See Tool permission groups.
Read (134)
View and search information without changing it.
| Tool | What it does |
|---|---|
batch_get_catalog_objects | Retrieve multiple Square catalog objects in one request. |
batch_get_orders | Retrieve multiple Square orders in one request. |
bulk_get_booking_team_member_profiles | Retrieve multiple Square team member booking profiles in one request. |
bulk_get_bookings | Retrieve multiple Square bookings in one request. |
bulk_get_customers | Retrieve multiple Square customer records in one request. |
bulk_get_vendors | Retrieve the vendors whose IDs are in vendor_ids. |
calculate_loyalty_points | Estimate the loyalty points a buyer would earn for a purchase. |
calculate_order | Calculate order totals without creating an order. |
catalog_info | Retrieve the Square catalog version and object counts. |
change_billing_anchor_date | Change the date used for a subscription's monthly billing cycle. |
get_bank_account | Retrieve the Square bank account. |
get_bank_account_by_v1_id | Retrieve a bank account using its legacy Square V1 ID. |
get_booking | Get a booking by ID. |
get_booking_business_profile | Retrieve the Square seller booking business profile. |
get_booking_custom_attribute | Retrieve a custom attribute value for a booking. |
get_booking_custom_attribute_definition | Retrieve a custom attribute definition for bookings. |
get_booking_location_profile | Retrieve the Square booking location profile. |
get_booking_team_member_profile | Retrieve the Square team member booking profile. |
get_break_type | Retrieve the Square break type. |
get_card | Get a card by ID. |
get_cash_drawer_shift | Retrieve the Square cash drawer shift. |
get_catalog_object | Get a catalog object by ID. |
get_checkout_location_settings | Retrieve the Square checkout location settings. |
get_checkout_merchant_settings | Retrieve the Square checkout merchant settings. |
get_checkout_payment_link | Retrieve the Square checkout payment link. |
get_customer | Get a customer by ID. |
get_customer_custom_attribute | Retrieve a custom attribute value for a customer profile. |
get_customer_custom_attribute_definition | Retrieve a custom attribute definition for customer profiles. |
get_customer_group | Get a customer group by ID. |
get_customer_segment | Retrieve the Square customer segment. |
get_device | Retrieve the Square device. |
get_device_code | Retrieve the Square device code. |
get_dispute | Retrieve the Square dispute. |
get_dispute_evidence | Retrieve the Square dispute evidence. |
get_gift_card | Get a gift card by ID. |
get_gift_card_from_gan | Get a gift card by its GAN (gift card account number). |
get_gift_card_from_nonce | Retrieve the Square gift card associated with a payment nonce. |
get_inventory_adjustment | Retrieve the Square inventory adjustment. |
get_inventory_count | Retrieve the Square inventory count. |
get_inventory_physical_count | Retrieve the Square physical inventory count. |
get_invoice | Get an invoice by ID. |
get_location | Get a location by ID. |
get_location_custom_attribute | Retrieve a custom attribute value for a location. |
get_location_custom_attribute_definition | Retrieve a custom attribute definition for locations. |
get_loyalty_account | Get a loyalty account by ID. |
get_loyalty_program | Retrieve the Square loyalty program. |
get_loyalty_promotion | Retrieve the Square loyalty promotion. |
get_loyalty_reward | Retrieve the Square loyalty reward. |
get_merchant | Get merchant info by ID. |
get_merchant_custom_attribute | Retrieve a custom attribute value for a merchant. |
get_merchant_custom_attribute_definition | Retrieve a custom attribute definition for merchants. |
get_order | Get an order by ID. |
get_order_custom_attribute | Retrieve a custom attribute value for a order. |
get_order_custom_attribute_definition | Retrieve a custom attribute definition for orders. |
get_payment | Get a payment by ID. |
get_payout | Retrieve the Square payout. |
get_refund | Get a refund by ID. |
get_site_snippet | Retrieve the Square site snippet. |
get_subscription | Get a subscription by ID. |
get_team_job | Retrieve the Square team job. |
get_team_member | Get a team member by ID. |
get_team_member_wage | Retrieve the Square team member wage. |
get_team_member_wage_setting | Retrieve the Square team member wage setting. |
get_terminal_action | Retrieve the Square terminal action. |
get_terminal_checkout | Retrieve the Square terminal checkout. |
get_terminal_refund | Retrieve the Square terminal refund. |
get_vendor | Retrieve the Square vendor. |
get_webhook_subscription | Retrieve the Square webhook subscription. |
list_bank_accounts | List Square bank accounts. |
list_booking_custom_attribute_definitions | List definitions for custom attributes available to bookings. |
list_booking_custom_attributes | List custom attribute values for a booking. |
list_booking_location_profiles | List Square booking location profiles. |
list_bookings | List bookings. |
list_break_types | List Square break types. |
list_cards | List cards on file. |
list_cash_drawer_shift_events | List Square cash drawer shift events. |
list_cash_drawer_shifts | List Square cash drawer shifts. |
list_catalog | List catalog objects (items, categories, taxes, discounts). |
list_checkout_payment_links | List Square checkout payment links. |
list_customer_custom_attribute_definitions | List definitions for custom attributes available to customer profiles. |
list_customer_custom_attributes | List custom attribute values for a customer profile. |
list_customer_groups | List all customer groups. |
list_customer_segments | List Square customer segments. |
list_customers | List all customers with optional sorting and pagination. |
list_device_codes | List Square device codes. |
list_devices | List Square devices. |
list_dispute_evidence | List Square dispute evidences. |
list_disputes | List Square disputes. |
list_event_types | List event types supported by the Square Events API. |
list_gift_card_activities | List Square gift card activities. |
list_gift_cards | List gift cards. |
list_invoices | List invoices for a location. |
list_location_custom_attribute_definitions | List definitions for custom attributes available to locations. |
list_location_custom_attributes | List custom attribute values for a location. |
list_locations | List all business locations. |
list_loyalty_programs | List all loyalty programs. |
list_loyalty_promotions | List Square loyalty promotions. |
list_merchant_custom_attribute_definitions | List definitions for custom attributes available to merchants. |
list_merchant_custom_attributes | List custom attribute values for a merchant. |
list_merchants | List merchants associated with the access token. |
list_order_custom_attribute_definitions | List definitions for custom attributes available to orders. |
list_order_custom_attributes | List custom attribute values for a order. |
list_payments | List payments with optional filters. |
list_payout_entries | List Square payout entries. |
list_payouts | List Square payouts. |
list_refunds | List refunds with optional filters. |
list_sites | List Square sites. |
list_subscription_events | List Square subscription events. |
list_subscriptions | List subscriptions. |
list_team_jobs | List Square team jobs. |
list_team_member_booking_profiles | List team members available for booking. |
list_team_member_wages | List Square team member wages. |
list_team_members | List team members. |
list_webhook_event_types | List event types that a Square webhook subscription can receive. |
list_webhook_subscriptions | List Square webhook subscriptions. |
list_workweek_configs | List Square workweek configs. |
retrieve_inventory_changes | Get history of inventory changes. |
search_availability | Search for available booking time slots. |
search_catalog_items | Search Square for catalog items. |
search_catalog_objects | Search catalog by text (name, description, SKU), exact match, or prefix. |
search_customers | Search customers by email, phone, reference_id, or fuzzy name match. |
search_events | Search Square for Square events. |
search_invoices | Search invoices by location and optionally by customer. |
search_loyalty_accounts | Search loyalty accounts by phone, customer ID, or program. |
search_loyalty_events | Search Square for loyalty events. |
search_loyalty_rewards | Search Square for loyalty rewards. |
search_orders | Search orders by location, customer, state, or date range. |
search_team_members | Search team members by location, status, or owner flag. |
search_terminal_actions | Search Square for terminal actions. |
search_terminal_checkouts | Search Square for terminal checkouts. |
search_terminal_refunds | Search Square for terminal refunds. |
search_vendors | Search Square for vendors. |
test_webhook_subscription | Send a test event to verify webhook subscription delivery. |
validate_credential | Validate Square API credentials by listing merchants. |
Write (39)
Create or send data.
| Tool | What it does |
|---|---|
accumulate_loyalty_points | Add points to a loyalty account from a purchase. |
add_customer_to_group | Add a customer to a group. |
batch_retrieve_inventory_counts | Get inventory counts for catalog items at locations. |
bulk_create_customers | Create multiple Square customers in one request. |
bulk_create_team_members | Create multiple Square team members in one request. |
bulk_create_vendors | Create multiple Square vendors in one request. |
clone_order | Clone an existing order to create a copy. |
create_booking | Create a booking/appointment. |
create_booking_custom_attribute_definition | Create a custom attribute definition that can be used on bookings. |
create_break_type | Create a Square break type. break_type must include location_id (from list_locations), break_name, expected_duration as a duration string such as PT30M, and is_paid. |
create_card | Save a card on file for a customer. |
create_checkout_payment_link | Create a shareable Square checkout link for an order or a quick-pay amount. |
create_customer | Create a new customer profile. |
create_customer_custom_attribute_definition | Create a custom attribute definition that can be used on customer profiles. |
create_customer_group | Create a customer group for segmentation. |
create_device_code | Create a device code that lets a Square Terminal connect to the account. |
create_dispute_evidence_text | Create a Square dispute evidence text. |
create_gift_card | Create a gift card. |
create_gift_card_activity | Create a gift card activity: ACTIVATE, LOAD, REDEEM, DEACTIVATE, or ADJUST balance. |
create_invoice | Create an invoice for an order. |
create_location | Create a new business location. |
create_location_custom_attribute_definition | Create a custom attribute definition that can be used on locations. |
create_loyalty_account | Create a loyalty account for a customer. |
create_loyalty_promotion | Create a Square loyalty promotion. |
create_merchant_custom_attribute_definition | Create a custom attribute definition that can be used on merchants. |
create_order | Create an order with line items. |
create_order_custom_attribute_definition | Create a custom attribute definition that can be used on orders. |
create_payment | Create a payment to charge a customer. |
create_refund | Refund a payment. |
create_subscription | Create a subscription for recurring billing. |
create_team_job | Create a Square team job. |
create_team_member | Create a team member. |
create_terminal_action | Create an action for a Square Terminal, such as opening a cash drawer. |
create_terminal_checkout | Start a checkout on a Square Terminal. |
create_terminal_refund | Request a refund at a Square Terminal for a previously collected payment. |
create_vendor | Create a vendor in Square. |
create_webhook_subscription | Create a Square webhook subscription. |
link_customer_to_gift_card | Link a customer to a gift card. |
register_apple_pay_domain | Register a website domain for Apple Pay with Square. |
Delete or overwrite (100)
Remove or replace existing data.
| Tool | What it does |
|---|---|
accept_dispute | Accept a Square payment dispute and concede the disputed amount. |
adjust_loyalty_points | Manually adjust loyalty points. |
batch_change_inventory | Change inventory counts. |
batch_delete_catalog_objects | Delete multiple catalog objects in one request. |
batch_upsert_catalog_objects | Create or update multiple catalog objects in one request. |
bulk_delete_booking_custom_attributes | Delete the custom attribute values listed in values for one or more bookings. |
bulk_delete_customers | Delete multiple Square customers in one request. |
bulk_delete_location_custom_attributes | Delete the custom attribute values listed in values for one or more locations. |
bulk_delete_merchant_custom_attributes | Delete the custom attribute values listed in values for one or more merchants. |
bulk_delete_order_custom_attributes | Delete the custom attribute values listed in values for one or more orders. |
bulk_swap_plan | Swap the plan for multiple subscriptions at a location. |
bulk_update_customers | Update multiple Square customers in one request. |
bulk_update_team_members | Update multiple Square team members in one request. |
bulk_update_vendors | Update multiple Square vendors in one request. |
bulk_upsert_booking_custom_attributes | Create or update the custom attribute values listed in values for one or more bookings. |
bulk_upsert_customer_custom_attributes | Create or update the custom attribute values listed in values for one or more customer profiles. |
bulk_upsert_location_custom_attributes | Create or update the custom attribute values listed in values for one or more locations. |
bulk_upsert_merchant_custom_attributes | Create or update the custom attribute values listed in values for one or more merchants. |
bulk_upsert_order_custom_attributes | Create or update the custom attribute values listed in values for one or more orders. |
cancel_booking | Cancel a booking. |
cancel_invoice | Cancel a published invoice. |
cancel_loyalty_promotion | Cancel the Square loyalty promotion. |
cancel_payment | Cancel a payment that has not been completed. |
cancel_payment_by_idempotency_key | Cancel a payment using the idempotency key from its original create_payment request. |
cancel_subscription | Cancel a subscription. |
cancel_terminal_action | Cancel the Square terminal action. |
cancel_terminal_checkout | Cancel the Square terminal checkout. |
cancel_terminal_refund | Cancel the Square terminal refund. |
complete_payment | Complete a delayed payment. |
delete_booking_custom_attribute | Delete one custom attribute value from a booking. |
delete_booking_custom_attribute_definition | Delete a custom attribute definition for bookings. |
delete_break_type | Delete the Square break type. |
delete_catalog_object | Delete a catalog object by ID. |
delete_checkout_payment_link | Delete the Square checkout payment link. |
delete_customer | Delete a customer by ID. |
delete_customer_custom_attribute | Delete one custom attribute value from a customer profile. |
delete_customer_custom_attribute_definition | Delete a custom attribute definition for customer profiles. |
delete_customer_group | Delete a customer group. |
delete_dispute_evidence | Delete the Square dispute evidence. |
delete_invoice | Delete a draft invoice. |
delete_invoice_attachment | Delete the Square invoice attachment. |
delete_location_custom_attribute | Delete one custom attribute value from a location. |
delete_location_custom_attribute_definition | Delete a custom attribute definition for locations. |
delete_loyalty_reward | Delete the Square loyalty reward. |
delete_merchant_custom_attribute | Delete one custom attribute value from a merchant. |
delete_merchant_custom_attribute_definition | Delete a custom attribute definition for merchants. |
delete_order_custom_attribute | Delete one custom attribute value from a order. |
delete_order_custom_attribute_definition | Delete a custom attribute definition for orders. |
delete_site_snippet | Delete the Square site snippet. |
delete_subscription_action | Delete a scheduled action for a subscription. |
delete_webhook_subscription | Delete the Square webhook subscription. |
disable_card | Disable a card on file. |
disable_events | Disable event recording for the Square account. |
dismiss_terminal_action | Dismiss the Square terminal action. |
dismiss_terminal_checkout | Dismiss the Square terminal checkout. |
dismiss_terminal_refund | Dismiss the Square terminal refund. |
enable_events | Enable event recording so matching Square events can be searched. |
pause_subscription | Pause a subscription. |
pay_order | Pay for an order using payment IDs. |
publish_invoice | Publish a draft invoice to send to customer. |
redeem_loyalty_reward | Redeem a loyalty reward on an order. |
redeem_loyalty_reward_by_id | Redeem the Square loyalty reward by id. |
remove_customer_from_group | Remove a customer from a group. |
resume_subscription | Resume a paused subscription. |
submit_evidence | Submit the evidence attached to a Square payment dispute for review. |
swap_plan | Swap the Square plan. |
unlink_customer_from_gift_card | Unlink a customer from a gift card. |
update_booking | Update a booking. |
update_booking_custom_attribute_definition | Update a custom attribute definition for bookings. |
update_break_type | Replace a Square break type. |
update_checkout_payment_link | Update the title, description, or other editable fields on a checkout payment link. |
update_customer | Update a customer's profile. |
update_customer_custom_attribute_definition | Update a custom attribute definition for customer profiles. |
update_customer_group | Update a customer group's name. |
update_invoice | Update a draft invoice. |
update_item_modifier_lists | Replace the enabled modifier lists for catalog items. |
update_item_taxes | Replace the enabled taxes for catalog items. |
update_location | Update a location's details. |
update_location_custom_attribute_definition | Update a custom attribute definition for locations. |
update_location_settings | Update the Square location settings. |
update_merchant_custom_attribute_definition | Update a custom attribute definition for merchants. |
update_merchant_settings | Update the Square merchant settings. |
update_order | Update an order. |
update_order_custom_attribute_definition | Update a custom attribute definition for orders. |
update_payment | Update the amount or tip on a payment. |
update_subscription | Update a subscription. |
update_team_job | Update the Square team job. |
update_team_member | Update a team member. |
update_team_member_wage_setting | Update the Square team member wage setting. |
update_vendor | Update a vendor's Square record. |
update_webhook_subscription | Update the Square webhook subscription. |
update_webhook_subscription_signature_key | Update the Square webhook subscription signature key. |
update_workweek_config | Update the Square workweek config. |
upsert_booking_custom_attribute | Create or replace a custom attribute value for a booking. |
upsert_catalog_object | Create or update a catalog object. |
upsert_customer_custom_attribute | Create or replace a custom attribute value for a customer profile. |
upsert_location_custom_attribute | Create or replace a custom attribute value for a location. |
upsert_merchant_custom_attribute | Create or replace a custom attribute value for a merchant. |
upsert_order_custom_attribute | Create or replace a custom attribute value for a order. |
upsert_site_snippet | Create or update a Square site snippet. |