Sales configuration paths reference

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

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.

Sales paths

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

Name	Config path	Commerce only?
Hide Customer IP	sales/general/hide_customer_ip
Subtotal	sales/totals_sort/subtotal
Discount	sales/totals_sort/discount
Shipping	sales/totals_sort/shipping
Tax	sales/totals_sort/tax
Fixed Product Tax	sales/totals_sort/weee
Grand Total	sales/totals_sort/grand_total
Gift Cards	sales/totals_sort/giftcardaccount
Store Credit	sales/totals_sort/customerbalance
Allow Reorder	sales/reorder/allow
Logo for PDF Print-outs (200x50)	sales/identity/logo
Logo for HTML Print View	sales/identity/logo_html
Address	sales/identity/address
Enable	sales/minimum_order/active
Minimum Amount	sales/minimum_order/amount
Include Tax to Amount	sales/minimum_order/tax_including
Description Message	sales/minimum_order/description
Error to Show in Shopping Cart	sales/minimum_order/error_message
Validate Each Address Separately in Multi-address Checkout	sales/minimum_order/multi_address
Multi-address Description Message	sales/minimum_order/multi_address_description
Multi-address Error to Show in Shopping Cart	sales/minimum_order/multi_address_error_message
Use Aggregated Data	sales/dashboard/use_aggregated_data
Pending Payment Order Lifetime (minutes)	sales/orders/delete_pending_after
Allow Gift Messages on Order Level	sales/gift_options/allow_order
Allow Gift Messages for Order Items	sales/gift_options/allow_items
Allow Gift Wrapping on Order Level	sales/gift_options/wrapping_allow_order
Allow Gift Wrapping for Order Items	sales/gift_options/wrapping_allow_items
Allow Gift Receipt	sales/gift_options/allow_gift_receipt
Allow Printed Card	sales/gift_options/allow_printed_card
Default Price for Printed Card	sales/gift_options/printed_card_price
Enable MAP	sales/msrp/enabled
Display Actual Price	sales/msrp/display_price_type
Default Popup Text Message	sales/msrp/explanation_message
Default “What’s This” Text Message	sales/msrp/explanation_message_whats_this
Enable Order by SKU on My Account in Storefront	sales/product_sku/my_account_enable
Enabled	sales/instant_purchase/active
Button Text	sales/instant_purchase/button_text
Customer Groups	sales/product_sku/allowed_groups
Enable Archiving	sales/magento_salesarchive/active
Archive Orders Purchased	sales/magento_salesarchive/age
Order Statuses to be Archived	sales/magento_salesarchive/order_statuses
Enable RMA on Storefront	sales/magento_rma/enabled
Enable RMA on Product Level	sales/magento_rma/enabled_on_product
Use Store Address	sales/magento_rma/use_store_address

Sales emails paths

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

