Square

Fetch the connected Square seller's merchant profile (merchant id, business name, country, currency, status).

List all of the seller's locations, including inactive ones. Most other Square calls need a location id from here.

Fetch one location. Pass "main" as the location id for the seller's main location.

List the seller's customer profiles. Newly created profiles can take up to a minute to appear.

Fetch one customer profile by id.

Search customer profiles by email, phone, reference id, creation source, group, segment or created/updated time range.

Create a customer profile. At least one of given_name, family_name, company_name, email_address or phone_number is required.

Update a customer profile. Sparse: only the fields you pass change, and an explicit null clears one. Pass version for optimistic concurrency.

Delete a customer profile. This cannot be undone.

Search orders across locations — every sale, return and exchange, whatever entered them (Point of Sale, invoices, APIs).

Fetch one order by id, with its line items and totals.

Create an order. Creating an order does not take payment — this connector never charges a card.

Update an open order. Send a sparse order carrying its current version; COMPLETED and CANCELED orders cannot be updated.

List payments taken by the seller, filterable by time range, location, amount and card. Read-only — this connector cannot take payments.

Fetch one payment by id.

List refunds on the seller's payments. Read-only — this connector cannot issue refunds.

Fetch one refund by id.

Search any catalog object type (items, variations, categories, taxes, discounts, modifiers, images) by attribute queries.

Search items and item variations by name/description text, category, product type, stock level or enabled location.

Fetch one catalog object by id, optionally with the objects it references.

Create or replace one catalog object. FULL REPLACEMENT: any field you omit is cleared and omitted inline children (such as item variations) are deleted, so send the complete object.

Delete one catalog object. Cascades — deleting an item also deletes its variations.

List the invoices for one location.

Search invoices at a location, optionally narrowed to specific customers. Square accepts exactly one location and one customer today.

Fetch one invoice by id, including its current version.

Create a DRAFT invoice for an existing order. Nothing is sent or charged until publish_invoice runs.

Update an invoice. Sparse, and the invoice's current version is required inside the invoice object; order_id and location_id cannot change.

Publish a draft invoice, which makes Square act on it — typically emailing it to the customer. Only email/share delivery works here: this connector holds no PAYMENTS_WRITE grant, so an invoice configured to charge a card on file will be refused.

Cancel a published invoice so no further payment can be collected. Does not work on a DRAFT or on an invoice already PAID, REFUNDED, CANCELED or FAILED.

Delete a DRAFT invoice; the associated order becomes CANCELED. Published invoices cannot be deleted — cancel them instead.