Citrus-Lime Knowledge Base

Sorry, we didn't find any relevant articles for you.

    Citrus Lime Cloud POS API

    The Cloud POS REST API has been created to enable integration to additional software to help your business. The REST API allows data to be extracted from, inserted into and amended in the Cloud POS system. You must read and comply with the Api Terms located on the API homepage. 

    A list of all the available operations and API Terms are documented here -  cloudposapi.citruslime.com 

    Authorisation

    The REST API relies on an authorisation key to be passed in the header tag. 

    In order to obtain an API key, you will need to contact the Citrus-Lime Support Team via phone or Live Chat.


    Posting Customer Orders / Work Orders

    In order to post customer orders, a property called 'storeClientCode' needs to be populated to determine which store the order will be posted to. You will need to contact Citrus Lime to retrieve the 'storeClientCode' records for your group. 


    Examples

    We've created both a VB and C# example project, which shows how to connect and interact with our API. 

    A solution containing both the example projects can be downloaded here (note: you may need to use an incognito window to download the file) - 

    http://support.citruslime.com/Software/CitrusLime.CloudPOS.Api.ExampleProjects.zip

    Was this article helpful?

    Still can't find
    what you are looking for?

    Our support team is here to help you.

    Contact Support

    Powered by