Actions37
- Booking Actions
- Catalog Actions
- Customer Actions
- Invoice Actions
- Order Actions
Order → Batch Retrieve
AI-generatedOverview
This node operation allows users to batch retrieve multiple orders from the Square API by specifying a list of order IDs and a location ID. It is useful for scenarios where you need to fetch details of several orders at once, such as in bulk order processing, reporting, or synchronization tasks.
Use Case Examples
- Retrieve details of multiple orders by providing their IDs and the associated location ID to get comprehensive order information in one API call.
- Use it to quickly gather order data for a specific location to analyze sales or update order statuses in bulk.
Properties
| Name | Meaning |
|---|---|
| Order IDs | A comma-separated list of order IDs to retrieve. This is required to specify which orders to fetch from the Square API. |
| Location ID | The ID of the location associated with the orders. This is required to specify the location context for the orders being retrieved. |
Output
JSON
order_ids- The list of order IDs requested for retrieval.location_id- The location ID associated with the orders.orders- The array of order objects returned from the Square API containing detailed information about each order.
Dependencies
- Square API with an API key credential for authentication
Troubleshooting
- Ensure that the order IDs are correctly formatted as a comma-separated string without extra spaces or invalid characters.
- Verify that the location ID is valid and corresponds to the orders being requested.
- Handle JSON parsing errors if the input format is incorrect.
- If the API returns errors, check for permission issues or invalid credentials.
- Use the 'continue on fail' option to handle partial failures gracefully.
Links
- Square API - Batch Retrieve Orders - Official Square API documentation for the batch retrieve orders endpoint.