Skip to main content
POST
/
pos
/
{posSystemId}
/
transaction
Create POS Transaction
curl --request POST \
  --url https://public-api-demo.clearline.me/pos/{posSystemId}/transaction \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "sessionId": "<string>",
  "transactionId": "<string>",
  "terminalId": "<string>",
  "posLocationId": "<string>",
  "customer": {
    "id": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "birthDate": "2023-11-07T05:31:56Z",
    "contacts": [
      {
        "email": "<string>",
        "phone": "<string>"
      }
    ]
  },
  "salesPerson": {
    "id": "<string>",
    "firstName": "<string>",
    "lastName": "<string>"
  },
  "purchaseName": "<string>",
  "purchaseId": "<string>",
  "purchaseQuantity": 123,
  "purchasePrice": "<string>",
  "transactionType": "Undefined",
  "transactionAmount": 123,
  "transactionDate": "2023-11-07T05:31:56Z",
  "products": [
    {
      "productId": "<string>",
      "productName": "<string>",
      "manufacturer": "<string>",
      "productCategory": "<string>",
      "quantity": 123
    }
  ],
  "loyalty": {
    "cardNumber": "<string>"
  }
}
'
{
  "data": {
    "id": "<string>",
    "qrCodeWidget": {
      "shortLinkUrl": "<string>",
      "qrCode": {
        "htmlLinkUrl": "<string>",
        "previewHtmlLinkUrl": "<string>"
      },
      "notificationMessageId": "<string>",
      "profile": {
        "id": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "customerEmail": "<string>",
        "customerPhone": "<string>",
        "salesPerson": "<string>",
        "purchaseName": "<string>",
        "purchaseId": "<string>",
        "purchaseCategory": "<string>",
        "purchasePrice": "<string>",
        "gender": "<string>"
      },
      "sessionId": "<string>"
    },
    "cfsTemplate": {
      "accountTemplateId": 123,
      "cfsCarouselUrl": "<string>"
    },
    "posStatus": "Accepted",
    "loyalty": {
      "status": "Applied",
      "awardDescription": "<string>",
      "qrCode": {
        "linkUrl": "<string>",
        "qrCodeLinkUrl": "<string>",
        "primaryText": "<string>",
        "secondaryText": "<string>"
      }
    }
  }
}

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

posSystemId
string
required

Body

New Pos terminal transaction request

sessionId
string
required

Session identifier

Minimum string length: 1
transactionId
string
required

Transaction identifier

Minimum string length: 1
terminalId
string
required

Terminal identifier

Minimum string length: 1
posLocationId
string
required

Location POS identifier

Minimum string length: 1
customer
object

POS system transaction customer data

salesPerson
object

POS system transaction sales person data

purchaseName
string | null

Customer purchase

purchaseId
string | null

Customer purchase identifier

purchaseQuantity
integer<int32>

Customer purchase quantity

purchasePrice
string | null

Customer purchase price

transactionType
enum<string>

POS transaction types

Available options:
Undefined,
Sale
transactionAmount
number<double> | null

Transaction amount

transactionDate
string<date-time>

Transaction date time

products
object[] | null

Transaction products

loyalty
object

Transaction LoaltyProgram details

Response

Success

data
object

New Pos terminal transaction response