docs
  1. SCAYLE Resource Center
  2. Omnichannel
  3. Resources
  4. Stores
  5. Overview

Overview

The Store entity describes the retail store with all its properties.

Store data includes:

  • Name
  • Reference Key
  • Email
  • Address details
  • Settings
  • Storage Locations
  • Custom Data
  • Opening Hours & Exceptions
  • Images

Reference Key

The Reference Key can only be defined during the creation of the store. It cannot be updated or changed, once the store has been created.

Address details

The address details include Street, House No., Additional, Zip, City and Country Code.

The Latitude and Longitude will be generated automatically.

In case the timezone is not provided, it will be generated automatically.

Settings

Settings include information such as the Safety Stock Level, if a store participated in Click & Collect etc.

Safety Stock Level

The Safety Stock Level defines the number of items, that are not forwarded to the stock level requests.

Assuming a retail store has 100 items of a specific Product Variant in stock. That same store has set the Safety Stock Level to 20. In this case, the store inventory locator would return a stock level of 80.

Storage Locations

Storage Locations are used when fulfilling orders to keep track of where you placed the package until it's picked up.

Custom Data

Use the Custom Data field to store any data in JSON format

Opening Hours & Exceptions

Opening times are the weekly repeating times the retail store will be open. It is possible to define multiple timeframes per day, to accommodate for lunch breaks or similar cases.

Exceptions are single exceptions for times the retail store will be open or closed, such as Christmas or New Year's.

Images

New images can be provided as a Base64 String or a publicly reachable URL to the image resource.

You can also attach customData to an image, in the form of a JSON object