Skip to content

Products

Products are one of the core foundations of the application.

Amarant supports different types of products, each with its own purpose and behavior. Those are generic, grouped, customizable and collection.

Products can be configured to be non-physical, such as downloadable content, tickets or vouchers.

Product list

Product types


Generic

This is the base product type which is salable on its own or can be used as a part or "children" of other product types. Some platforms call this a "simple" product or a "variant".

The most notable difference to other product types is that only this type can have an inventory (stock item and source item).

Grouped

The grouped product is a container of child products that are of "generic" type. As the name suggests, it's used to group related products. One or many products may be purchased from the group along with a desired quantity for each.

Customizable

Some platforms call this the "configurable" product.

It consists of "generic" products which are mapped to a set of options a customer can select to match a product.

For example, it may consist of products with multiple colors and sizes. A customer has to select a combination of color and size to match a desired product.

Collection

Experimental

This feature is not documented yet.

Create a product


Navigate to CatalogProducts, click on "Add product" and select a product type / attribute set in the dropdown.

Edit product

SKU

SKU is an abbreviation for "Stock keeping unit". In Amarant, this is a unique identifier of a single product.

Master SKU

This field is meant to hold a value of the supplier's SKU, if you sell products under different SKUs in your catalog, but you want to keep a reference to the original.

For example, you might be selling exactly the same products from different sources / suppliers. Their master SKU would be the same but their product SKU would differ.

Attribute set

As mentioned in attributes, an attribute set defines which attributes a product can have, meaning the attributes that can be edited and stored on a particular product.

Warning

If you change the attribute set of a product, values for attributes not present in the new attribute set will be removed.

Some product attributes affect the behavior of the application. This could be "factory attributes" or the ones being setup by the product module, and they could be attributes created by other modules depending on the product module.

Here is a list of such factory attributes:

Attribute Description
URL alias This value is used to generate product URLs. If the value changes, new URLs are generated and the old ones are retired, which means they're redirected to the new URLs.
Status Boolean value which determines if a product should exist in a particular frontend store.
Visibility Sets a visibility of a product in a particular frontend store.

Product can be "Visible" - which means it's visible in the category view, search and product view.
If set to "Visible in URL", the product will be visible in product view only.
Lastly, if set to "Not visible", the product will not even be present in the frontend store data storage.
Physical Boolean value which determines if a product is physical.
Non-physical products cannot be shipped. If there are no physical products in a cart, there is no shipping step in the frontend store checkout.

Channels

This value determines one or multiple channels the product should be assigned to. Product will only be present in the channels it's assigned to.

Categories

This value determines one or multiple categories the product should be placed into. This affects category view, where products from a particular category are displayed.

Flags

Flags specify behavior we want to add to a particular product.

Flag Behavior
Disallow automated updates of price attribute Will not allow the price to be changed programmatically, for example during a product sync. It will skip the update of the attribute.
Disallow pricing modifiers Will not allow any pricing modifier to be applied on the product. All of them will be skipped, if any.
Disallow pricing rules Will not allow any pricing rule to be applied on the product. All of them will be skipped, if any.

Add images to a product

Add product image

Choose a file and optionally edit alternate text.
Selecting the "Featured" checkbox flags the entry to be treated as the product's primary image.

Editing existing images of a product

Edit product image

Optionally edit alternate text and set the image as featured.
To flag an image for removal, select the "Remove" checkbox.

Tip

Although multiple entries can be flagged as primary, by default only the first found primary entry will be rendered in places like product list or in the cart.

Important

Images are uploaded or removed when you save the product, not before.

Updating stock of a product

Update stock

Change the quantity and "In Stock" value for a particular source item. The "code" refers to source code which the source item belongs to.

Click on "Save product" to complete the process.