Square Search Orders

Tool to search orders across one or more Square locations with filters. Use when you need to find orders within a date range, by state, by customer, or other criteria. This is the primary way Square exposes 'list orders for a date range' functionality.

Write actionRisk level 2 of 5OAuth connection

Use Square Search Orders

Pricing and limits

Start Now

Square Tools

Square Search Orders

Tool to search orders across one or more Square locations with filters. Use when you need to find orders within a date range, by state, by customer, or other criteria. This is the primary way Square exposes 'list orders for a date range' functionality.

Write actionRisk level 2 of 5OAuth connection

Use Square Search Orders

Pricing and limits

Pricing

Free

Unified payment

Not currently supported

Inputs

limitinteger
Maximum number of results to return per page. Default: 500, Maximum: 1000.
queryobject
Query parameters for filtering and sorting orders.
cursorstring
A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for your original query.
location_idsarray
Required
The location IDs for the orders to query. All locations must belong to the same merchant. Maximum: 10 location IDs.
return_entriesboolean
Controls the format of the search results. If true, returns OrderEntry objects (lightweight with just order_id, location_id, version). If false, returns complete Order objects with full details. Default: false.

Observable output

data
Required
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulboolean
Required
Whether or not the action execution was successful or not

Skills that use this Action

No published Skills explicitly reference this Action yet.

Skills that use this Action

Related use cases

No verified related use cases are linked yet.

Official source

Provider source

Skills that use this Action

No published Skills explicitly reference this Action yet.