List terminal orders
Use this method to return a [paginated](https://docs.payroc.com/api/pagination) list of terminal orders associated with a processing account.
**Note:** If you want to view the details of a specific terminal order and you have its terminalOrderId, use our [Retrieve Terminal Order](https://docs.payroc.com/api/schema/boarding/terminal-orders/retrieve) method.
Use the query parameters to filter the list of results that we return, for example, to search for terminal orders by their status.
To list the terminal orders for a processing account, you need its processingAccountId. If you don't have the processingAccountId, use our [List Merchant Platforms](https://docs.payroc.com/api/schema/boarding/merchant-platforms/list) method to search for a merchant platform and its processing accounts.
Our gateway returns the following information for each terminal order in the list:
- Status of the order
- Items in the order
- Training provider
- Shipping information
For each terminal order, we also return its terminalOrderId, which you can use to perform follow-on actions.
Path parameters
processingAccountId
Unique identifier that we assigned to the processing account.
Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
Query parameters
status
Filter terminal orders by status.
Allowed values:
fromDateTime
toDateTime
Response
Successful request. Returns a list of terminal orders associated with the processing account.
terminalOrderId
Unique identifier that we assigned to the terminal order.
status
Status of the terminal order.
Note: You can subscribe to our terminalOrder.status.changed event to get notifications when we update the status of a terminal order. For more information about how to subscribe to events, go to Event Subscriptions.
Allowed values:
orderItems
Array of orderItem objects. Provide a minimum of 1 order item and a maximum of 20 order items.
createdDate
Date that we received the terminal order. We return this value in the [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
lastModifiedDate
Date that the terminal order was last changed. We return this value in the [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
trainingProvider
Indicates who provides training to the merchant for the solution.
Allowed values:
shipping
Object that contains the shipping details for the terminal order. If you don’t provide a shipping address, we use the Doing Business As (DBA) address of the processing account.
