Catalog configuration paths reference

This section lists variable names and config paths available for options in the Admin under Stores > Settings > Configuration > Catalog.

The magento app:config:dump command writes these values to the shared configuration file, app/etc/config.php, which should be in source control. To optionally override any configuration settings or to set sensitive settings, see Use environment variables to override configuration settings. This topic does not list sensitive and system-specific values.

Catalog paths

These configuration values are available in the Admin in Stores > Settings > Configuration > Catalog > Catalog.

Name

Config path

Commerce only?

Mask for SKU

catalog/fields_masks/sku

Mask for Meta Title

catalog/fields_masks/meta_title

Mask for Meta Keywords

catalog/fields_masks/meta_keyword

Mask for Meta Description

catalog/fields_masks/meta_description

List Mode

catalog/frontend/list_mode

Products per Page on Grid Allowed Values

catalog/frontend/grid_per_page_values

Products per Page on Grid Default Value

catalog/frontend/grid_per_page

Products per Page on List Allowed Values

catalog/frontend/list_per_page_values

Products per Page on List Default Value

catalog/frontend/list_per_page

Product Listing Sort by

catalog/frontend/default_sort_by

Allow All Products per Page

catalog/frontend/list_allow_all

Use Flat Catalog Category

catalog/frontend/flat_catalog_category

Use Flat Catalog Product

catalog/frontend/flat_catalog_product

Swatches per Product

catalog/frontend/swatches_per_product

Allow Guests to Write Reviews

catalog/review/allow_guest

Allow Alert When Product Price Changes

catalog/productalert/allow_price

Price Alert Email Template

catalog/productalert/email_price_template

Allow Alert When Product Comes Back in Stock

catalog/productalert/allow_stock

Stock Alert Email Template

catalog/productalert/email_stock_template

Alert Email Sender

catalog/productalert/email_identity

Frequency

catalog/productalert_cron/frequency

Start Time

catalog/productalert_cron/time

Error Email Sender

catalog/productalert_cron/error_email_identity

Error Email Template

catalog/productalert_cron/error_email_template

Show for Current

catalog/recently_products/scope

Default Recently Viewed Products Count

catalog/recently_products/viewed_count

Default Recently Compared Products Count

catalog/recently_products/compared_count

Autostart base video

catalog/product_video/play_if_base

Show related video

catalog/product_video/show_related

Auto restart video

catalog/product_video/video_auto_restart

Catalog Price Scope

catalog/price/scope

Default Product Price

catalog/price/default_product_price

Display Product Count

catalog/layered_navigation/display_product_count

Price Navigation Step Calculation

catalog/layered_navigation/price_range_calculation

Default Price Navigation Step

catalog/layered_navigation/price_range_step

Display Price Interval as One Price

catalog/layered_navigation/one_price_interval

Maximum Number of Price Intervals

catalog/layered_navigation/price_range_max_intervals

Interval Division Limit

catalog/layered_navigation/interval_division_limit

Maximal Depth

catalog/navigation/max_depth

Minimal Query Length

catalog/search/min_query_length

Maximum Query Length

catalog/search/max_query_length

Search Engine

catalog/search/engine

Solr Server Timeout

catalog/search/solr_server_timeout

Indexation Mode

catalog/search/engine_commit_mode

Enable Search Suggestions

catalog/search/search_suggestion_enabled

Search Suggestions Count

catalog/search/search_suggestion_count

Show Results Count for Each Suggestion

catalog/search/search_suggestion_count_results_enabled

Enable Search Recommendations

catalog/search/search_recommendations_enabled

Search Recommendations Count

catalog/search/search_recommendations_count

Show Results Count for Each Recommendation

catalog/search/search_recommendations_count_results_enabled

Minimum Terms to Match

catalog/search/minimum_should_match

Generate “category/product” URL Rewrites

catalog/seo/generate_category_product_rewrites

Popular Search Terms

catalog/seo/search_terms

Product URL Suffix

catalog/seo/product_url_suffix

Category URL Suffix

catalog/seo/category_url_suffix

Use Categories Path for Product URLs

catalog/seo/product_use_categories

Create Permanent Redirect for URLs if URL Key Changed

catalog/seo/save_rewrites_history

Page Title Separator

catalog/seo/title_separator

Use Canonical Link Meta Tag For Categories

catalog/seo/category_canonical_tag

Use Canonical Link Meta Tag For Products

catalog/seo/product_canonical_tag

Enable

catalog/magento_catalogpermissions/enabled

Allow Browsing Category

catalog/magento_catalogpermissions/grant_catalog_category_view

Customer Groups

catalog/magento_catalogpermissions/grant_catalog_category_view_groups

Landing Page

catalog/magento_catalogpermissions/restricted_landing_page

Display Product Prices

catalog/magento_catalogpermissions/grant_catalog_product_price

Customer Groups

