Glossary

A

Add-on
An application that integrates with and extends the SCAYLE Panel. Add-ons are developed, deployed, and hosted independently and are built as micro frontends. See also SCAYLE Extensions.
→ Add-on Development

Add-on API
REST API for extending the core features of the SCAYLE Panel.
→ Add-on API

Admin API
JSON REST API for backend operations such as managing products, prices, stock, warehouses, and shops. Use it only from trusted applications.
→ APIs

Assortment
The subset of the global product pool that is shown and sold in a specific shop country. You define it with include and exclude rules based on master categories, products, attributes, and merchants.
→ Assortment

Attribute Group
A collection of attribute values that describes a product characteristic, for example the group "color" with the values "black" and "blue". Attribute Groups are either simple (reusable values) or advanced (free text or structured data).
→ Attribute Groups

Audience
A static list of customers, selected by customer ID, that you use to target promotions and promotion codes. Not to be confused with Customer Group or Customer Segment.
→ Audiences

Authentication API
API for customer identity in the storefront: registration, login, password handling, and SSO. It issues the tokens used by the Customer Account API and the Headless Checkout.
→ Authentication API

B

Basket
Holds the variants a customer intends to buy. A basket is identified by a basketKey. SCAYLE uses "basket", not "cart".
→ Basket

C

Capture
Collecting the authorized payment amount from the customer. SCAYLE supports instant, delayed, and manual capture. With manual capture, you trigger the capture yourself via the API.
→ Manual Captures

Carrier
A delivery service provider such as DHL or UPS. Shipping options reference carrier groups, not individual carriers.
→ Carriers

Checkout API
Backend API for building a custom checkout frontend, see Headless Checkout.
→ Checkout API

Company
Represents a legal entity within your SCAYLE account. Every shop belongs to a company. Product data is shared across companies, while customer and order data are kept separate.
→ Single vs. Multi Company setup

Composable
A function provided by the Storefront SDKs for working with data such as products and categories. Composables wrap SCAYLE API calls and are used throughout the Storefront Application.
→ What is Storefront

Custom Data
Additional fields that extend the standard data model, for example for SEO information or shop, brand, and category properties.
→ Custom Data

Customer Account API
REST API for customer self-service, such as personal data, passwords, and order history.
→ Customer Account API

Customer Group
A label assigned to a customer, for example "VIP", "employee", or "B2B". Customer groups control prices, voucher eligibility, and storefront logic. A customer can belong to several groups.
→ Customer Groups

Customer Segment
A dynamic group of customers defined by rules, for example based on customer groups or custom data. Segments are evaluated in real time and used as conditions in promotions.
→ Customer Segments

D

Delivery Option
How the customer receives an order: Home Delivery, Collection Point, or Store Pickup. Each delivery option needs at least one matching Shipping Option.
→ Delivery Options

E

Entity
The top level of the product data structure. The default entities are Master, Product, and Variant. Media and Brand are additional entities for special purposes.
→ Entities

Environment (platform)
One of the three SCAYLE environments per tenant: Live (production), Test, and Preview (upcoming release). The environment is part of every API and checkout host name. Also called "space".
→ Infrastructure & Environments

Environment (Storefront Hosting)
A hosted version of a storefront, for example staging or QA, with its own deployments and environment variables. Not the same as a platform environment.
→ Environments

G

Gift Card
A means of payment with a balance. The customer redeems it in the checkout, and a second payment method covers any remaining amount. Unlike a Voucher, a gift card is not a discount.
→ Pay with gift cards

H

Headless Checkout
A checkout you build yourself on top of the Checkout API, for example for a native app or a POS system. The alternative to the Standard Checkout.
→ Headless Checkout

L

Locale
A combination of language and region, for example de_DE or en_GB. The locale controls translations and formatting. The market is defined by the Shop Country.
→ Locales

M

Master
The highest product level. It groups related products, for example all colors of a t-shirt.
→ Products

Master Category
A backend category used to structure product data. Every product has exactly one master category. Master categories are not visible to customers, unlike Shop Categories.
→ Master Categories

Merchant
The seller toward the end customer. Merchants influence assortment, prices, stock, and fulfilment. A merchant can only sell in a shop country if a warehouse, a shop country assignment, and the assortment are configured (merchant allocation).
→ Merchants

O

