POST /v2/orders/batch-retrieve
Retrieves a set of orders by their IDs.
If a given order ID does not exist, the ID is ignored instead of generating an error.
Servers
- https://connect.squareup.com
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
location_id |
String | No |
The ID of the location for these orders. This field is optional: omit it to retrieve orders within the scope of the current authorization's merchant ID. |
order_ids[] |
Array | Yes |
The IDs of the orders to retrieve. A maximum of 100 orders can be retrieved per request. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.