docs
  1. Developer-guide
  2. Shops
  3. Manage Shops

Manage Shops

General

Shop structure

The shop structure of SCAYLE consists of two levels:

  1. Shop.
  2. Shop Country.

Make sure to assign each shop to a country.
Shop settings can be overwritten at the country level.

For more information, check shop structure.

Admin API

Create your first shop

You can create your first minimal shop by defining the Name and a unique key for your instance:

Create a shop with a shop country

To be able to sell something you need to setup a Shop with a Shop Country. The Shop Country holds all the information (e.g. currency & language) for your new shop.
You can create a new Shop with a new Shop Country by defining the countries information of the shop:

Understand Price Groups

When you create a new Shop you can define a price group for the shop.
This should be used if you want to run multiple Shops (e.g. 'acme-fashion.com' and 'acme-shoes.com') and share the same prices in both shops. In this case you need to create both shops with the same price group key:

In the example above the prices for your products will be shared for the same currencies. Sho both shops will have the same prices.

Understand Shop Category Tree

If you operate your Shop in multiple countries you can share the category tree across the Shop Countries by setting a shared Shop Category Tree ID.
This has the benefit that you don't need to manage your Shop Category Tree individually in every country:

Typically you don't need to use this Feature.
If you just share your category tree across different Shop Countries the ID is set as default for you.

It's possible to use one SCAYLE instance to operate multiple shops which run under different legal entities.

If you want to create a new shop and assign the shop to a new legal entity you can simply add the legal entity ID to the create call:

Update your shop

To update your Shop you can lever the API / SDK in a very similar fashion than the Shop Create call.

It's not possible to update the `shopCategoryTreeId`, `companyId` and `priceGroupKey` settings after a Shop is created. If you want to change them you have to create a new Shop and delete the old one.

Add a shop country

If you want to start selling in a new Country you just need to create a new Shop Country for your Shop:

The Price Group is set on Shop level. If you create a new Shop Country the Price Group of the Shop is inherited.

Update a shop country

You can update a Shop Country by the following call:

Get a single shop

You can request any given shop with its dependent countries.

This method can be used to get an existing shop by providing the shop key.

This method allows to include nested resources using the with parameter.

Method Signature

Options

Shop read can be used with optional parameters - called options:

ParameterDetails
with

String

Allows to load the following nested resources within this request:

  • countries
  • countries.properties
  • countries.assortment
  • countries.warehouses
  • customData

See this example for details on how to use options.

Get a Shop

Get a Shop with country properties and assortment

Fetch multiple shops

SCAYLE allows you to request multiple shops at the same time considering different parameters to narrow down the query, e.g., price group key.

This method can be used to get a collection of existing shops. It is possible to refine the search by applying filters in the options.

This method allows to include nested resources using the with parameter.

Method Signature

Options

Shop collection read can be used with optional parameters - called options:

ParameterDetails
with

String

Allows to load the following nested resources within this request:

  • countries
  • countries.assortment
  • countries.warehouses
  • customData
limit

Integer

Maximum number of items in the result. (default: 100, maximum: 1000)

filters[priceGroupKey]

String

Comma-separated list of price group keys.

See this example for details on how to use options.

Get a list of Shops

Get a list of Shops filtered by price group key

Storefront API

Shops and assortments in SCAYLE can be fully customized, while still sharing selected information across multiple shops within the same instance.

Core functions of SCAYLE include creating and managing shops, defining shop-specific settings such as category trees and assortments, and optionally inheriting information from other shops when needed.

To ensure these configurations remain consistent and always available in the Storefront API, shop data is regularly refreshed through an indexing process and near real-time updates.

Shop assortments

Assortments of different shops can be customized based on:

  • assortment-related rules
  • shop categories and filters
  • shop-specific product information

The system enables users to assign different assortments and product scopes for each shop. They can define new assortments on a highly granular level, using inclusion and exclusion rules. All rules can be applied to:

  • attribute groups
  • products
  • merchants

Category tree and filter

In SCAYLE, users can define shop-specific category trees, which allows them to adapt quickly to changes and adjust product data for an individual shop. Similar to creating shop assortments, inclusion and exclusion rules define which products should be included in which shop category. All rules can be created for each category level and will automatically be inherited by the respective subcategories.

There are different options available for each shop category:

  • naming the shop category
  • defining the shop category path
  • showing/hiding shop categories
  • activating/deactivating shop categories

Multi-Shop management

It is possible to manage several shops in the same instance of the SCAYLE Panel. Every (new) shop can run entirely independently from any other shop. Some everyday use cases for operating multiple shops are:

  • individual shops for different assortments (e.g., only fashion, only furniture)
  • individual shops for different target groups (e.g., only women, only men)
  • individual shops for different markets (e.g., German shop, French shop)
  • individual shops for different brands (e.g., ABOUT YOU, EDITED)

Since we highly value and support our client's flexibility, there are no limitations on how shops can be handled in the same instance. It is possible to operate shops with overlapping assortments and shared products. Each shop will run independently from any other shop that is part of the same instance.

Shop-Specific product information

Additional product information can be added on the shop level to the predefined, global product structure. Similar to the master data configuration, users can work with different data types.

Information related to shop-specific attributes is connected to the Storefront API and will only be shown on the product detail page if a customer is visiting this specific shop.

How Shop Data is Updated

The Storefront API refreshes shop information across all shop countries through an indexing process, ensuring API responses always return the latest data.

The indexing process updates the following data:

Update Frequency

  • The indexing process typically runs every hour in the production environment.
  • In some cases, the process may take longer or be delayed as only a limited number of shops can be processed concurrently.
  • The indexing process's duration depends on:
    • Data volume (number of variants, attribute groups, product images ...)
    • Assortment size

Near Real-Time Updates

Certain data is also updated outside of the indexing process to provide faster visibility of critical changes:

  • Price updates (price property)
  • Stock information (stock property)
  • Variant availability (quantity)
  • Product availability (isActive flag and isSoldOut flag)

Near real-time updates make critical changes visible faster, but timing is not guaranteed.

Get shop configuration

With this method, it is possible to get the current shop configuration with all shop-specific properties. It is possible to modify these properties through the SCAYLE Panel.

Example

All examples require a configured Storefront API client to be available as client.

See Authentication for how to set it up.

Response

Further education - SCAYLE Academy

Previous
General
Next up
Assortment