docs
  1. Merchants
  2. Merchant Allocation
  3. Interact With Admin API In Multi-merchant Setup

Interact with Admin API in Multi-Merchant Setup

Use this page when you already work in a multi-merchant setup and need request examples.

This page is API-focused.

If you need the conceptual model, start with Merchants.

If you need the rollout sequence, use Merchant Allocation.

Before you start

Make sure these prerequisites are met:

  • The merchant exists.
  • The warehouse exists.
  • The warehouse is connected to the merchant.
  • The warehouse is connected to the target shop country.
  • The assortment includes the merchant where needed.

In multi-merchant setups, send merchantReferenceKey explicitly for prices and stocks.

Admin API

Update assortment

In SCAYLE, you update shop country assortments by narrowing down or extending product sets based on different criteria. By including or excluding master categories, product IDs, or attributes, you replace the current assortment with the updated one.

This method is used to update a shop country assortment.

  • This method does not support partial updates.
  • This process can take some time and runs in the background.
ParameterDetails
masterCategories

MasterCategoryAssortmentConfiguration

Configuration of master category includes/excludes.

products

ProductAssortmentConfiguration

Configuration of product includes/excludes.

attributes

AttributeAssortmentConfiguration

Configuration of attribute includes/excludes.

merchantReferenceKeys

MerchantAssortmentConfiguration

Configuration of merchant includes/excludes.

Create stock information

You can update stock information by overriding existing information with a more recent warehouse stock change.

  • If you provide a changedAt date which is older than the last processed stock information, the stock will not change as this will be considered as outdated information. In this case the method will return the current stock. If you would like to find out if the information you sent was outdated, you have to compare what you’ve sent to what was returned in the response.
  • Sending a stock update without sellableWithoutStock flag will reset the value to false (the default value).
  • It is not possible to update stock information for composite product variants.
  • merchantReferenceKey can be provided to create merchant-specific stocks. It must refer to one of the merchants provided on product creation.

Make sure the provided warehouseReferenceKey exists before you create a stock. You can create a new shop warehouse.

The referenced warehouse must be linked to a shop country.

Otherwise, the shop country cannot use the stock.

ParameterDetails
quantity

Integer

Current quantity of SKU.

warehouseReferenceKey

String

Reference key of warehouse for which the stock update is related to.

changedAt

String

Date time when the stock changed in Iso8601 format.

sellableWithoutStock

Boolean

Defines if the variant can be sold even when the available stock is 0.

merchantReferenceKey

String

A merchant reference key the stock belongs to.

Examples

Create/update a price

Prices are defined on a product variant level and contain all information about prices, taxes and validity — upcoming prices can also be defined for automatic future price updates.

This method can be used to create a new Product Variant Price. You can create prices which are valid from now or in the future. If there is an already existing price for the same validation time frame, it will get replaced.

If multiple prices of the same variant are to be created then use update-variant endpoint which supports sending multiple prices at once.

Creating a new price, which is valid from the time of creation, will invalidate the current active price and become the new active one based on the dimensions explained on the prices overview page.

It is not possible to create a price for a composite product variant, when the automatic price calculation for composite variants is enabled.

merchantReferenceKey can be provided to create a merchant-specific price.

It must refer to one of the merchants provided on product creation.

ParameterDetails
key

String READ-ONLY

Key assigned by SCAYLE.

price

Integer

Price of the variant.

oldPrice

Integer

Old price of the variant.

recommendedRetailPrice

Integer

Recommended retail price of the variant.

buyingPrice

Integer

Buying price of the variant.

tax

Double

A valid tax rate.

countryCode

String

ISO 3166 alpha 2 country code.

currencyCode

String

ISO 4217 currency code.

groupKey

String

Key of the group the price is assigned to.

promotionKey

String

Key of the promotion the price is assigned to.

unitPrice

ProductVariantUnitPrice

Describes the price for a specific unit.

validFrom

String

Controls when the price will be activated. If not present or null, the valid from is specified from now.

validTo

String

Controls when the price will be deactivated. If not present or null, the price is valid forever.

merchantReferenceKey

String

A merchant reference key the price belongs to.

Examples

Create a merchant-specific price valid from now

Create Valid Price for Future

Create Valid Expiring Price

Create Price with Unit Price

Create Merchant-Specific Price