POST barcode/{siteId}/{terminalId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
siteId

integer

Required

terminalId

integer

Required

Body Parameters

BarcodeModel
NameDescriptionTypeAdditional information
SiteId

unsigned integer

None.

TerminalId

integer

None.

CheckId

integer

None.

BarcodeData

string

None.

Subtotal

decimal number

None.

Tax

decimal number

None.

Balance

decimal number

None.

Items

Collection of ICheckEntry

None.

Request Formats

application/json, text/json

Sample:
{
  "SiteId": 1,
  "TerminalId": 2,
  "CheckId": 3,
  "BarcodeData": "sample string 4",
  "Subtotal": 5.0,
  "Tax": 6.0,
  "Balance": 7.0,
  "Items": [
    {
      "DisplayName": "sample string 1",
      "EntryType": 2,
      "ItemId": 3,
      "Level": 4,
      "LongDisplayName": "sample string 5",
      "MenuItemId": 6,
      "ModifierCode": 7,
      "ModifierGroupId": 8,
      "Price": 9.1,
      "Seat": 10,
      "Units": 11.1
    },
    {
      "DisplayName": "sample string 1",
      "EntryType": 2,
      "ItemId": 3,
      "Level": 4,
      "LongDisplayName": "sample string 5",
      "MenuItemId": 6,
      "ModifierCode": 7,
      "ModifierGroupId": 8,
      "Price": 9.1,
      "Seat": 10,
      "Units": 11.1
    }
  ]
}

application/xml, text/xml

Sample:
<BarcodeModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Pay.Platform.CloudConnect.Models">
  <Balance>7</Balance>
  <BarcodeData>sample string 4</BarcodeData>
  <CheckId>3</CheckId>
  <Items xmlns:d2p1="http://schemas.datacontract.org/2004/07/Pay.Platform.Site.Core.Contracts.Responses">
    <d2p1:Item>
      <d2p1:DisplayName>sample string 1</d2p1:DisplayName>
      <d2p1:EntryType>2</d2p1:EntryType>
      <d2p1:ItemId>3</d2p1:ItemId>
      <d2p1:Level>4</d2p1:Level>
      <d2p1:LongDisplayName>sample string 5</d2p1:LongDisplayName>
      <d2p1:MenuItemId>6</d2p1:MenuItemId>
      <d2p1:ModifierCode>7</d2p1:ModifierCode>
      <d2p1:ModifierGroupId>8</d2p1:ModifierGroupId>
      <d2p1:Price>9.1</d2p1:Price>
      <d2p1:Seat>10</d2p1:Seat>
      <d2p1:Units>11.1</d2p1:Units>
    </d2p1:Item>
    <d2p1:Item>
      <d2p1:DisplayName>sample string 1</d2p1:DisplayName>
      <d2p1:EntryType>2</d2p1:EntryType>
      <d2p1:ItemId>3</d2p1:ItemId>
      <d2p1:Level>4</d2p1:Level>
      <d2p1:LongDisplayName>sample string 5</d2p1:LongDisplayName>
      <d2p1:MenuItemId>6</d2p1:MenuItemId>
      <d2p1:ModifierCode>7</d2p1:ModifierCode>
      <d2p1:ModifierGroupId>8</d2p1:ModifierGroupId>
      <d2p1:Price>9.1</d2p1:Price>
      <d2p1:Seat>10</d2p1:Seat>
      <d2p1:Units>11.1</d2p1:Units>
    </d2p1:Item>
  </Items>
  <SiteId>1</SiteId>
  <Subtotal>5</Subtotal>
  <Tax>6</Tax>
  <TerminalId>2</TerminalId>
</BarcodeModel>

Response Information

Resource Description

CloudConnectResponse
NameDescriptionTypeAdditional information
message

string

None.

developerMessage

string

None.

code

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "message": "sample string 1",
  "developerMessage": "sample string 2",
  "code": 3
}

application/xml, text/xml

Sample:
<CloudConnectResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Pay.Platform.CloudConnect.Models">
  <code>3</code>
  <developerMessage>sample string 2</developerMessage>
  <message>sample string 1</message>
</CloudConnectResponse>