v50

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

Get an order

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.

get/companies/{companyId}/terminalOrders/{orderId}

Path parameters

companyIdstring required

The unique identifier of the company account.

orderIdstring required

The unique identifier of the order.

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.