Get a list of orders
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
In the live environment, requests to this endpoint are subject to rate limits.
In: header
Path Parameters
The unique identifier of the company account.
Query Parameters
Your purchase order number.
The order status. Possible values (not case-sensitive): Placed, Confirmed, Cancelled, Shipped, Delivered.
The number of orders to skip.
int32The number of orders to return.
int32Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/companies/string/terminalOrders"Example response with the terminal orders for a company
{ "data": [ { "id": "5265677890100681", "customerOrderReference": "YOUR_REFERENCE_C2", "status": "Placed", "shippingLocation": { "id": "S2-232A6D2967356F424F4369432B3F486B6A6D", "name": "YOUR_COMPANY HQ - POS Ops", "contact": { "firstName": "Paul", "lastName": "Green", "email": "Paul.Green@company.com" }, "address": { "streetAddress": "Simon Carmiggeltstraat", "streetAddress2": "6-50", "postalCode": "1011 DJ", "city": "Amsterdam", "country": "NL" } }, "billingEntity": { "id": "Company.YOUR_COMPANY", "name": "YOUR_COMPANY", "taxId": "NL1234567890", "email": "Paul.Green@company.com", "address": { "streetAddress": "Simon Carmiggeltstraat 6-50", "postalCode": "1011 DJ", "city": "Amsterdam", "country": "NL" } }, "orderDate": "2020-06-10T17:03:11.000Z", "items": [ { "id": "TBOX-MX925-422-EU", "name": "MX925 Package", "quantity": 1 } ] }, { "id": "9415936144678634", "customerOrderReference": "YOUR_REFERENCE_C1", "status": "Cancelled", "shippingLocation": { "id": "S2-232A6D2967356F424F4369432B3F486B6A6D", "name": "YOUR_COMPANY HQ - POS Ops", "contact": { "firstName": "Paul", "lastName": "Green", "email": "Paul.Green@company.com" }, "address": { "streetAddress": "Simon Carmiggeltstraat", "streetAddress2": "6-50", "postalCode": "1011 DJ", "city": "Amsterdam", "country": "NL" } }, "billingEntity": { "id": "Company.YOUR_COMPANY", "name": "YOUR_COMPANY", "taxId": "NL1234567890", "email": "Paul.Green@company.com", "address": { "streetAddress": "Simon Carmiggeltstraat 6-50", "postalCode": "1011 DJ", "city": "Amsterdam", "country": "NL" } }, "orderDate": "2022-01-03T16:41:07.000Z", "items": [ { "id": "TBOX-V400m-774-EU", "name": "V400m Package", "quantity": 5 } ] } ]}Get a list of terminal models GET
Returns a list of payment terminal models that the company identified in the path has access to. The response includes the terminal model ID, which can be used as a query parameter when getting a list of terminals or a list of products for ordering. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write In the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).
Create an order POST
Creates an order for payment terminal products for the company identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write >Requests to the Management API test endpoint do not create actual orders for test terminals. To order test terminals, you need to [submit a sales order](https://docs.adyen.com/point-of-sale/managing-terminals/order-terminals/#sales-order-steps) in your Customer Area. In the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).