1. Scayle Resource Center
  2. API Reference
  3. Getting Started
  4. Introduction


SCAYLE Omnichannel API is a REST API enabling integration of online and on-site stores. You can use it to locate nearby stores and identify available items needed for click-and-collect or reservations.

For more details, see the Omnichannel API Developer Guide


Base URL


All requests must be made over HTTPS.

  • Authorization Bearer Token
  • Content-Type application/json

How to Use:

  1. Generate access token via the login/register endpoint of the Auth Api.
  2. Use the access token as Bearer token for authentication.
  3. Use the https://{tenant}-{environment}-omnichannel.addon.scayle.cloud/api/v1 as the base URL.

Download Full Reference

Using Postman or similar tools? You can download this reference as a JSON file and import it to start sending requests directly.

Download omnichannel api.json