REST / JSON API

⌘K
  1. Home
  2. Docs
  3. REST / JSON API
  4. Show Line Items

Show Line Items

You would use this method to show items to the customer as they are rung up in the POS. This is currently only available on our Android based devices. You can run the getTerminalFeatures request to see if the device supports line items.

Input Parameters
Key – returned from the pairing method
Password– returned from the pairing method
TerminalIdreturned from the pairing method
Type– Valid values are “json” or “html”
Data– raw html to be passed to the terminal or json – This has be a string or you will get a “bad request” response

URL

https://api.econduitapps.com/1.0/showLineItems

Sample Request

{
	"Key": "123456789-0",
	"Password": "987654321-1",
	"Type": "json",
	"TerminalId": "1234",
	"Data": "{\"header\": {\"fgColor\": \"000000\",\"bgColor\": \"ffffff\",\"fontSz\": \"30\",\"rows\": [{\"text\": \"Joe's Pizza\",\"fontSz\":\"30\"},{\"text\": \"best pizza ever!!!\",\"fontSz\":\"30\"}]},\"body\": {\"fgColor\": \"000000\",\"fontSz\": \"22\",\"rows\": [{\"text\": \"1- Pizza\",\"subText\": \"onions, peppers\",\"amt\":\"$9.00\",\"fgColor\":\"111111\",\"bgColor\":\"cccccc\",\"fontSz\":\"22\"},{\"text\": \"Breadsticks\",\"subText\": \"Marinara\",\"amt\":\"$1.00\",\"fgColor\":\"222222\",\"bgColor\":\"eeeeee\",\"fontSz\":\"22\"}]},\"footer\": {\"fgColor\": \"000000\",\"fontSz\": \"22\",\"rows\": [{\"text\": \"SubTotal\",\"amt\":\"$10.00\",\"fontSz\":\"22\"},{\"text\": \"Tax\",\"amt\":\"$1.00\",\"fontSz\":\"22\"},{\"text\": \"Total\",\"amt\":\"$11.00\",\"fontSz\":\"22\"}]}}"
}

JSON Response

{
    "ResultCode": "Success",
    "Message": "Success"
}

JSON Format Sample
The format is broken up into 3 sections (Header, Body, Footer) and each section is comprised of rows. We are going to be adding a centering option for the header and we will be automatically defaulting the colors and font sizes in the near future. Be sure to stringify the json object before adding it to the data field in the request. If this is not done, you will get a “bad request” error.

{
	"header": {
		"fgColor": "000000",
		"bgColor": "ffffff",
		"fontSz": "20",
		"rows": [{
			"text": "Joe's Pizza",
			"fontSz":"18"			
		},
		{
			"text": "best pizza ever",
			"fontSz":"16"
		}]
	},
	"body": {
		"fgColor": "000000",
		"fontSz": "20",
		"rows": [{
			"text": "1- Pizza",
			"subText": "onions, peppers",
			"amt":"$9.00",
			"fgColor":"111111",
			"bgColor":"cccccc",
			"fontSz":"18"			
		},
		{
			"text": "Breadsticks",
			"subText": "Marinara",
			"amt":"$1.00",
			"fgColor":"222222",
			"bgColor":"eeeeee",
			"fontSz":"18"
		}]
	},
	"footer": {
		"fgColor": "ffffff",
		"fontSz": "20",
		"rows": [{
			"text": "SubTotal",
			"amt":"$10.00",
			"fontSz":"16"			
		},
		{
			"text": "Tax",
			"amt":"$1.00",
			"fontSz":"16"
		},
		{
			"text": "Total",
			"amt":"$11.00",
			"fontSz":"18"
		}]
	}
}

How can we help?