SchemaBoardingTerminal Orders

Retrieve terminal order

Use this method to retrieve information about a terminal order.

To retrieve a terminal order, you need it’s terminalOrderId. Our gateway returned the terminalOrderId in the response of the Create Terminal Order method.

Note: If you don’t have the terminalOrderId, use our List Terminal Orders method to search for the terminal order.

Our gateway returns the following information about the terminal order:

  • Status of the order
  • Items in the order
  • Training provider
  • Shipping information

Note: You can subscribe to our terminalOrder.status.changed event to get notifications when we update the status of a terminal order. For more information about how to subscribe to events, go to Events Subscriptions.

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 that we assigned to the terminal order.
statusenum

Status of the terminal order.

Note: You can subscribe to our terminalOrder.status.changed event to get notifications when we update the status of a terminal order. For more information about how to subscribe to events, go to Event Subscriptions.

Allowed values:
orderItemslist of objects
Array of orderItem objects. Provide a minimum of 1 order item and a maximum of 20 order items.
createdDatedatetime

Date that we received the terminal order. We return this value in the ISO-8601 format.

lastModifiedDatedatetime

Date that the terminal order was last changed. We return this value in the ISO-8601 format.

trainingProviderenum or nullDefaults to partner
Indicates who provides training to the merchant for the solution.
Allowed values:
shippingobject or null

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.

Errors