Sign in

v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-131362831.1 MB
Terminal orders - company level

Create an order

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.

post/companies/{companyId}/terminalOrders

Path parameters

companyIdstring required

The unique identifier of the company account.

Request body

billingEntityIdstring

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.

customerOrderReferencestring

The merchant-defined purchase order reference.

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

OK - the request has succeeded.

customerOrderReferencestring

The merchant-defined purchase order number. This will be printed on the packing list.

idstring

The unique identifier of the order.

orderDatestring

The date and time that the order was placed, in UTC ISO 8601 format. For example, "2011-12-03T10:15:30Z".

statusstring

The processing status of the order.

trackingUrlstring

The URL, provided by the carrier company, where the shipment can be tracked.