Manage Prices

General

Prices in SCAYLE can be concurrently applied to different countries, groups and campaigns as needed.

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. For a specific variant, there can be multiple prices active at the same time based on the following dimensions:

• countryCode: The country in which the price is effective.
• groupKey: Price groups can be used to apply different prices in different shops within the same country (e.g., B2C vs. B2B).
• promotionKey: The price promotion key can be used to have multiple valid prices for the same country and price group within the same shop at the same time. The Storefront API can be used to retrieve a specific price by sending a request with a defined price promotion key.

The currency (currencyCode) is not part of these dimensions as it must match the respective country.

Price key

Every new price gets a generated key. This key might change due to certain conditions. For example, when a future price becomes an active price, the key is modified.

Merchant-Specific Prices

You can create prices for a specific merchant by providing its reference key in the merchantReferenceKey field.

Product Variant Price Entity

Admin API

Create/Update a Price

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

About this Method

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.

Method Signature

JavascriptPHPcURLJava

Copy

let response = await adminApi.apis.Prices.createProductVariantPrice(
  {variantIdentifier: variantIdentifier},
  {requestBody: newPrice}
);

let createdPrice = response.body;

Details

• 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.
• Future prices are activated by a price activator cron job running every hour. Old prices are then deactivated.
• merchantReferenceKey can be provided to create a merchant-specific price. Note that merchantReferenceKey must refer to one of the merchants provided on product creation.

Create Valid Price from Now

JavascriptPHPcURLJava

Copy

let newPrice = {
    price: 2499,
    tax: 19.0,
    currencyCode: "EUR",
    countryCode: "DE"
};

let response = await adminApi.apis.Prices.createProductVariantPrice(
    {variantIdentifier: 1},
    {requestBody: newPrice}
);

let createdPrice = response.body;

Create Valid Price for Future

JavascriptPHPcURLJava

Copy

let newPrice = {
    price: 2499,
    tax: 19.0,
    currencyCode: "EUR",
    countryCode: "DE",
    validFrom: "2022-07-23T11:30:58+00:00"
};

let response = await adminApi.apis.Prices.createProductVariantPrice(
    {variantIdentifier: 1},
    {requestBody: newPrice}
);

let createdPrice = response.body;

Create Valid Expiring Price

JavascriptPHPcURLJava

Copy

let newPrice = {
    price: 2499,
    tax: 19.0,
    currencyCode: "EUR",
    countryCode: "DE",
    validTo: "2021-01-01T08:00:00+00:00"
};

let response = await adminApi.apis.Prices.createProductVariantPrice(
    {variantIdentifier: 1},
    {requestBody: newPrice}
);

let createdPrice = response.body;

Create Price with Unit Price

JavascriptPHPcURLJava

Copy

let newPrice = {
    price: 2499,
    tax: 19.0,
    currencyCode: "EUR",
    countryCode: "DE",
    unitPrice: {
        unit: "ml",
        amount: 100,
        price: 249
    }
};

let response = await adminApi.apis.Prices.createProductVariantPrice(
    {variantIdentifier: 1},
    {requestBody: newPrice}
);

let createdPrice = response.body;

Create Merchant-Specific Price

JavascriptPHPcURLJava

Copy

let newPrice = {
    price: 2499,
    tax: 19.0,
    currencyCode: "EUR",
    countryCode: "DE",
    merchantReferenceKey: "merchant-1"
};

let response = await adminApi.apis.Prices.createProductVariantPrice(
    {variantIdentifier: 1},
    {requestBody: newPrice}
);

let createdPrice = response.body;

Get a Collection of Prices

When you request variant prices, you can extend the query with several identifiers to get multiple active prices.

About this Method

This method can be used to get a collection of existing product variant prices.

Method Signature

JavascriptPHPcURLJava

Copy

let response = await adminApi.apis.Prices.getProductVariantPrices({variantIdentifier: variantIdentifier});
let prices = response.body.entities;

Parameters

List of Prices

JavascriptPHPcURLJava

Copy

let response = await adminApi.apis.Prices.getProductVariantPrices({variantIdentifier: 1});
let prices = response.body.entities;

prices.forEach(
    price => console.log(price.price)
);

Delete a product variant price

You can easily delete prices by using the respective identifiers.

About this Method

This method can be used to delete a price.

Method Signature

JavascriptPHPcURLJava

Copy

await adminApi.apis.Prices.deleteProductVariantPrice({variantIdentifier: variantIdentifier, priceKey: priceKey});

Details

• It is not possible to remove a price from a composite product variant, when the automatic price calculation for composite variants is enabled.
• It is not allowed to delete a merchant price other than a future price.

Delete a Price

JavascriptPHPcURLJava

Copy

await adminApi.apis.Prices.deleteProductVariantPrice({variantIdentifier: 1, priceId: '1-10'});

Price Rounding

A shop country price rounding represents a price rounding assigned to a shop country.

SCAYLE allows users to create and manage any number of price rounding configurations.

The primary purpose of this feature is to allow users to customize price rounding settings.

Price rounding precision

You can set the price rounding precision (the value by which the price is rounded up/down/ to the nearest integer). For simplicity, the precision values used in the following table are allowed:

• 1.0
• 5.0
• 0.05
• 0.95
• 0.99

Example of precision value rounding

The price rounding configurations apply at the shop country and currency level. For example, a configuration set for AY CH will specifically impact prices in Swiss Francs (CHF) for the corresponding shop and country.

Only the following prices are affected:

• prices
• old prices
• promotion prices
• campaign prices

Create a Shop Country Price Rounding

Method Signature

JavascriptPHPcURLJava

Copy

const response = await adminApi.apis.PriceRoundings.createShopCountryPriceRounding(
    { shopKey: shopKey, countryCode: countryCode },
    { requestBody: shopCountryPriceRounding }
);
const createdShopCountryPriceRounding = response.body;

Example

JavascriptPHPcURLJava

Copy

let newShopCountryPriceRounding = {
    currencyCode: "EUR",
    precision: "1.00",
    roundingType: "nearest",
};

const response = await adminApi.apis.PriceRoundings.createShopCountryPriceRounding(
    {
        shopKey: "ms",
        countryCode: "DE"
    },
    {
        requestBody: newShopCountryPriceRounding
    }
);

const createdShopCountryPriceRounding = response.body;

Delete a Shop Country Price Rounding

Method Signature

JavascriptPHPcURLJava

Copy

await adminApi.apis.PriceRoundings.deleteShopCountryPriceRounding(
    { shopKey: shopKey, countryCode: countryCode, priceRoundingId: priceRoundingId }
);

Example

JavascriptPHPcURLJava

Copy

adminApi.apis.PriceRoundings.deleteShopCountryPriceRounding(
    {
        shopKey: "ms",
        countryCode: "DE",
        priceRoundingId: 123
    }
);

Get a Shop Country Price Rounding Collection

Method Signature

JavascriptPHPcURLJava

Copy

const response = await adminApi.apis.PriceRoundings.getShopCountryPriceRoundings(
    { shopKey: shopKey, countryCode: countryCode },
);
const priceRoundings = response.body.entities;

Example

JavaScriptPHPcURLJava

Copy

const response = await adminApi.apis.PriceRoundings.getShopCountryPriceRoundings("ms", "DE");
const priceRoundings = response.body.entities;

priceRoundings.forEach(
    priceRounding => console.log(priceRounding.id)
);