get_catalog_object
Get Catalog Object
Retrieve a specific catalog object by its ID. Returns full object data including related objects (e.g., item variations, modifier lists) when requested.
get_catalog_object
Retrieve a specific catalog object by its ID. Returns full object data including related objects (e.g., item variations, modifier lists) when requested.
upsert_catalog_object
Create or fully replace a catalog object (item, variation, category, tax, discount, modifier list, etc.). Omitted fields and nested children are cleared on update. Use a temporary ID starting with '#' for new objects.
update_customer
Update an existing customer profile. Omitted fields remain unchanged; use null to clear a field or an address component.
create_payment
Charge a token or saved card, or record cash or an external payment. Use autocomplete=false for delayed capture.
create_order
Create an OPEN or DRAFT order at a Square location. Use DRAFT for subscription order templates. Supports line items, taxes, discounts, service charges, fulfillments, and customer association. Discover locations with list_locations.
get_inventory
Retrieve current inventory counts, optionally filtered by item variations, locations, tracked states, or update time. Use search_catalog for variation IDs and list_locations for location IDs.
get_invoice
Get an invoice by ID, including its current version, payment schedule, recipient, status, and customer payment URL when published.
create_invoice
Create a draft invoice for an existing order. A payment schedule is required; publish separately to make the invoice available to the customer.
delete_customer
Permanently delete a customer profile from the Square account. This action cannot be undone.
adjust_inventory
Apply physical counts or inventory adjustments to item variations. Use ADJUSTMENT with different source and destination locations to move stock between locations.
search_catalog
Search Square catalog items by text or category, or search catalog objects by type and advanced query. Choose one search mode; item and object filters cannot be combined.
list_payments
List payments with documented date, location, card, amount, and offline filters. New payments can take several seconds to appear.
search_orders
Search for orders across one or more locations. Supports filtering by date range, fulfillment state, customer, and other criteria. Use this to find and list orders.
get_customer
Retrieve full details of a specific customer profile by ID. Returns contact information, address, notes, preferences, and group memberships.
list_invoices
List invoices at one location with status, version, recipient, payment requests, and public URL when available.
list_customers
Retrieve a list of customer profiles. Supports pagination and sorting by creation date or default order.
get_payment
Get a payment by ID, including current status, version token, refund IDs, card or cash details, and receipt URL.
refund_payment
Issue a full or partial refund of a completed Square payment. A payment can have no more than 20 refunds.
manage_invoice
Publish a draft invoice, cancel a published invoice, or delete a draft. Publishing can email the customer or charge a saved card based on settings. Deleting a draft cancels its order.
list_locations
List Square business locations. Use locationId in payments, orders, invoices, inventory, subscriptions, and payout tools; check status and capabilities before choosing a location.
delete_catalog_object
Delete a catalog object by its ID. Deleting an item also deletes its variations. Deleted objects can still be referenced by existing orders.
manage_payment
Capture or void an approved payment, update its amount or tip, or void an uncertain create request using its idempotency key.
create_customer
Create a new customer profile. Provide at least one of: given name, family name, company name, email address, or phone number.
get_order
Retrieve full details of a specific order by its ID. Returns line items, taxes, discounts, fulfillments, tenders, and all order metadata.
get_location
Retrieve a Square business location and its currency, status, and capabilities. Call list_locations to discover location IDs; use "main" for the main location.
get_refund
Retrieve full details for a Square payment refund by refund ID.
update_invoice
Update sparse invoice fields using the current version. Updating a published invoice can notify its customer. Use null or payment-request remove markers to clear supported values.
pay_order
Mark a Square order as paid using approved delayed-capture payment IDs, or settle a zero-total order with an empty paymentIds array.
list_refunds
Retrieve Square payment refunds with pagination and filters for created time, updated time, location, status, and source type.
get_merchant
Retrieve the authenticated Square merchant profile or a specific merchant by ID. Returns merchantId, currency, country, and mainLocationId for downstream tools.
update_order
Update an OPEN or DRAFT order using sparse fields and its current version, or set state to CANCELED to cancel an uninvoiced order. Invoice-linked orders must be canceled through manage_invoice. Array entries match by uid.
search_customers
Search Square customer profiles using common filters or an advanced Square customer query object. Newly created or updated customers can take time to appear in search results.
search_invoices
Search invoices at exactly one location and optionally one customer. Choose either convenience fields or query fields for each filter.
update_payment_link
Update a payment link using its current version. Checkout options replace the full options object; provide every option you want to keep.
create_card
Save a tokenized card for a Square customer. Use a one-time card token or recent payment ID; call list_customers to discover the customer ID.
list_cards
List saved cards, optionally filtered by customer or reference ID. Square returns up to 25 cards per page.
create_payment_link
Create a single-use Square-hosted checkout link for a quick-pay item or a new itemized order. Call list_locations for a valid location ID.
list_payment_links
List Square-hosted payment links and their checkout URLs, with cursor pagination.
get_payment_link
Retrieve a Square-hosted payment link, its order ID, version, and checkout URL.
delete_payment_link
Delete a payment link and cancel its unpaid checkout order. A buyer using the link can no longer complete checkout.
get_card
Retrieve a saved card by ID, including customer association and enabled state.
create_subscription
Enroll a customer in a catalog subscription plan variation. A saved card charges automatically; without one, Square emails an invoice.
disable_card
Disable a saved card, preventing future charges. Disabling an already disabled card has no effect.
cancel_subscription
Schedule cancellation at the end of the active billing period. The subscription can remain ACTIVE until its canceled date.
list_payouts
List payouts and their settlement amounts, status, destination, and reconciliation identifiers. Without a location ID, Square uses the default location.
list_payout_entries
List the transactions and adjustments that make up a batch payout. Each entry includes gross, fee, and net amounts with available payment, refund, or dispute IDs.
get_subscription
Retrieve the current subscription, billing dates, card, invoices, and optional scheduled actions.
update_subscription
Update selected subscription fields. Omitted fields are unchanged; null clears a supported value. Supply the current version from get_subscription.
get_payout
Retrieve one payout and its settlement status, amount, destination, and reconciliation ID.
get_dispute
Retrieve the state, disputed payment, amount, reason, and response deadline for one dispute.
search_subscriptions
Search subscriptions by location or customer, including their billing and cancellation state.
list_disputes
List payment disputes, including the disputed payment, amount, state, and response deadline.
Process payments, manage orders, and handle invoices for online, in-app, and in-person commerce. Create and manage customer profiles, catalog items, inventory counts, and locations. Issue refunds, manage disputes, and track payouts. Create bookings and appointments, manage team members and timecards, handle gift cards and loyalty programs, and manage subscriptions. Save cards on file, generate checkout links, connect and control Square Terminal devices, and manage vendor/supplier information. Extend Square objects with custom attributes. Receive webhook notifications for payments, orders, customers, inventory, invoices, bookings, disputes, team changes, and more.
Common questions about connecting Square to AI agents with Metorial.