Skip to main content

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.

  1. Go to Organization > Connectors and find Square.
  2. Click Enable and choose which tools to allow.
  3. 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.

ToolWhat it does
batch_get_catalog_objectsRetrieve multiple Square catalog objects in one request.
batch_get_ordersRetrieve multiple Square orders in one request.
bulk_get_booking_team_member_profilesRetrieve multiple Square team member booking profiles in one request.
bulk_get_bookingsRetrieve multiple Square bookings in one request.
bulk_get_customersRetrieve multiple Square customer records in one request.
bulk_get_vendorsRetrieve the vendors whose IDs are in vendor_ids.
calculate_loyalty_pointsEstimate the loyalty points a buyer would earn for a purchase.
calculate_orderCalculate order totals without creating an order.
catalog_infoRetrieve the Square catalog version and object counts.
change_billing_anchor_dateChange the date used for a subscription's monthly billing cycle.
get_bank_accountRetrieve the Square bank account.
get_bank_account_by_v1_idRetrieve a bank account using its legacy Square V1 ID.
get_bookingGet a booking by ID.
get_booking_business_profileRetrieve the Square seller booking business profile.
get_booking_custom_attributeRetrieve a custom attribute value for a booking.
get_booking_custom_attribute_definitionRetrieve a custom attribute definition for bookings.
get_booking_location_profileRetrieve the Square booking location profile.
get_booking_team_member_profileRetrieve the Square team member booking profile.
get_break_typeRetrieve the Square break type.
get_cardGet a card by ID.
get_cash_drawer_shiftRetrieve the Square cash drawer shift.
get_catalog_objectGet a catalog object by ID.
get_checkout_location_settingsRetrieve the Square checkout location settings.
get_checkout_merchant_settingsRetrieve the Square checkout merchant settings.
get_checkout_payment_linkRetrieve the Square checkout payment link.
get_customerGet a customer by ID.
get_customer_custom_attributeRetrieve a custom attribute value for a customer profile.
get_customer_custom_attribute_definitionRetrieve a custom attribute definition for customer profiles.
get_customer_groupGet a customer group by ID.
get_customer_segmentRetrieve the Square customer segment.
get_deviceRetrieve the Square device.
get_device_codeRetrieve the Square device code.
get_disputeRetrieve the Square dispute.
get_dispute_evidenceRetrieve the Square dispute evidence.
get_gift_cardGet a gift card by ID.
get_gift_card_from_ganGet a gift card by its GAN (gift card account number).
get_gift_card_from_nonceRetrieve the Square gift card associated with a payment nonce.
get_inventory_adjustmentRetrieve the Square inventory adjustment.
get_inventory_countRetrieve the Square inventory count.
get_inventory_physical_countRetrieve the Square physical inventory count.
get_invoiceGet an invoice by ID.
get_locationGet a location by ID.
get_location_custom_attributeRetrieve a custom attribute value for a location.
get_location_custom_attribute_definitionRetrieve a custom attribute definition for locations.
get_loyalty_accountGet a loyalty account by ID.
get_loyalty_programRetrieve the Square loyalty program.
get_loyalty_promotionRetrieve the Square loyalty promotion.
get_loyalty_rewardRetrieve the Square loyalty reward.
get_merchantGet merchant info by ID.
get_merchant_custom_attributeRetrieve a custom attribute value for a merchant.
get_merchant_custom_attribute_definitionRetrieve a custom attribute definition for merchants.
get_orderGet an order by ID.
get_order_custom_attributeRetrieve a custom attribute value for a order.
get_order_custom_attribute_definitionRetrieve a custom attribute definition for orders.
get_paymentGet a payment by ID.
get_payoutRetrieve the Square payout.
get_refundGet a refund by ID.
get_site_snippetRetrieve the Square site snippet.
get_subscriptionGet a subscription by ID.
get_team_jobRetrieve the Square team job.
get_team_memberGet a team member by ID.
get_team_member_wageRetrieve the Square team member wage.
get_team_member_wage_settingRetrieve the Square team member wage setting.
get_terminal_actionRetrieve the Square terminal action.
get_terminal_checkoutRetrieve the Square terminal checkout.
get_terminal_refundRetrieve the Square terminal refund.
get_vendorRetrieve the Square vendor.
get_webhook_subscriptionRetrieve the Square webhook subscription.
list_bank_accountsList Square bank accounts.
list_booking_custom_attribute_definitionsList definitions for custom attributes available to bookings.
list_booking_custom_attributesList custom attribute values for a booking.
list_booking_location_profilesList Square booking location profiles.
list_bookingsList bookings.
list_break_typesList Square break types.
list_cardsList cards on file.
list_cash_drawer_shift_eventsList Square cash drawer shift events.
list_cash_drawer_shiftsList Square cash drawer shifts.
list_catalogList catalog objects (items, categories, taxes, discounts).
list_checkout_payment_linksList Square checkout payment links.
list_customer_custom_attribute_definitionsList definitions for custom attributes available to customer profiles.
list_customer_custom_attributesList custom attribute values for a customer profile.
list_customer_groupsList all customer groups.
list_customer_segmentsList Square customer segments.
list_customersList all customers with optional sorting and pagination.
list_device_codesList Square device codes.
list_devicesList Square devices.
list_dispute_evidenceList Square dispute evidences.
list_disputesList Square disputes.
list_event_typesList event types supported by the Square Events API.
list_gift_card_activitiesList Square gift card activities.
list_gift_cardsList gift cards.
list_invoicesList invoices for a location.
list_location_custom_attribute_definitionsList definitions for custom attributes available to locations.
list_location_custom_attributesList custom attribute values for a location.
list_locationsList all business locations.
list_loyalty_programsList all loyalty programs.
list_loyalty_promotionsList Square loyalty promotions.
list_merchant_custom_attribute_definitionsList definitions for custom attributes available to merchants.
list_merchant_custom_attributesList custom attribute values for a merchant.
list_merchantsList merchants associated with the access token.
list_order_custom_attribute_definitionsList definitions for custom attributes available to orders.
list_order_custom_attributesList custom attribute values for a order.
list_paymentsList payments with optional filters.
list_payout_entriesList Square payout entries.
list_payoutsList Square payouts.
list_refundsList refunds with optional filters.
list_sitesList Square sites.
list_subscription_eventsList Square subscription events.
list_subscriptionsList subscriptions.
list_team_jobsList Square team jobs.
list_team_member_booking_profilesList team members available for booking.
list_team_member_wagesList Square team member wages.
list_team_membersList team members.
list_webhook_event_typesList event types that a Square webhook subscription can receive.
list_webhook_subscriptionsList Square webhook subscriptions.
list_workweek_configsList Square workweek configs.
retrieve_inventory_changesGet history of inventory changes.
search_availabilitySearch for available booking time slots.
search_catalog_itemsSearch Square for catalog items.
search_catalog_objectsSearch catalog by text (name, description, SKU), exact match, or prefix.
search_customersSearch customers by email, phone, reference_id, or fuzzy name match.
search_eventsSearch Square for Square events.
search_invoicesSearch invoices by location and optionally by customer.
search_loyalty_accountsSearch loyalty accounts by phone, customer ID, or program.
search_loyalty_eventsSearch Square for loyalty events.
search_loyalty_rewardsSearch Square for loyalty rewards.
search_ordersSearch orders by location, customer, state, or date range.
search_team_membersSearch team members by location, status, or owner flag.
search_terminal_actionsSearch Square for terminal actions.
search_terminal_checkoutsSearch Square for terminal checkouts.
search_terminal_refundsSearch Square for terminal refunds.
search_vendorsSearch Square for vendors.
test_webhook_subscriptionSend a test event to verify webhook subscription delivery.
validate_credentialValidate Square API credentials by listing merchants.

