API Terms Summary
If you need additional functionality but can’t find a Citrus-Lime approved app, you can use the Citrus-Lime API to build or commission the build, of an app for the sole use of your company.
You, your employees or app developers cannot approach or encourage any other person or company to use this app without Citrus-Lime's express written permission. Access to this app by any 3rd party, even at their request, is strictly prohibited. You cannot sell or permit use of the app to anyone outside of your organisation for any purpose.
Failure to comply with the terms will result in the indefinite removal of your API key.
The Cloud POS Interactive API
Available to perform actions and update data within CloudPOS. View the documentation for the API, and try it out.
Get Started
The Cloud POS Data Export API
Available between 0400 and 0600 to batch export data into Business Intelligence and Reporting Platforms. View the documentation for the API.
Learn more
Cloud POS API Client NuGet Package
Provides a C# wrapper for the Cloud POS REST API. This will handle Cloud POS API rate limiting and paging (e.g. if you make a request to get a list, the API will make the required paging calls to return a complete list).
View in Nuget.org
Cloud POS Web Hooks
Available to register Web Hooks for Cloud POS events. Once a webhook is registered we will send a POST request to the address after an event occurs in Cloud POS. Currently we only support one Event Type which is Transactions.
Get Started
The Cloud MT API
The Cloud MT API is a public REST API for accessing and updating product-related information on your ecommerce store.
View Documentation