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.

Endpoint destination URL
https://management-test.adyen.com/v3/companies/{companyId}/terminalOrders
Click to copy

Path Parameters

companyIdstringRequired

The unique identifier of the company account.

Request Parameters

billingEntityIdstring

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

customerOrderReferencestring

The merchant-defined purchase order reference.

itemsarray[object]

The products included in the order.

orderTypestring

Type of order

shippingLocationIdstring

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

taxIdstring

The tax number of the billing entity.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

  • 200 - OK

    The request has succeeded.

    Show moreShow less
  • 400 - Bad Request

    A problem reading or understanding the request.

    Show moreShow less
  • 401 - Unauthorized

    Authentication required.

    Show moreShow less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show moreShow less
  • 422 - Unprocessable Entity

    A request validation error.

    Show moreShow less
  • 500 - Internal Server Error

    The server could not process the request.

    Show moreShow less