Get a list of orders

get /companies/{companyId}/terminalOrders

Returns a lists of terminal products orders for the company identified in the path. To filter the list, use one or more of the query parameters.

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

Endpoint destination URL{companyId}/terminalOrders
Click to copy

Query parameters

limit integer

The number of orders to return.

offset integer

The number of orders to skip.

status string

The order status. Possible values (not case-sensitive): Placed, Confirmed, Cancelled, Shipped, Delivered.

customerOrderReference string

Your purchase order number.

Path parameters

companyId string Required

The unique identifier of the company account.

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 more Show less
  • 400 - Bad Request

    A problem reading or understanding the request.

    Show more Show less
  • 401 - Unauthorized

    Authentication required.

    Show more Show less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show more Show less
  • 422 - Unprocessable Entity

    A request validation error.

    Show more Show less
  • 500 - Internal Server Error

    The server could not process the request.

    Show more Show less
  • Response
  • Click to copy