Labely APP Documentation

APP Documentation

Getting Started:

1) Preparations. After installing the app in your store, if you can not find it. Please enable Labely in your Shopify theme following these steps:

• Go to the main page of the Labely app.
• Click the button to enable the app’s block in your theme.
• Alternatively, manually activate the block via Theme Customizer by selecting ‘App embed’ and then choosing ‘Labely’.

Enabling the app embed block within your theme is essential for Labely to function. However, this only works in Store 2.0 themes, where the product details are shown.

2) Understanding Rules:

In the backend of the app, you have the flexibility to configure which labels are displayed under various scenarios. To effectively manage and prioritize these labels, especially when multiple apply to a single product, the app employs a hierarchical rule system. This system ensures efficient loading and processing by establishing a clear order of precedence among the labels. Take in consideration this prioritization:

• Product rules have the highest priority.
• Vendor rules can override collection and metafield rules.
• Collection rules override only metafield rules.
• Metafield rules are the broadest and have the least priority.

3) About rules using metafields:

To increase speed, metafield values are requested from your Storefront, then given to the app. Thus, there are some criteria to be met:

• Each metafield has to be exposed to the Storefront.
• The metafield namespaces have to be put into the block settings. To help this, you have a small tool in the home page of the app, listing you all the necessary namespaces to specify. You just have to copy the list, and insert it into the block settings.
• Unfortunately, we cannot unify this input. So, wherever you are using the block – for example, multiple product templates, or collection templates – you have to specify this list for each of them.

Due to these criteria, we recommend you using ‘stocktime’namespace to provide values. This namespace is already in the list whenever you create a new block, alleviating the work to maintain each block on the Storefront.

However! There is the option also to create collections based on metafield values. This can be useful as well if you do not wish to expose your metafields to the Storefront. Then, you can just simply create a new collection-based rule to manage these products. It requires more step, but is also a good alternative.

4) Set up a rule:

When editing a rule, you will encounter the following sections:

• Rule Name: This is the identifier for the rule. We suggest making it as descriptive as possible to avoid confusion when managing multiple rules.
• Stock Options: This is a drop dropdown selector from which you can choose which lable you are editing at any given moment. Based on the current stock product level:

Each rule have the following stock options to show the label messages:

• 1. In stock: the product has more stock
• 2. Out of stock rule: it will show when the produc will no have stock
• 3. Continue selling rule: it will show when the product it set up as continue selling even there is no stock
• 4. Low Stock: It will show the labels when the product stock is bellow to the value you will set up in the input “Threshold value” that will appears when you choose this option:

• Preview: Here is the real time preview of the labels with the style that we can manage in the bottom block “Edit Style”
• Condition: very important block because here we will define when or in which case this specific rule will show on the product pages. The conditions are defined by:

• 1. Type: here we will select the type of the rule: Metafields, collection, vendor or product. Depending on the selection we will have different options

• For Product and Collection we will have the option to choose from a list.
• For Vendor it will have:

• > Check mode: Check mode: equals, contains, starts with, end with, doesn’t contain
• > Value: it will be the vendor name that will follow the Check mode rule

• For Metafileds we will have : 

• > Check mode: equals, contains, starts with, end with, doesn’t contain
• > Value: which value for the type should match for apply this rule following the “Check mode” option
• > Metafiled path: we suggest to use “stocktime” and “labelay”

For example, if we would like to show the rule when the metafied is “superA” and the Metaield path are “stocktime”.”labely” we should set up as follow:

• Type needs to be = Metafield
• Check mode = Equal
• Value = superA (this value need to be set it up on the product metafields we created for this application. To set up the metafileds please define in  “Settings > Custom data > Product > Add definition”)