Name	Config path	Commerce only?
Asynchronous sending	sales_email/general/async_sending
Enabled	sales_email/order/enabled
New Order Confirmation Email Sender	sales_email/order/identity
New Order Confirmation Template	sales_email/order/template
New Order Confirmation Template for Guest	sales_email/order/guest_template
Send Order Email Copy Method	sales_email/order/copy_method
Enabled	sales_email/order_comment/enabled
Order Comment Email Sender	sales_email/order_comment/identity
Order Comment Email Template	sales_email/order_comment/template
Order Comment Email Template for Guest	sales_email/order_comment/guest_template
Send Order Comments Email Copy Method	sales_email/order_comment/copy_method
Enabled	sales_email/invoice/enabled
Invoice Email Sender	sales_email/invoice/identity
Invoice Email Template	sales_email/invoice/template
Invoice Email Template for Guest	sales_email/invoice/guest_template
Send Invoice Email Copy Method	sales_email/invoice/copy_method
Enabled	sales_email/invoice_comment/enabled
Invoice Comment Email Sender	sales_email/invoice_comment/identity
Invoice Comment Email Template	sales_email/invoice_comment/template
Invoice Comment Email Template for Guest	sales_email/invoice_comment/guest_template
Send Invoice Comments Email Copy Method	sales_email/invoice_comment/copy_method
Enabled	sales_email/shipment/enabled
Shipment Email Sender	sales_email/shipment/identity
Shipment Email Template	sales_email/shipment/template
Shipment Email Template for Guest	sales_email/shipment/guest_template
Send Shipment Email Copy Method	sales_email/shipment/copy_method
Enabled	sales_email/shipment_comment/enabled
Shipment Comment Email Sender	sales_email/shipment_comment/identity
Shipment Comment Email Template	sales_email/shipment_comment/template
Shipment Comment Email Template for Guest	sales_email/shipment_comment/guest_template
Send Shipment Comments Email Copy Method	sales_email/shipment_comment/copy_method
Enabled	sales_email/creditmemo/enabled
Credit Memo Email Sender	sales_email/creditmemo/identity
Credit Memo Email Template	sales_email/creditmemo/template
Credit Memo Email Template for Guest	sales_email/creditmemo/guest_template
Send Credit Memo Email Copy Method	sales_email/creditmemo/copy_method
Enabled	sales_email/creditmemo_comment/enabled
Credit Memo Comment Email Sender	sales_email/creditmemo_comment/identity
Credit Memo Comment Email Template	sales_email/creditmemo_comment/template
Credit Memo Comment Email Template for Guest	sales_email/creditmemo_comment/guest_template
Send Credit Memo Comments Email Copy Method	sales_email/creditmemo_comment/copy_method
Enabled	sales_email/magento_rma/enabled
RMA Email Sender	sales_email/magento_rma/identity
RMA Email Template	sales_email/magento_rma/template
RMA Email Template for Guest	sales_email/magento_rma/guest_template
Send RMA Email Copy Method	sales_email/magento_rma/copy_method
Enabled	sales_email/magento_rma_auth/enabled
RMA Authorization Email Sender	sales_email/magento_rma_auth/identity
RMA Authorization Email Template	sales_email/magento_rma_auth/template
RMA Authorization Email Template for Guest	sales_email/magento_rma_auth/guest_template
Send RMA Authorization Email Copy Method	sales_email/magento_rma_auth/copy_method
Enabled	sales_email/magento_rma_comment/enabled
RMA Comment Email Sender	sales_email/magento_rma_comment/identity
RMA Comment Email Template	sales_email/magento_rma_comment/template
RMA Comment Email Template for Guest	sales_email/magento_rma_comment/guest_template
Send RMA Email Copy Method	sales_email/magento_rma_comment/copy_method
Enabled	sales_email/magento_rma_customer_comment/enabled
RMA Comment Email Sender	sales_email/magento_rma_customer_comment/identity
RMA Comment Email Recipient	sales_email/magento_rma_customer_comment/recipient
RMA Comment Email Template	sales_email/magento_rma_customer_comment/template
Send RMA Email Copy Method	sales_email/magento_rma_customer_comment/copy_method
Display Order ID in Header	sales_pdf/invoice/put_order_id
Display Order ID in Header	sales_pdf/shipment/put_order_id
Display Order ID in Header	sales_pdf/creditmemo/put_order_id

Tax paths

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

