GET /companies/{companyId}/terminalOrders
Returns a lists of terminal products orders for the company identified in the path. To filter the list, use one or more of the query parameters.
To make this request, your API credential must have one of the following roles:
- Management API—Terminal ordering read
- Management API—Terminal ordering read and write
Servers
- https://management-test.adyen.com/v3
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
companyId |
String | Yes |
The unique identifier of the company account. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
limit |
Integer | No |
The number of orders to return. |
customerOrderReference |
String | No |
Your purchase order number. |
status |
String | No |
The order status. Possible values (not case-sensitive): Placed, Confirmed, Cancelled, Shipped, Delivered. |
offset |
Integer | No |
The number of orders to skip. |
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.