Write (39)​

Create or send data.

ToolWhat it does
accumulate_loyalty_pointsAdd points to a loyalty account from a purchase.
add_customer_to_groupAdd a customer to a group.
batch_retrieve_inventory_countsGet inventory counts for catalog items at locations.
bulk_create_customersCreate multiple Square customers in one request.
bulk_create_team_membersCreate multiple Square team members in one request.
bulk_create_vendorsCreate multiple Square vendors in one request.
clone_orderClone an existing order to create a copy.
create_bookingCreate a booking/appointment.
create_booking_custom_attribute_definitionCreate a custom attribute definition that can be used on bookings.
create_break_typeCreate 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_cardSave a card on file for a customer.
create_checkout_payment_linkCreate a shareable Square checkout link for an order or a quick-pay amount.
create_customerCreate a new customer profile.
create_customer_custom_attribute_definitionCreate a custom attribute definition that can be used on customer profiles.
create_customer_groupCreate a customer group for segmentation.
create_device_codeCreate a device code that lets a Square Terminal connect to the account.
create_dispute_evidence_textCreate a Square dispute evidence text.
create_gift_cardCreate a gift card.
create_gift_card_activityCreate a gift card activity: ACTIVATE, LOAD, REDEEM, DEACTIVATE, or ADJUST balance.
create_invoiceCreate an invoice for an order.
create_locationCreate a new business location.
create_location_custom_attribute_definitionCreate a custom attribute definition that can be used on locations.
create_loyalty_accountCreate a loyalty account for a customer.
create_loyalty_promotionCreate a Square loyalty promotion.
create_merchant_custom_attribute_definitionCreate a custom attribute definition that can be used on merchants.
create_orderCreate an order with line items.
create_order_custom_attribute_definitionCreate a custom attribute definition that can be used on orders.
create_paymentCreate a payment to charge a customer.
create_refundRefund a payment.
create_subscriptionCreate a subscription for recurring billing.
create_team_jobCreate a Square team job.
create_team_memberCreate a team member.
create_terminal_actionCreate an action for a Square Terminal, such as opening a cash drawer.
create_terminal_checkoutStart a checkout on a Square Terminal.
create_terminal_refundRequest a refund at a Square Terminal for a previously collected payment.
create_vendorCreate a vendor in Square.
create_webhook_subscriptionCreate a Square webhook subscription.
link_customer_to_gift_cardLink a customer to a gift card.
register_apple_pay_domainRegister a website domain for Apple Pay with Square.

