Post Point of Sale (POS) data

To send POS data to CashLantern, use this API endpoint.

To use this API endpoint, you will need to receive an API key from SprintQuip. This API endpoint is specially developed to reconcile the POS cash sales per cashier with the actual cash deposited into the cash recycle/deposit machine. If you wish to send data that does not conform to the format required by this endpoint, we will encourage you to use the generic post endpoint documented here.

POST /api_v1/post_posdata

The request body should be POS transactions. There are some mandatory fields that are required:

• TransactionDate - this should be in the format DD/MM/YYYY
• TransactionTime - this should be in the format HH:MM:SS
• Timezone - this must be the TZ database name. For Sydney, Australia the TZ database name is Australia/Sydney. This link has a full list of TZ database names.
• StoreID - this is a unique identifier you would use to distinguish different venues you want to report. If there is only ever going to be one (1) store, you can hardcode this to a specific value.
• LocationID - this is a unique identifier that identifies the various locations within the store/venue. For example, the bar would have a different location id to the cafe at reception.
• CashierID - POS operator ID is a unique identifier to distinguish various POS operators within the venue/store.
• CashOut - Total amount of cash out sales are EFTPOS transactions where the customer has requested cash out.
• CashSale - This is the net amount in cash sales, where the customer has paid in cash. The net would be cash given by customer minus the change given to the customer.
• CashPickup - This is the total amount of surplus cash that was taken out of the POS register during the shift and deposited into the cash deposit machine or cash recycle machine.

You may also send any number of optional fields, such as:

• Cashier Firstname
• Cashier Lastname
• No Sale transactions
• Total items sold
• Markdown sales
• Void sales

Request and Response formats are in JSON.

You must include the Authorization api-key in the header.
The header key to use is Authorization and the value is in the format api-key:<apikey>

Here is an example of what the body would look like, if you sent the mandatory fields and the optional fields listed above:

{
        "transactiondate": "28/08/2018",
        "transactiontime": "14:03:56",
        "timezone": "Australia/Sydney",
        "storeid": 1001,
        "locationid": "front-bar",
        "cashierid": "E1203",
        "cashout": "400.00",
        "cashsale": "13825.48",
        "cashpickup": "500.00",
        "firstname": "Jane",
        "lastname": "Doe",
        "nosale": "20.00",
        "items": 344,
        "markdownsales": "54.32",
        "voidsales": "32.44"
}

Back home