Name	Config path	Commerce only?
Tax Class for Shipping	tax/classes/shipping_tax_class
Tax Class for Gift Options	tax/classes/wrapping_tax_class
Default Tax Class for Product	tax/classes/default_product_tax_class
Default Tax Class for Customer	tax/classes/default_customer_tax_class
Tax Calculation Method Based On	tax/calculation/algorithm
Tax Calculation Based On	tax/calculation/based_on
Catalog Prices	tax/calculation/price_includes_tax
Shipping Prices	tax/calculation/shipping_includes_tax
Apply Customer Tax	tax/calculation/apply_after_discount
Apply Discount On Prices	tax/calculation/discount_tax
Apply Tax On	tax/calculation/apply_tax_on
Enable Cross Border Trade	tax/calculation/cross_border_trade_enabled
Default Country	tax/defaults/country
Default State	tax/defaults/region
Default Post Code	tax/defaults/postcode
Display Product Prices In Catalog	tax/display/type
Display Shipping Prices	tax/display/shipping
Display Prices	tax/cart_display/price
Display Subtotal	tax/cart_display/subtotal
Display Shipping Amount	tax/cart_display/shipping
Display Gift Wrapping Prices	tax/cart_display/gift_wrapping
Display Printed Card Prices	tax/cart_display/printed_card
Include Tax In Order Total	tax/cart_display/grandtotal
Display Full Tax Summary	tax/cart_display/full_summary
Display Zero Tax Subtotal	tax/cart_display/zero_tax
Display Prices	tax/sales_display/price
Display Subtotal	tax/sales_display/subtotal
Display Shipping Amount	tax/sales_display/shipping
Display Gift Wrapping Prices	tax/sales_display/gift_wrapping
Display Printed Card Prices	tax/sales_display/printed_card
Include Tax In Order Total	tax/sales_display/grandtotal
Display Full Tax Summary	tax/sales_display/full_summary
Display Zero Tax Subtotal	tax/sales_display/zero_tax
Enable FPT	tax/weee/enable
Display Prices In Product Lists	tax/weee/display_list
Display Prices On Product View Page	tax/weee/display
Display Prices In Sales Modules	tax/weee/display_sales
Display Prices In Emails	tax/weee/display_email
Apply Tax To FPT	tax/weee/apply_vat
Include FPT In Subtotal	tax/weee/include_in_subtotal

Checkout paths

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

Name	Config path	Commerce only?
Enable Onepage Checkout	checkout/options/onepage_checkout_enabled
Allow Guest Checkout	checkout/options/guest_checkout
Display Billing Address On	checkout/options/display_billing_address_on
Enable Terms and Conditions	checkout/options/enable_agreements
Quote Lifetime (days)	checkout/cart/delete_quote_after
After Adding a Product Redirect to Shopping Cart	checkout/cart/redirect_to_cart
Grouped Product Image	checkout/cart/grouped_product_image
Configurable Product Image	checkout/cart/configurable_product_image
Preview Quote Lifetime (minutes)	checkout/cart/preview_quota_lifetime
Display Cart Summary	checkout/cart_link/use_qty
Display Shopping Cart Sidebar	checkout/sidebar/display
Maximum Display Recently Added Item(s)	checkout/sidebar/count
Payment Failed Email Sender	checkout/payment_failed/identity
Payment Failed Email Receiver	checkout/payment_failed/receiver
Payment Failed Template	checkout/payment_failed/template
Send Payment Failed Email Copy Method	checkout/payment_failed/copy_method

Shipping settings paths

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

Multishipping settings paths

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

Delivery methods paths

These configuration values are available in the Admin in Stores > Settings > Configuration > Sales > Delivery Methods.

