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

Create an order

POST
/companies/{companyId}/terminalOrders

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:

  • 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 in your Customer Area.

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.

Request Body

application/json

billingEntityId?string

The identification of the billing entity to use for the order.

When ordering products in Brazil, you do not need to include the billingEntityId in the request.

customerOrderReference?string

The merchant-defined purchase order reference.

items?array<>

The products included in the order.

orderType?string

Type of order

shippingLocationId?string

The identification of the shipping location to use for the order.

taxId?string

The tax number of the billing entity.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/companies/string/terminalOrders" \  -H "Content-Type: application/json" \  -d '{    "customerOrderReference": "YOUR_REFERENCE",    "shippingLocationId": "S2-6A6C2E3432747D4F2F2C3455485E3836457D",    "billingEntityId": "Company.YOUR_COMPANY",    "items": [      {        "id": "TBOX-V400m-684-EU",        "name": "V400m Package",        "quantity": 1      },      {        "id": "PART-175746-EU",        "name": "Adyen Test Card",        "quantity": 1      }    ]  }'

Example response after creating an order for terminal products

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

Get a list of orders GET

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

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