Square
Keep Square in step with your orders, invoices and payments without re-keying, with the right person approving what changes.
25 ways to read, 9 ways to write, each write switched on by you.
Quality checks
Built and tested with example responses.
- Ready to connect: doneEvery listed action is built in.
- Built and tested with example responses: doneEach action is built from the provider’s published API and tested against example responses, errors, rate limits and paging.
Connected, approved, proven.
The things teams do most with Square, an example flow with a person in the loop, and what Nexra keeps as proof.
Top actions
- Create or update catalog itemApproval by rule
- Create or update item variationApproval by rule
- List catalog itemsRead
Example flow
- Square · List catalog itemsDone
- Square · Create or update catalog itemNeeds approval
- Nexra · Record the decision and result in the evidence chainProven
Example workflow. Routine runs go through on their own. Only a change your rules flag, such as one over a limit you set, waits for the right person, who sees the exact change and the rule before it reaches Square.
What gets logged
- Whether it ran on its own or who approved it, and under which rule
- A fingerprint of the exact request sent to Square
- Square's reply: what it created or changed
- One entry in the evidence chain, linked to the one before
Try this in the sandbox
Run the whole flow with test data in your sandbox, then connect a Square test account before you go live.
For developers
Technical detail
Square payments, refunds, payouts and disputes (read); customers, catalog, inventory, orders and draft invoices (read and write).
Square API docs- Source actions
- 25
- Destination actions
- 9
- Data types
- 14
What you can map
Reads are always available. Writes are off until you switch them on for a connection, and governed writes follow your policies.
Catalog items3
- List catalog itemsSourceIncremental
Square catalog items (ITEM objects), with incremental changes since a timestamp.
- Search catalog itemsSource
Search items by text, category, enabled location or stock level.
- Create or update catalog itemDestinationProvider duplicate protectionApproval before production
Create an item with its variations, or replace an existing item (supply itemId and version).
Catalog objects1
- Get catalog objectSource
Read one catalog object (item, variation, category, tax ...) by ID.
Catalog variations2
- List catalog item variationsSourceIncremental
Square catalog item variations (ITEM_VARIATION objects), with incremental changes since a timestamp.
- Create or update item variationDestinationProvider duplicate protectionApproval before production
Create a variation on an existing item, or update one (supply variationId and version).
Customers5
- Create customerDestinationProvider duplicate protectionApproval before production
Create a customer profile. Square deduplicates repeats by idempotency key.
- Get customerSource
Read one Square customer by ID.
- List customersSource
Customer profiles in the seller's directory.
- Search customersSourceIncremental
Find customers by update or creation time, exact email, phone or reference ID. Filters are sent in the request body.
- Update customerDestinationProvider duplicate protectionApproval before production
Update supplied fields on a customer profile; omitted fields are unchanged.
Disputes2
- Get disputeSource
Read one Square dispute by ID.
- List disputesSource
Card-network disputes (chargebacks). Accepting or contesting stays in Square.
Inventory changes1
- Record inventory changesDestinationProvider duplicate protectionApproval before production
Record physical counts or state adjustments (for example IN_STOCK to WASTE) for item variations.
Inventory counts2
- Get inventory count for a catalog objectSource
Counts for one item variation across locations and states.
- List inventory countsSourceIncremental
Current counts by catalog object, location and state, with incremental updated_after.
Invoices5
- Create draft invoiceDestinationProvider duplicate protectionApproval before production
Create a DRAFT invoice for an existing order. Nexra never publishes it: nothing is sent or charged until you publish it in Square.
- Get invoiceSource
Read one Square invoice by ID.
- List invoicesSource
Invoices for one location.
- Search invoicesSource
Invoices for a location, optionally for specific customers.
- Update draft invoiceDestinationProvider duplicate protectionApproval before production
Update title, description, number, dates, delivery or accepted methods on an invoice (sparse update with version).
Locations2
- Get locationSource
Read one Square location by ID.
- List locationsSource
Every business location of the seller (single page).
Orders4
- Create orderDestinationProvider duplicate protectionApproval before production
Create an open (or draft) order with line items. No payment is taken: the order stays unpaid until the buyer pays.
- Get orderSource
Read one Square order by ID.
- Search ordersSourceIncremental
Orders for up to 10 locations, filtered by update time, state or customer. Sorted by the filtered time field.
- Update orderDestinationProvider duplicate protectionApproval before production
Update reference, customer, ticket name or metadata on an open order (sparse update with version). State changes are not exposed.
Payments2
- Get paymentSource
Read one Square payment by ID.
- List paymentsSourceIncremental
Read Square payments; money amounts are integer currency subunits. Supports updated-since sync.
Payout entries1
- List payout entriesSource
Ledger entries (charges, refunds, fees, disputes) settled in one payout.
Payouts2
- Get payoutSource
Read one Square payout by ID.
- List payoutsSourceIncremental
Payouts already sent to the seller's bank. Nexra never initiates payouts.
Refunds2
- Get refundSource
Read one Square refund by ID.
- List refundsSourceIncremental
Read payment refunds already issued in Square. Nexra never issues refunds.
Access and limits
- Authentication
- Square OAuth token or sandbox access token
- Plans and access
- Any Square seller account. Use an application access token or a seller OAuth token. The token needs the scopes of each operation (PAYMENTS_READ, CUSTOMERS_READ/WRITE, ITEMS_READ/WRITE, INVENTORY_READ/WRITE, ORDERS_READ/WRITE, INVOICES_READ/WRITE, MERCHANT_PROFILE_READ, PAYOUTS_READ, DISPUTES_READ).
- Test environment
- Square Sandbox (connect.squareupsandbox.com) with a sandbox access token from the Developer Console.
- Rate limits
- Square applies per-application request limits and returns HTTP 429 RATE_LIMITED. Nexra honours Retry-After with bounded retries for reads and idempotent writes.
- Pagination
- Cursor pagination: the response cursor is passed back as a query parameter (GET) or body field (search endpoints). Locations return one page.
- Provider events
- Square sends webhooks for payments, refunds, orders, customers, catalog, inventory, invoices, payouts and disputes. Flows can start the moment something happens: when a payment succeeds; when a payment fails; when a refund is processed; when a dispute is opened.
Before you build a flow
- Intentional exclusions: creating, completing or cancelling payments; refunds; cancelling or paying orders; publishing, cancelling or deleting invoices; accepting disputes or submitting evidence; any delete; payouts are read only.
- Card details are reduced to brand and status; buyer email, billing and shipping addresses on payments are not returned. Customer profiles return the contact data the seller stores.
- Catalog upsert replaces the whole object; read the current version and variations before updating an item.
- Customer, loyalty, gift card, booking, team and subscription APIs are not covered yet.
Developer reference
- Create the Square credentials described above with the narrowest permissions your flows need.
- In Nexra, open Connect, then Connections, then New connection, choose Square, enter its settings and credentials, and tick only the write actions you need. Connection guide
- Test the connection, then use its actions as flow sources and destinations. Flow guide
Machine-readable detail: GET /api/public/connect/connectors/square and the Connections API.