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 update a catalog object (item, variation, category, tax, discount, modifier list, etc.). Use a temporary ID starting with '#' for new objects. For updates, provide the existing object ID and current version.
update_customer
Update an existing customer profile. Only provided fields will be updated; omitted fields remain unchanged.
create_payment
Create a new payment using a payment source (nonce, card on file, etc.). Supports setting amount, tip, customer, location, and delayed capture.
create_order
Create a new order at a Square location. Supports line items, taxes, discounts, fulfillments, and customer association. Orders start in OPEN state.
get_inventory
Retrieve inventory counts for one or more catalog item variations. Can look up counts for a single item variation or batch retrieve counts for multiple items across locations.
get_invoice
Retrieve full details of a specific invoice by its ID, including payment requests, recipients, and accepted payment methods.
create_invoice
Create a new draft invoice for an existing order. The invoice must be published separately before it can be sent to the customer.
delete_customer
Permanently delete a customer profile from the Square account. This action cannot be undone.
adjust_inventory
Make inventory changes such as adjustments, physical counts, or transfers. Supports batch operations for multiple catalog items and locations simultaneously.
search_catalog
Search the Square catalog for items, variations, categories, taxes, discounts, and other catalog objects. Supports text search, category filtering, and object type filtering.
list_payments
Retrieve a list of payments taken by the Square account. Supports filtering by time range, location, and pagination. Returns payment details including amounts, status, and source type.
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
Retrieve a list of invoices for a specific location. Returns invoice summaries including status, amounts, and recipients.
list_customers
Retrieve a list of customer profiles. Supports pagination and sorting by creation date or default order.
get_payment
Retrieve full details of a specific payment by its ID. Returns comprehensive payment information including amount, status, card details, and receipt URL.
refund_payment
Issue a full or partial refund for a Square payment. Specify the payment ID and the amount to refund. Optionally provide a reason for the refund.
manage_invoice
Publish, cancel, or delete an invoice. Publishing sends the invoice to the customer. Canceling stops a published invoice. Deleting permanently removes a draft invoice.
list_locations
Retrieve all business locations associated with the Square account. Returns location names, addresses, statuses, and capabilities. Useful for obtaining location IDs needed by other tools.
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
Complete or cancel an existing payment. Use "complete" to capture a previously authorized (delayed) payment, or "cancel" to void it.
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 details for a single Square business location. Use "main" as the location ID to retrieve the main location.
get_refund
Retrieve full details for a Square payment refund by refund ID.
update_invoice
Update a Square invoice using sparse invoice fields and the current invoice version. Some fields, including order_id and location_id, cannot be changed by Square.
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 profile by merchant ID.
update_order
Update an open Square order using sparse order fields and the current order version. Use fieldsToClear to clear supported dot-notation fields.
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 Square invoices for a location, optionally narrowed to one customer. Square currently supports one location and optionally one customer in the invoice search filter.
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.