batch-retrieve-orders-request.md

Batch Retrieve Orders Request

Defines the fields that are included in requests to the BatchRetrieveOrders endpoint.

Structure

Batch Retrieve Orders Request

Fields

Name	Type	Tags	Description
location_id	string	Optional	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	List of string	Required	The IDs of the orders to retrieve. A maximum of 100 orders can be retrieved per request.

Example (as JSON)

{
  "location_id": "057P5VYJ4A5X1",
  "order_ids": [
    "CAISEM82RcpmcFBM0TfOyiHV3es",
    "CAISENgvlJ6jLWAzERDzjyHVybY"
  ]
}