Skip to main content

List of attributes

All patterns must be enclosed in curly brackets. In patterns, you can use codes of attributes, filters, links to parent products, base php functions, and calculations.

The base pattern schema:
    {{ entity.attribute | filter | filter }}

Attribute patterns​

Primary attributes​

  • {{ product.attribute_set }}: the assigned attribute set name.
  • {{ product.description }}: the product description.
  • {{ product.status }}: the product status. Possible values: Enabled, Disabled.
  • {{ product.name }}: the product name.
  • {{ product.meta_description }}: the meta description from SEO section.
  • {{ product.meta_keyword }}: the meta keyword from SEO section.
  • {{ product.meta_title }}: the meta title from SEO section.
  • {{ product.entity_id }}: the product ID.
  • {{ product.type_id }}: the product type (simple, configurable, etc.).
  • {{ product.url }}: the product URL.
  • {{ product.url_with_options }}: the URL with custom options. This type of URL allows you to automatically select child options on the product page after the customer opens the link. At the end of the URL, there will be additional options for the parameters, f.e.: http://store.com/some-product-key.html#142=5596&93=5477
  • {{ product.sku }}: the product SKU.
  • {{ product.short_description }}: the short description.
  • {{ product.url_key }}: the product URL key.
  • {{ product.visibility }}: product visibility. Possible values: Not Visible Individually, Catalog, Search, Catalog, Search.

Prices & taxes​

  • {{ product.cost }}: the product cost price.
  • {{ product.final_price }}: the final saleable price after discounts. The price of a product, after applying special price and catalog price rules.
  • {{ product.final_price_tax }}: the price with tax included.
  • {{ product.msrp }}: the manufacturer's suggested retail price.
  • {{ product.price }}: the regular price.
  • {{ product.special_price }}: the special price. The special price ignores the values of Special price from date and Special price to date.
  • {{ product.tax_class_id }}: the tax class.
  • {{ product.tier_price }}: the tier price.

Category​

  • {{ product.category_ids }}: the IDs of the product's assigned categories.

  • {{ product.category.entity_id }}: the ID of the assigned category.

  • {{ product.category.path }}: the category path, e.g., Computers > Notebooks > Apple.

    Note

    If the product is assigned to multiple categories, the extension automatically selects Category and Category ID using this logic: The most nested category is always selected. For example, if a product is assigned to a few categories at different levels, the attribute {category} returns the name/id of the category, which is the most nested in the category tree. If the product is assigned to several categories at the same level, the extension selects the category with the lowest position of the product. You can change the position of the product at Catalog -> Manage сategories, in the tab Category products.

Images​

  • {{ product.image }}: the URL of the base product image.
  • {{ product.images }}: the direct URLs of gallery images of the product, separated by a comma.
  • {{ product.thumbnail }}: the URL of the thumbnail image.
  • {{ product.small_image }}: the URL of the small image of the product.
  • {{ product.gallery[0] }}, {{ product.gallery[1] }} ...: the url of gallery images of the product.
  • {{ product.rating_summary }}: the average rating (0 to 5).

Stock attributes​

  • {{ product.is_in_stock }}: the stock status. Possible values: 0 (out of stock), 1 (in stock).
  • {{ product.qty }}: the product quantity.
  • {{ product.stock_status }}: the stock status. Possible values: out of stock, in stock.

Reviews​

Note

To export review attributes, they should be set in the Reviews context. For example, to export, the review title must be set in the following construction:

{% for review in context.reviews %}
   <title><![CDATA[{{ review.title }}]]></title>
{% endfor %}
  • {{ review.id }}: the review ID.
  • {{ review.nickname }}: the reviewer's nickname.
  • {{ review.created_at }}: the review creation date.
  • {{ review.title }}: the review title (summary).
  • {{ review.detail }}: the review text.
  • {{ review.rating }}: the review rating.
  • {{ review.reviews_count }}: the number of approved reviews for this product.
  • {{ review.product.[product_attribute] }}: allows the use of product attributes within the Review context construction. Instead of [product_attribute], you should specify the product attribute code. For example, a product's SKU: {{ review.product.sku }}.

Multi source inventory sources​

Note

Multi-source inventory (MSI) is available, starting from Magento 2.3

Allows you to export MSI sources using the following pattern:

  • {{ product.inventory:source_code }}: the MSI source code for the product.

Parent product values​

You can use the suffix .parent ({{ product.parent.name }}, {{ product.parent.price }}, {{ product.parent.url }}, etc), if you need to return the value to the parent product.

Note:

If the current product associated with a configurable/grouped/bundled product, the pattern {{ product.parent.url }}, will return the URL to the parent product. If the extension can't find the parent product, it will use the current product.

The parent suffix is very useful when you export simple products with visibility Not Visible Individually. In this case, the product can't have a direct link, so you must use a link to the parent product.