Inbound API

Overview

These are the requests sent from the external systems to the shopreme DataHub. Those endpoints do not need to be enabled, as they will work out of the box.

If you want to only allow specific IP Addresses to connect to the shopreme Inbound API, please contact your shopreme integration consultant.

Authentication

All calls made to these endpoints must authenticate via HTTP Basic Auth, and an API token with credentials can be set up in the Management Console.

The API token used for the calls in the “Pay at cash register” section needs to have the scope “ExternalCashRegister API” assigned. The token for the Clearing and Reports should have the “Clearing API” scope.

In previous versions of the shopreme API, you could use a single account with multiple roles assigned to it. If you have the API tokens menu on your Users section in the shopreme Management Console, however, you should adjust the account type to an API token with the expected scopes, for clarity.

Search...

⌘K

Search...

⌘K

shopreme © 2025