v1

latestOpenAPI 3.1.02026-08-06731,0781.4 MB

Devices

Display Line Items

This function is used to display up to 10 line items on a UTG-controlled PIN pad. In additional Display Line Items requests, if the API Option APPENDLINEITEM is sent, the UTG will append the new line item(s) to the existing line item(s) displayed.

Integration Methods:

Locally Installed UTG

See the Integration Methods and URLs Section sections of the Development Quick Start guide for details regarding each processing option.

post/devices/lineitems

Headers

InterfaceVersionstring required

Example:2.1

Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed: $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \ + =

InterfaceNamestring required

Example:ForwardPOS

Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed: $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \ + =

CompanyNamestring required

Example:PAWS

Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed: $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \ + =

AccessTokenstring uuid required

Example:EA79FB05-3AA7-4500-AF9A-73F986FF2C1D

A security credential used to authenticate API requests and all i4Go® authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an Access Token Exchange request, which generates an Access Token using an authToken and clientGuid.

Request body

dateTimestring ISO 8601 required

The date and time in ISO 8601 format including the timezone offset (yyyy-mm-ddThh:mm:ss.nnn+hh:mm).

Must be sent as the local date/time of the merchant. For example, a request processed at a merchant in the Pacific time zone at 9:18am on April 15th 2021 would be sent as 2021-04-15T09:18:23.283-07:00

apiOptionsstring[]

API Options modify the request being made. See the API Options section for more information.

Example request

{
  "dateTime": "2024-05-21T09:18:23.283-07:00",
  "apiOptions": [
    "RETURNEXPDATE",
    "ALLOWPARTIALAUTH"
  ],
  "device": {
    "terminalId": "1742",
    "lineItems": [
      "Hamburger",
      "Fries",
      "Soda",
      "Cookie"
    ]
  }
}

Response

Request was processed

Example response

{
  "result": [
    {
      "dateTime": "2024-05-21T09:18:23.283-07:00",
      "device": {
        "terminalId": "1742"
      },
      "server": {
        "name": "TM01CE"
      }
    }
  ]
}