Skip to main content
POST
/
v2
/
pos
/
{posSystemId}
/
widget
/
start
Start POS widget session
curl --request POST \
  --url https://public-api-demo.clearline.me/v2/pos/{posSystemId}/widget/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "posLocationId": "6orMqUyq2Hg3tP",
  "terminalId": "6orMqUyq",
  "widgetId": "1",
  "couponId": ""
}
'
{
  "data": {
    "sessionId": "<string>",
    "qrCodePreviewHtmlLinkUrl": "<string>"
  }
}

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

posSystemId
string
required

POS System Id

Body

Request

Request to start POS widget

posLocationId
string
required

POS location identifier

Minimum string length: 1
terminalId
string
required

Terminal identifier

Minimum string length: 1
widgetId
integer<int32>
required

Widget identifier

couponId
string | null

Coupon unique identifier

Response

Success

data
object

Response to start POS widget