Declaration of PREMIUM license’s extended functionality support

PREMIUM is a Shop-Script license with extended functionality as compared with the PRO license and includes the following:

  • customizable, including fractional, product quantity for adding to the shopping cart,
  • customizable product quantity units,
  • kanban board mode for order listings.

The PREMIUM license will receive more extended functionality in the future.

For a fully-fledged use of the PREMIUM license’s extended functionality with other software products that may be integrated with Shop-Script, such as apps, plugins, design themes, and widgets, a user must ensure that such software product do support such integration. To achieve this, a user must perform the following actions in backend section “Store → Settings → PREMIUM license compatibility”:

  • For payment & shipping plugins: select integration options for PREMIUM license’s extended functionality.
  • For apps and Shop-Script plugins: disable individual products if they do not support the extended functionality.

A user makes their choice based on the information provided by each software product as displayed on the compatibility page. To facilitate the choice for a user, every listed software product must declare its support for extended functionality as shown below.

Configuration file

A software product must contain configuration file shop_support.json of the following contents:

{
    "support_premium": "yes",
    "support_premium_description": "...",
    "support_premium_description_de_DE": "...",
    "support_premium_description_fr_FR": "...",
    "support_premium_description_...": "..."
}

Allowed parameters and their values:

  • support_premium: string values:
    • "yes": full support for extended functionality,
    • "no": no support for extended functionality,
    • "partial": partial support for extended functionality.
  • support_premium_description: description of the product’s individual integration details relating to the extended functionality, with HTML tags support. A user will use this description to decide whether to use the product with the PREMIUM license’s extended functionality or to disable it in their Webasyst backend. The text must be as descriptive and brief as possible.
  • support_premium_description_...: descriptions for other language locales. If no description is speciied for a certain locale then users with that locale will be displayed the default description specified for the support_premium_description parameter.

shop_support.json file’s location

  • For apps, plugins and widgets: in the lib/config/ directory.
  • For design themes: in the directory of a design theme for the Shop-Script app.

If a product has no shop_support.json file, and no special tag has been added to a product (see more details about special tags below in the “Special tags priority on Webasyst Store” section), then “No data” status is displayed on the compatibility page, without a description.

Extra details about various types of products

Apps

All apps are by default compatible with PREMIUM license’s extended functionality unless otherwise is specified in the shop_support.json file.

Only the apps containing that file are listed on the compatibility page. Their list is extended by a fixed list of apps defined by Shop-Script developers:

Shop-Script plugins

All Shop-Script plugins are listed on the compatibility page.

Other apps’ plugins

Plugins developed for other apps are by default considered compatible with PREMIUM license’s extended functionality unless otherwise is specified in the shop_support.json file.

Only those plugins for other apps which contain that file are listed on the compatibility page. Their list is extended by an additional list of plugins matching special conditions defined by Shop-Script developers.

Design themes

All installed design themes for Shop-Script are listed on the compatibility page.

That file must be contained only in the directory of a design theme developed for Shop-Script. It should not be added to the directory of the parent theme, within a theme family, which is not developed for Shop-Script.

Shipping & payment plugins

All shipping and payment plugins are listed on the compatibility page regardless of the presence of the shop_support.json file.

  • If a plugin contains the shop_support.json file then the displayed status of extended functionality support corresponds to that specified in that file.
  • If a plugin contains no shop_support.json file then the displayed status of extended functionality support corresponds to the values of parameters in the lib/config/plugin.php file as described below:
    • if value true is set for both parameters 'fractional_quantity' and 'stock_units' then this corresponds to status "yes",
    • if value true is set for any of the parameters 'fractional_quantity' or 'stock_units' then this corresponds to status "no"
    • other values of these two parameters or absence of values correspond to status "partial".

Read more about the declaration of PREMIUM license’s extended functionality in shipping and payment plugins.

Widgets

Widgets are not listed on the compatibility page.

Special tags priority on Webasyst Store

Webasyst Store’s staff may, at their discretion, assign one of special tags to a software product and thus mark the product as:

  • either supporting extended functionality,
  • or not supporting it.

Special tags have the highest priority over any values in products’ configuration files.