POS Status Object

The POS status object contains information about a single till, including a heartbeat time stamp which can be used to determine if the Yocuda software on the till is still operating:

Name	Type	Description
source_id	string, required	the name of the source of this heartbeat
store_reference	integer or string, required	the store identifier
till_id	string, required	the descriptive identifier of this till
version	string, required	the client software version
runtime_version	string, optional	the client software runtime version
os_version	string, optional	the client software OS version
address	string, required	the client’s IP address
store	Store Object, optional	see Store Object
till_uuid	string, required	the UUID of this till
timestamp	string, required	the date and time of the last heartbeat request, in UTC, formatted as an ISO 8601 date

Notes

• The key store will either be a fully populated Store Object or the value null. If the value is null, then this indicates that the store_reference does not correspond with a valid store.

• The store identifier in store_reference may be invalid (in which case store has been set to null)

Example

{
  "address": "23.57.2.58",
  "source_id": "OposPrinter",
  "store": {
    "address": [
      "61 Hatton Garden"
    ],
    "city": "London",
    "country": "GBR",
    "id": 1,
    "locale": null,
    "name": "Paperless Fashion Clerkenwell",
    "phone": "+440000000000",
    "postcode": "EC1N 8LS",
    "reference": 4,
    "timezone": null
  },
  "store_reference": "1",
  "till_id": "Till 2",
  "till_uuid": "427fb9c1-06e8-4eee-99ae-2e82d77002d5",
  "timestamp": "2013-05-21T20:04:19.192000+00:00",
  "version": "2.2.0.0"
}