Getting started

LS One API provides a suite of retail services that can be used to power in-store POS, mobile or web stores, self checkout or any custom retail scenario.

With LS One API it is possible to:

  • import / export master data from and into LS One: items and item hierarchies, barcodes, units of measure, currencies and exchange rates, taxes, prices, discounts, gift cards, vendors and customers

  • manage inventory through goods receiving documents, stock counting, transfer orders and requests

  • calculate total cost of a basket of items

  • search for sales transactions

It is a REST API built on ASP.NET Core and it's fully described in an OpenAPI 3.0 compliant document. The API requires authentication.

Getting access

The quickest way to explore the LS One API is through our demo environment available at https://lsoneapi.lsretail.com. The demo environment is refreshed every 8 hours.

If you are a LS One partner you can also host LS One API in your own IT infrastructure, see here for details. The source code for the API is available in LS One DevPack and can be customized to tailor a specific client.

Getting the LS One OpenAPI description

You can find the description here, in json and yml format.

Using the LS One OpenAPI description

There are many uses for an OpenAPI description. For example, you could:

  • Generate your own API client.

  • Validate and test a LS One REST API integration.

  • Explore and interact with the LS One REST API using third-party tools, such as Postman, Milkman or from Visual Code, using the REST Client extension.