catalog/magento_catalogpermissions/grant_catalog_product_price_groups

Allow Adding to Cart

catalog/magento_catalogpermissions/grant_checkout_items

Customer Groups

catalog/magento_catalogpermissions/grant_checkout_items_groups

Disallow Catalog Search By

catalog/magento_catalogpermissions/deny_catalog_search

Order Item Status to Enable Downloads

catalog/downloadable/order_item_status

Default Maximum Number of Downloads

catalog/downloadable/downloads_number

Shareable

catalog/downloadable/shareable

Default Sample Title

catalog/downloadable/samples_title

Default Link Title

catalog/downloadable/links_title

Open Links in New Window

catalog/downloadable/links_target_new_window

Use Content-Disposition

catalog/downloadable/content_disposition

Disable Guest Checkout if Cart Contains Downloadable Items

catalog/downloadable/disable_guest_checkout

Use JavaScript Calendar

catalog/custom_options/use_calendar

Date Fields Order

catalog/custom_options/date_fields_order

Time Format

catalog/custom_options/time_format

Year Range

catalog/custom_options/year_range

Enable Catalog Events Functionality

catalog/magento_catalogevent/enabled

Enable Catalog Event Widget on Storefront

catalog/magento_catalogevent/lister_output

Number of Events to be Displayed in Event Slider Widget

catalog/magento_catalogevent/lister_widget_limit

Events to Scroll per Click in Event Slider Widget

catalog/magento_catalogevent/lister_widget_scroll

Maximum Number of Products in Related Products List

catalog/magento_targetrule/related_position_limit

Show Related Products

catalog/magento_targetrule/related_position_behavior

Rotation Mode for Products in Related Product List

catalog/magento_targetrule/related_rotation_mode

Maximum Number of Products in Cross-Sell Product List

catalog/magento_targetrule/crosssell_position_limit

Show Cross-Sell Products

catalog/magento_targetrule/crosssell_position_behavior

Rotation Mode for Products in Cross-Sell Product List

catalog/magento_targetrule/crosssell_rotation_mode

Maximum Number of Products in Upsell Product List

catalog/magento_targetrule/upsell_position_limit

Show Upsell Products

catalog/magento_targetrule/upsell_position_behavior

Rotation Mode for Products in Upsell Product List

catalog/magento_targetrule/upsell_rotation_mode

Inventory paths

These configuration values are available in the Admin in Stores > Settings > Configuration > Catalog > Inventory.

Name

Config path

Commerce only?

Decrease Stock When Order is Placed

cataloginventory/options/can_subtract

Set Items’ Status to be In Stock When Order is Cancelled

cataloginventory/options/can_back_in_stock

Display Out of Stock Products

cataloginventory/options/show_out_of_stock

Only X left Threshold

cataloginventory/options/stock_threshold_qty

Display Products Availability in Stock on Storefront

cataloginventory/options/display_product_stock_status

Synchronize with Catalog

cataloginventory/options/synchronize_with_catalog

Manage Stock

cataloginventory/item_options/manage_stock

Backorders

cataloginventory/item_options/backorders

Use deferred Stock update

cataloginventory/item_options/use_deferred_stock_update

Maximum Qty Allowed in Shopping Cart

cataloginventory/item_options/max_sale_qty

Out-of-Stock Threshold

cataloginventory/item_options/min_qty

Minimum Qty Allowed in Shopping Cart

cataloginventory/item_options/min_sale_qty

Notify for Quantity Below

cataloginventory/item_options/notify_stock_qty

Enable Qty Increments

cataloginventory/item_options/enable_qty_increments

Qty Increments

cataloginventory/item_options/qty_increments

Automatically Return Credit Memo Item to Stock

cataloginventory/item_options/auto_return

Run asynchronously

cataloginventory/bulk_operations/async

Asynchronous batch size

cataloginventory/bulk_operations/batch_size

Provider

cataloginventory/source_selection_distance_based/provider

Computation mode

cataloginventory/source_selection_distance_based_google/mode

Value

cataloginventory/source_selection_distance_based_google/value

Visual Merchandiser paths

These configuration values are available in the Admin in Stores > Settings > Configuration > Catalog > Visual Merchandiser.

Name

Config path

Commerce only?

Visible Attributes for Category Rules

visualmerchandiser/options/smart_attributes

Minimum Stock Threshold

visualmerchandiser/options/minimum_stock_threshold

Color Attribute Code

visualmerchandiser/options/color_attribute_code

Color Order

visualmerchandiser/options/color_order

XML sitemap paths

These configuration values are available in the Admin in Stores > Settings > Configuration > Catalog > XML Sitemap.

RSS Feeds paths

These configuration values are available in the Admin in Stores > Settings > Configuration > Catalog > RSS Feeds.

Email to a friend paths

These configuration values are available in the Admin in Stores > Settings > Configuration > Catalog > Email to a Friend.