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.
Servers
- https://management-test.adyen.com/v3
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
companyId |
String | Yes |
The unique identifier of the company account. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
orderType |
String | No |
Type of order |
shippingLocationId |
String | No |
The identification of the shipping location to use for the order. |
customerOrderReference |
String | No |
The merchant-defined purchase order reference. |
items[] |
Array | No |
The products included in the order. |
items[].id |
String | No |
The unique identifier of the product. |
items[].installments |
Integer | No |
The number of installments for the specified product |
items[].name |
String | No |
The name of the product. |
items[].quantity |
Integer | No |
The number of items with the specified product |
taxId |
String | No |
The tax number of the billing entity. |
billingEntityId |
String | No |
The identification of the billing entity to use for the order.
|
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.