Name	Config path	Commerce only?
Enabled	carriers/flatrate/active
Title	carriers/flatrate/title
Method Name	carriers/flatrate/name
Type	carriers/flatrate/type
Price	carriers/flatrate/price
Calculate Handling Fee	carriers/flatrate/handling_type
Handling Fee	carriers/flatrate/handling_fee
Displayed Error Message	carriers/flatrate/specificerrmsg
Ship to Applicable Countries	carriers/flatrate/sallowspecific
Ship to Specific Countries	carriers/flatrate/specificcountry
Show Method if Not Applicable	carriers/flatrate/showmethod
Sort Order	carriers/flatrate/sort_order
Enabled	carriers/freeshipping/active
Title	carriers/freeshipping/title
Method Name	carriers/freeshipping/name
Minimum Order Amount	carriers/freeshipping/free_shipping_subtotal
Displayed Error Message	carriers/freeshipping/specificerrmsg
Ship to Applicable Countries	carriers/freeshipping/sallowspecific
Ship to Specific Countries	carriers/freeshipping/specificcountry
Show Method if Not Applicable	carriers/freeshipping/showmethod
Sort Order	carriers/freeshipping/sort_order
Enabled	carriers/tablerate/active
Title	carriers/tablerate/title
Method Name	carriers/tablerate/name
Condition	carriers/tablerate/condition_name
Include Virtual Products in Price Calculation	carriers/tablerate/include_virtual_price
Export	carriers/tablerate/export
Import	carriers/tablerate/import
Calculate Handling Fee	carriers/tablerate/handling_type
Handling Fee	carriers/tablerate/handling_fee
Displayed Error Message	carriers/tablerate/specificerrmsg
Ship to Applicable Countries	carriers/tablerate/sallowspecific
Ship to Specific Countries	carriers/tablerate/specificcountry
Show Method if Not Applicable	carriers/tablerate/showmethod
Sort Order	carriers/tablerate/sort_order
Enabled for Checkout	carriers/ups/active
Enabled for RMA	carriers/ups/active_rma
UPS Type	carriers/ups/type
Mode	carriers/ups/mode_xml
Origin of the Shipment	carriers/ups/origin_shipment
Gateway URL	carriers/ups/gateway_url
Title	carriers/ups/title
Enable Negotiated Rates	carriers/ups/negotiated_active
Packages Request Type	carriers/ups/shipment_requesttype
Container	carriers/ups/container
Weight Unit	carriers/ups/unit_of_measure
Destination Type	carriers/ups/dest_type
Maximum Package Weight (Please consult your shipping carrier for maximum supported shipping weight)	carriers/ups/max_package_weight
Pickup Method	carriers/ups/pickup
Minimum Package Weight (Please consult your shipping carrier for minimum supported shipping weight)	carriers/ups/min_package_weight
Calculate Handling Fee	carriers/ups/handling_type
Handling Applied	carriers/ups/handling_action
Handling Fee	carriers/ups/handling_fee
Allowed Methods	carriers/ups/allowed_methods
Free Method	carriers/ups/free_method
Enable Free Shipping Threshold	carriers/ups/free_shipping_enable
Free Shipping Amount Threshold	carriers/ups/free_shipping_subtotal
Displayed Error Message	carriers/ups/specificerrmsg
Ship to Applicable Countries	carriers/ups/sallowspecific
Ship to Specific Countries	carriers/ups/specificcountry
Show Method if Not Applicable	carriers/ups/showmethod
Sort Order	carriers/ups/sort_order
Enabled for Checkout	carriers/usps/active
Enabled for RMA	carriers/usps/active_rma
Mode	carriers/usps/mode
Packages Request Type	carriers/usps/shipment_requesttype
Container	carriers/usps/container
Size	carriers/usps/size
Length	carriers/usps/length
Width	carriers/usps/width
Height	carriers/usps/height
Girth	carriers/usps/girth
Machinable	carriers/usps/machinable
Maximum Package Weight (Please consult your shipping carrier for maximum supported shipping weight)	carriers/usps/max_package_weight
Calculate Handling Fee	carriers/usps/handling_type
Handling Applied	carriers/usps/handling_action
Handling Fee	carriers/usps/handling_fee
Allowed Methods	carriers/usps/allowed_methods
Free Method	carriers/usps/free_method
Enable Free Shipping Threshold	carriers/usps/free_shipping_enable
Free Shipping Amount Threshold	carriers/usps/free_shipping_subtotal
Displayed Error Message	carriers/usps/specificerrmsg
Ship to Applicable Countries	carriers/usps/sallowspecific
Ship to Specific Countries	carriers/usps/specificcountry
Debug	carriers/usps/debug
Show Method if Not Applicable	carriers/usps/showmethod
Sort Order	carriers/usps/sort_order
Enabled for Checkout	carriers/fedex/active
Enabled for RMA	carriers/fedex/active_rma
Title	carriers/fedex/title
Web-Services URL (Production)	carriers/fedex/production_webservices_url
Web-Services URL (Sandbox)	carriers/fedex/sandbox_webservices_url
Packages Request Type	carriers/fedex/shipment_requesttype
Packaging	carriers/fedex/packaging
Dropoff	carriers/fedex/dropoff
Weight Unit	carriers/fedex/unit_of_measure
Maximum Package Weight (Please consult your shipping carrier for maximum supported shipping weight)	carriers/fedex/max_package_weight
Calculate Handling Fee	carriers/fedex/handling_type
Handling Applied	carriers/fedex/handling_action
Handling Fee	carriers/fedex/handling_fee
Residential Delivery	carriers/fedex/residence_delivery
Allowed Methods	carriers/fedex/allowed_methods
Hub ID	carriers/fedex/smartpost_hubid
Free Method	carriers/fedex/free_method
Enable Free Shipping Threshold	carriers/fedex/free_shipping_enable
Free Shipping Amount Threshold	carriers/fedex/free_shipping_subtotal
Displayed Error Message	carriers/fedex/specificerrmsg
Ship to Applicable Countries	carriers/fedex/sallowspecific
Ship to Specific Countries	carriers/fedex/specificcountry
Debug	carriers/fedex/debug
Show Method if Not Applicable	carriers/fedex/showmethod
Sort Order	carriers/fedex/sort_order
Enabled for Checkout	carriers/dhl/active
Enabled for RMA	carriers/dhl/active_rma
Title	carriers/dhl/title
Content Type	carriers/dhl/content_type
Calculate Handling Fee	carriers/dhl/handling_type
Handling Applied	carriers/dhl/handling_action
Handling Fee	carriers/dhl/handling_fee
Divide Order Weight	carriers/dhl/divide_order_weight
Weight Unit	carriers/dhl/unit_of_measure
Size	carriers/dhl/size
Height	carriers/dhl/height
Depth	carriers/dhl/depth
Width	carriers/dhl/width
Allowed Methods	carriers/dhl/doc_methods
Allowed Methods	carriers/dhl/nondoc_methods
Ready time	carriers/dhl/ready_time
Displayed Error Message	carriers/dhl/specificerrmsg
Free Method	carriers/dhl/free_method_doc
Free Method	carriers/dhl/free_method_nondoc
Enable Free Shipping Threshold	carriers/dhl/free_shipping_enable
Free Shipping Amount Threshold	carriers/dhl/free_shipping_subtotal
Ship to Applicable Countries	carriers/dhl/sallowspecific
Ship to Specific Countries	carriers/dhl/specificcountry
Show Method if Not Applicable	carriers/dhl/showmethod
Sort Order	carriers/dhl/sort_order

Google API paths

These configuration values are available in the Admin in Stores > Settings > Configuration > Sales > Google API.

Name	Config path	Commerce only?
Enable	google/analytics/active
Account type	google/analytics/type
Enable Content Experiments	google/analytics/experiments
List property for the catalog page	google/analytics/catalog_page_list_value
List property for the cross-sell block	google/analytics/crosssell_block_list_value
List property for the up-sell block	google/analytics/upsell_block_list_value
List property for the related products block	google/analytics/related_block_list_value
List property for the search results page	google/analytics/search_page_list_value
‘Internal Promotions’ for promotions field “Label”.	google/analytics/promotions_list_value
Enable	google/adwords/active
Conversion ID	google/adwords/conversion_id
Conversion Language	google/adwords/conversion_language
Conversion Format	google/adwords/conversion_format
Conversion Color	google/adwords/conversion_color
Conversion Label	google/adwords/conversion_label
Conversion Value Type	google/adwords/conversion_value_type
Conversion Value	google/adwords/conversion_value

Gift cards paths

These configuration values are available in the Admin in Stores > Settings > Configuration > Sales > Gift Cards.