Update an order
Updates the terminal products order identified in the path. Updating is only possible while the order has the status Placed.
The request body only needs to contain what you want to change.
However, to update the products in the items array, you must provide the entire array. For example, if the array has three items:
To remove one item, the array must include the remaining two items. Or to add one item, the array must include all four items.
To make this request, your API credential must have the following role:
- 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.
The unique identifier of the order.
Request Body
application/json
The identification of the billing entity to use for the order.
When ordering products in Brazil, you do not need to include the
billingEntityIdin the request.
The merchant-defined purchase order reference.
The products included in the order.
Type of order
The identification of the shipping location to use for the order.
The tax number of the billing entity.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/companies/string/terminalOrders/string" \ -H "Content-Type: application/json" \ -d '{ "items": [ { "id": "TBOX-V400m-684-EU", "name": "V400m Package", "quantity": 1 }, { "id": "PART-175746-EU", "name": "Adyen Test Card", "quantity": 1 }, { "id": "PART-620222-EU", "name": "Receipt Roll", "quantity": 5 } ] }'Example response after updating an order for terminal products
{ "id": "5265677890100681", "customerOrderReference": "YOUR_REFERENCE_1", "status": "Placed", "shippingLocation": { "id": "S2-7973536B20662642215526704F302044452F714622375D476169", "name": "YOUR_COMPANY Rokin depot", "contact": { "firstName": "Paul", "lastName": "Green", "phoneNumber": "+31 020 1234567", "email": "Paul.Green@company.com" }, "address": { "companyName": "YOUR_COMPANY", "streetAddress": "Rokin 21", "postalCode": "1012 KS", "city": "Amsterdam", "stateOrProvince": "", "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-20T14:12:33Z", "items": [ { "id": "TBOX-V400m-684-EU", "name": "V400m Package", "quantity": 1 }, { "id": "PART-175746-EU", "name": "Adyen Test Card", "quantity": 1 }, { "id": "PART-620222-EU", "name": "Receipt Roll", "quantity": 5 } ]}Get an order GET
Returns the details of the terminal products order identified in the path. 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).
Cancel an order POST
Cancels the terminal products order identified in the path. Cancelling is only possible while the order has the status **Placed**. To cancel an order, make a POST call without a request body. The response returns the full order details, but with the status changed to **Cancelled**. 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 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).