Skip to main content

Intro

This flow is used to retrieve a third-party Carousel URL that displays marketing slides using pre-defined templates. It is typically shown on a Customer Facing Screen (CFS) connected to the POS terminal.

Display Carousel – Get 3rd-Party Carousel URL

[POST] /v2/pos/{posSystem}/Carousel

Headers

NameValueDescription
AuthorizationBearer Request authorization header
Content-Typeapplication/jsonContent type

Input parameters

Field nameDescription
posSystemThe identifier of the POS system (e.g., pax, clover)
posLocationIdID of the location
terminalIdThe identifier of POS Terminal

Input request

{
  "posLocationId": {posLocationId},
  "terminalId": {terminalId}
}

Response

{
  "data": {
    "url": "string"
  }
}

Response parameters

Field nameDescription
data.urlThe carousel URL