APIMatic Adyen APIs
Sign Up to APIMatic
HomeSDKsAPI ReferenceContext Plugin
ManagementTerminal ordersTerminal orders company level

Get an order

GET
/companies/{companyId}/terminalOrders/{orderId}

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:

  • 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.

Authorization

AuthorizationBasic <token>

In: header

Path Parameters

companyId*string

The unique identifier of the company account.

orderId*string

The unique identifier of the order.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/companies/string/terminalOrders/string"

Example response with the details of the terminal products order

{  "id": "5265677890100681",  "customerOrderReference": "YOUR_REFERENCE_1",  "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": "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    }  ]}

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).

Update an order PATCH

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](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).