---
title: "Display an order"
method: POST
path: "/v1/device/display-order"
tags: ["DEVICE"]
---

# Display an order

`POST /v1/device/display-order`

Displays the order screen on the idle terminal.  The values passed in this request are used as is. They are not used in any calculations, updating of existing order.  This is strictly a UI request that shows a helpful screen to customers to show them what they are purchasing before starting a payment request.

## Headers

- `User-Agent` string, required
- `X-Clover-Device-Id` string, required
- `X-POS-Id` string, required
- `X-Clover-Timeout` integer

## Request body

- DisplayOrderRequest
  - `amountRemaining` string — If a previous payment has been made then there could be a remaining amount that the customer still owes. For this to be displayed there must be at least one DisplayPayment in the payments array. The provided amounts are not calculated in anyway and must be passed exactly as intended to be displayed.
  - `discounts` DisplayDiscount[] — An array of discounts that lower the cost of the order.
    - `amount` string — The amount of the discount
    - `name` string — Informative title to differentiate different discounts
  - `lineItems` DisplayLineItem[] — An array of individual items that make up the order.
    - `binName` string — A way to "bin" common items under a category
    - `discount` DisplayDiscount
      - `amount` string — The amount of the discount
      - `name` string — Informative title to differentiate different discounts
    - `modifiers` DisplayModification[] — Array of modifications applied to a single line item
      - `amount` string — An additional string that can be used to add more description
      - `name` string — Informative title to differentiate different modifiers
    - `name` string
    - `note` string — A way to describe the line item or discounts in more detail
    - `price` string — The cost associated with the line item.
    - `quantity` string
  - `payments` DisplayPayment[] — An array of processed payments already applied to the order.
    - `amount` string
    - `label` string
  - `serviceChargeAmount` string — An additional charge applied to the order for extra services provided.
  - `serviceChargeName` string — Descriptive title that informs the customer of what extra services are included in the order.
  - `subtotal` string — The total before tax, surcharges, order discounts and other things are included.
  - `tax` string — An amount of the order that will be ear marked for paying government taxes.
  - `total` string — The sum of all line items, amounts, discounts, taxes, surcharges and anything else.

## Response `200`

The display order screen was displayed to the customer.

- object

## Other responses

- `209` — Operation was canceled.
- `400` — The request is invalid, and subsequent calls will continue to fail; do not repeat the call.
- `401` — An invalid bearer token has been provided. The call may be repeated if the provided bearer token is updated.
- `415` — The request is invalid, and contains request data in an unsupported format. This call may be repeated if the content is changed to a supported format.
- `500` — The request processing failed with an unknown error, and the processing state of the operation is indeterminate. Do not repeat the call without additional analysis.
- `501` — The device does not have the ability to respond to the requested operation; do not repeat the call.
- `503` — The device is not available because it is currently servicing another call. This can be repeated at a later time, or cancel may be called to end the current operation.
- `504` — The Device did not respond in a timely manner. This can be repeated at a later time.

---

[API](https://skmtc.net/clover/apis/platform-api.md) · [All operations](https://skmtc.net/clover/apis/platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/clover/platform-api/versions/08da265101a3/schema)