Square icon

Square

Consume Square API

Actions37

Order → Search

AI-generated

Overview

This node operation allows searching for orders in the Square system using various filters and sorting options. It is useful for retrieving orders based on specific criteria such as customer IDs, date/time ranges, fulfillment details, location IDs, source names, and order states. Users can choose to return all matching results or limit the number of results returned. Sorting can be applied based on fields like creation date, update date, or close date in ascending or descending order.

Use Case Examples

  1. Retrieve all orders for specific customers within a date range.
  2. Search orders filtered by fulfillment types and order states.
  3. Get a limited number of recent orders sorted by update time.

Properties

Name Meaning
Return All Whether to return all matching orders or limit the number of results.
Limit Maximum number of orders to return when 'Return All' is false.
Search Filters Filters to narrow down the search results based on customer IDs, date/time range, fulfillment details, location IDs, source names, and order states.
Sort Sorting options for the search results including the field to sort by and the order (ascending or descending).

Output

JSON

  • orders - Array of order objects matching the search criteria.

Dependencies

  • Square API with appropriate API key credentials

Troubleshooting

  • Ensure JSON filters (date_time_filter, fulfillment_filter, source_filter) are valid JSON strings to avoid parsing errors.
  • If no results are returned, verify that the filter criteria are correct and that orders exist matching those filters.
  • Check API credentials and permissions if authentication errors occur.

Links

Discussion