SchemaBoardingTerminal Orders

Retrieve terminal order

Use this method to retrieve information about a terminal order, including the status of the order and the settings for the items in the order. Include the terminalOrderId that we sent you when you created the terminal order.

Path parameters

terminalOrderIdstringRequired

Unique identifier of the terminal order.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

Successful request. Returns the terminal order.

terminalOrderIdstring

Unique identifier of the terminal order.

statusenum

Status of the terminal order.

Allowed values:
orderItemslist of objects

Array of orderItem objects. Provide a minimum of 1 order item and a maximum of 20 order items.

createdDatestringformat: "date-time"

Date that we received the terminal order.

lastModifiedDatestringformat: "date-time"

Date that the terminal order was last changed.

trainingProviderenumOptionalDefaults to partner

Indicates who provides training to the merchant for the solution.

Allowed values:
shippingobjectOptional

Object that contains the shipping details for the terminal order. If you don’t provide a shipping address, we use the Doing Business As (DBA) address of the processing account.