Delete or overwrite (100)​

Remove or replace existing data.

ToolWhat it does
accept_disputeAccept a Square payment dispute and concede the disputed amount.
adjust_loyalty_pointsManually adjust loyalty points.
batch_change_inventoryChange inventory counts.
batch_delete_catalog_objectsDelete multiple catalog objects in one request.
batch_upsert_catalog_objectsCreate or update multiple catalog objects in one request.
bulk_delete_booking_custom_attributesDelete the custom attribute values listed in values for one or more bookings.
bulk_delete_customersDelete multiple Square customers in one request.
bulk_delete_location_custom_attributesDelete the custom attribute values listed in values for one or more locations.
bulk_delete_merchant_custom_attributesDelete the custom attribute values listed in values for one or more merchants.
bulk_delete_order_custom_attributesDelete the custom attribute values listed in values for one or more orders.
bulk_swap_planSwap the plan for multiple subscriptions at a location.
bulk_update_customersUpdate multiple Square customers in one request.
bulk_update_team_membersUpdate multiple Square team members in one request.
bulk_update_vendorsUpdate multiple Square vendors in one request.
bulk_upsert_booking_custom_attributesCreate or update the custom attribute values listed in values for one or more bookings.
bulk_upsert_customer_custom_attributesCreate or update the custom attribute values listed in values for one or more customer profiles.
bulk_upsert_location_custom_attributesCreate or update the custom attribute values listed in values for one or more locations.
bulk_upsert_merchant_custom_attributesCreate or update the custom attribute values listed in values for one or more merchants.
bulk_upsert_order_custom_attributesCreate or update the custom attribute values listed in values for one or more orders.
cancel_bookingCancel a booking.
cancel_invoiceCancel a published invoice.
cancel_loyalty_promotionCancel the Square loyalty promotion.
cancel_paymentCancel a payment that has not been completed.
cancel_payment_by_idempotency_keyCancel a payment using the idempotency key from its original create_payment request.
cancel_subscriptionCancel a subscription.
cancel_terminal_actionCancel the Square terminal action.
cancel_terminal_checkoutCancel the Square terminal checkout.
cancel_terminal_refundCancel the Square terminal refund.
complete_paymentComplete a delayed payment.
delete_booking_custom_attributeDelete one custom attribute value from a booking.
delete_booking_custom_attribute_definitionDelete a custom attribute definition for bookings.
delete_break_typeDelete the Square break type.
delete_catalog_objectDelete a catalog object by ID.
delete_checkout_payment_linkDelete the Square checkout payment link.
delete_customerDelete a customer by ID.
delete_customer_custom_attributeDelete one custom attribute value from a customer profile.
delete_customer_custom_attribute_definitionDelete a custom attribute definition for customer profiles.
delete_customer_groupDelete a customer group.
delete_dispute_evidenceDelete the Square dispute evidence.
delete_invoiceDelete a draft invoice.
delete_invoice_attachmentDelete the Square invoice attachment.
delete_location_custom_attributeDelete one custom attribute value from a location.
delete_location_custom_attribute_definitionDelete a custom attribute definition for locations.
delete_loyalty_rewardDelete the Square loyalty reward.
delete_merchant_custom_attributeDelete one custom attribute value from a merchant.
delete_merchant_custom_attribute_definitionDelete a custom attribute definition for merchants.
delete_order_custom_attributeDelete one custom attribute value from a order.
delete_order_custom_attribute_definitionDelete a custom attribute definition for orders.
delete_site_snippetDelete the Square site snippet.
delete_subscription_actionDelete a scheduled action for a subscription.
delete_webhook_subscriptionDelete the Square webhook subscription.
disable_cardDisable a card on file.
disable_eventsDisable event recording for the Square account.
dismiss_terminal_actionDismiss the Square terminal action.
dismiss_terminal_checkoutDismiss the Square terminal checkout.
dismiss_terminal_refundDismiss the Square terminal refund.
enable_eventsEnable event recording so matching Square events can be searched.
pause_subscriptionPause a subscription.
pay_orderPay for an order using payment IDs.
publish_invoicePublish a draft invoice to send to customer.
redeem_loyalty_rewardRedeem a loyalty reward on an order.
redeem_loyalty_reward_by_idRedeem the Square loyalty reward by id.
remove_customer_from_groupRemove a customer from a group.
resume_subscriptionResume a paused subscription.
submit_evidenceSubmit the evidence attached to a Square payment dispute for review.
swap_planSwap the Square plan.
unlink_customer_from_gift_cardUnlink a customer from a gift card.
update_bookingUpdate a booking.
update_booking_custom_attribute_definitionUpdate a custom attribute definition for bookings.
update_break_typeReplace a Square break type.
update_checkout_payment_linkUpdate the title, description, or other editable fields on a checkout payment link.
update_customerUpdate a customer's profile.
update_customer_custom_attribute_definitionUpdate a custom attribute definition for customer profiles.
update_customer_groupUpdate a customer group's name.
update_invoiceUpdate a draft invoice.
update_item_modifier_listsReplace the enabled modifier lists for catalog items.
update_item_taxesReplace the enabled taxes for catalog items.
update_locationUpdate a location's details.
update_location_custom_attribute_definitionUpdate a custom attribute definition for locations.
update_location_settingsUpdate the Square location settings.
update_merchant_custom_attribute_definitionUpdate a custom attribute definition for merchants.
update_merchant_settingsUpdate the Square merchant settings.
update_orderUpdate an order.
update_order_custom_attribute_definitionUpdate a custom attribute definition for orders.
update_paymentUpdate the amount or tip on a payment.
update_subscriptionUpdate a subscription.
update_team_jobUpdate the Square team job.
update_team_memberUpdate a team member.
update_team_member_wage_settingUpdate the Square team member wage setting.
update_vendorUpdate a vendor's Square record.
update_webhook_subscriptionUpdate the Square webhook subscription.
update_webhook_subscription_signature_keyUpdate the Square webhook subscription signature key.
update_workweek_configUpdate the Square workweek config.
upsert_booking_custom_attributeCreate or replace a custom attribute value for a booking.
upsert_catalog_objectCreate or update a catalog object.
upsert_customer_custom_attributeCreate or replace a custom attribute value for a customer profile.
upsert_location_custom_attributeCreate or replace a custom attribute value for a location.
upsert_merchant_custom_attributeCreate or replace a custom attribute value for a merchant.
upsert_order_custom_attributeCreate or replace a custom attribute value for a order.
upsert_site_snippetCreate or update a Square site snippet.
⌘J