Order Delegation
The step that sends confirmed orders to the responsible merchants for fulfilment. In the order lifecycle, this is the transition from CONFIRMED to DELEGATED.
→ Order Delegation

Order State
The status of an order in its lifecycle: CREATED, PENDED, CONFIRMED, DELEGATED, SHIPPED, INVOICED, ABORTED, or CANCELLED.
→ Order Lifecycle & States

P

Pro-Rata Distribution
Splits an absolute promotion discount across all eligible items in proportion to their price.
→ Managing Pro-Rata Distribution

Product
The product level below the master, for example a red t-shirt. Products appear on listing and detail pages and contain one or more Variants.
→ Products

Promotion
A rule-based discount that is applied to items in the basket. The Storefront API evaluates promotions in real time.
→ Pricing & Promotions

Promotion Code
A code the customer enters in the basket or checkout to activate a promotion. Only Automatic Discount promotions can be code-based.
→ Promotion Codes

Promotion Effect
What a promotion does once its conditions are met: Automatic Discount, Buy X Get Y, or Combo Deal.
→ Promotion Effects

R

Reference Key
An identifier you assign from your own systems, for example an ERP SKU. It uniquely identifies a resource within your tenant. The Admin API accepts either the SCAYLE ID or the reference key (referenceKey).
→ APIs: Identifiers

RPC Method
A server-side function in the Storefront Application that is exposed through an automatically generated API. Use custom RPC methods to keep sensitive logic off the client.
→ RPC methods

S

SCAYLE Extensions
Add-ons built and provided by SCAYLE, for example the Customer Service Add-on. See also Add-on.
→ Add-on Overview

SCAYLE Panel
The user interface for managing shops, products, customers, orders, and settings.
→ SCAYLE Panel

Sellable without stock
A variant setting per warehouse that lets customers buy the variant even when its stock is zero.
→ Using Products in your Store

Sellable timeframe
The period (sellableFrom / sellableTo) in which a product is available in a shop country.
→ Manage Products

Shipping Option
A customer-facing shipping method such as "Standard" or "Express", configured per shop country with carrier groups and costs. Each shipping option belongs to a Delivery Option.
→ Configure Shipping Options

Shop
A virtual entity that corresponds to an online store, for example a brand shop or an outlet. A shop contains one or more Shop Countries.
→ Shops

Shop Category
A customer-facing category that structures the assortment in the storefront, for example Men ➜ Tops ➜ Shirts. A product can be in several shop categories.
→ Shop Categories

Shop Country
A combination of country and language within a shop, for example Switzerland/French. Each shop country can have its own assortment and shop categories.
→ Shops

Shop ID
In the Storefront API, the shopId identifies a Shop Country, not a shop. You find it on the shop dashboard in the SCAYLE Panel.
→ APIs: Country Identification

Space
See Environment (platform).

Standard Checkout
SCAYLE's ready-to-use checkout, embedded in the shop frontend as a web component.
→ Standard Checkout

Storefront API (SAPI)
REST API for building the customer-facing shop, for example navigation, product pages, basket, and search.
→ APIs: Storefront API

Storefront Application
SCAYLE's Nuxt-based starter kit for building online stores. It combines the Storefront SDKs with a complete storefront that includes the essential e-commerce pages.
→ What is Storefront

Storefront Hosting
SCAYLE's managed hosting for the Storefront Application, operated through the SCAYLE Panel.
→ What is Storefront Hosting?

T

Tenant
Your organization's instance on the SCAYLE platform. Together with the environment, the tenant name forms the host name, for example acme-live.
→ Infrastructure & Environments

V

Variant
The lowest product level, for example a size. Variants carry stock and prices and are what the customer buys.
→ Products

Voucher
A discount code that the customer enters in the checkout. Only one voucher is allowed per order. For new use cases, prefer Promotion Codes.
→ Vouchers

W

Warehouse
A logical fulfilment location that products are shipped from. A warehouse doesn't have to match a physical building. Warehouses are assigned to shop countries with a priority.
→ Logistic & Fulfilment

Webhook
A notification SCAYLE sends to a URL you specify when an event occurs, for example when an order is confirmed.
→ Webhooks

with parameter
A query parameter that controls which related data an API response includes, for example variants or images. The Storefront API and the Admin API each have their own with parameter.
→ Understanding the with parameter