Child pages
  • Order Success Page - Magento 2
Skip to end of metadata
Go to start of metadata


Firefox user notice:

Please use a different web browser to view this document.

Sorry for the inconvenience.

Order Success Page for Magento 2 makes order success page highly-customizable via adding additional blocks, basing on customer segment or and order details. The content of the order success page is managed by the rules configured in the backend. Also, the module allows displaying cross-sells, checkout registration and newsletter signup blocks, and the links to the pages in social networks.

Compatibility: Magento Open Source 2.1.X - 2.3.0, Magento Commerce 2.1.X - 2.3.0

  Product Page

Thank you for choosing Aheadworks!

Installing Order Success Page

Command Line Installation

1. Backup your web directory and store database

2. Download the Order Success Page installation package

 3. Upload the contents of the Order Success Page installation package to your store root directory

 4. In the SSH console of your server, navigate to your store root folder:

cd path_to_the_store_root_folder


php -f bin/magento module:enable Aheadworks_OrderSuccessPage


php -f bin/magento setup:upgrade


php -f bin/magento setup:static-content:deploy

5. Flush the store cache, log out from the backend, and log in again


Make sure the installation is done from under the FTP administrator account. Otherwise, make sure to set 775 permissions to the store root directory after the extension is deployed.


Composer Installation

1. Log in to your customer account at and navigate to Account -> Composer access;

2. Configure your store to work with the Aheadworks composer repository:

Add composer repository to composer.json by running:

composer config repositories.aheadworks composer in the Magento installation root.

Use a key pair provided as login and pass. You can optionally save them in the global composer auth file.

 3. You can start using AW composer now.

 For extension names, navigate to Account -> Composer access.

 4. Open the root Magento directory on your server and send Composer the following command:

composer require <component-name>:<version>

Note: Use the previously copied component name and version.

 5. Make sure that Composer finished the installation without errors. Flush store cache, log out and log into the backend again.


Getting Around

Extension Logic

The Order Success Page extension adds its own blocks to the native Magento Order Success Page. The blocks can be divided into two types: Standard (see General Settings section) and Rule-based (see Rule section). Standard blocks are always displayed for all customers, while rule-based are shown only if the order complies rule settings.

Tracking codes

Because the extension uses the native page as a base, all tracking codes you may have on that page should continue working as they did before the installation.


The extension has 4 main blocks positions:

  • Page Top

  • Page Bottom

  • Content - Left Column

  • Content - Right Column

Some blocks like “Order Summary” and “Cross-Sell” can only be set to Page Top or Page Bottom positions, because of their size.

By default, the blocks are placed the following way:


Page Top

Content - Left Column     | Content - Right Column

Page Bottom


As you can see, if you would like to use a single-column layout, you can use only Page Top and Page Bottom positions.

To set a particular order of the Blocks, use the Priority field. This setting respects the layout position, so it is very easy to set the right order in every position of the page.

Backend Configuration 

General Settings


  • Title of the success page is an h1 tag, the main title of the page;
  • Text below the page title is an optional text you may want to display. With the settings above, you will get the following result:

  • Print Receipt For Guests controls whether guests can print their order Receipt from the Order Success Page or not;
  • Preview Order Success Page button allows quickly previewing any changes on the page.

Note, because the preview button uses an actual order data, make sure that you’ve got at least one order placed in the store view which you want to preview.


Order Summary


  • Enable Block to place the Order Summary block to the Order Success Page;
  • Position to choose between top and bottom positions of this block;
  • Sort Order to assign the block priority;
  • Shipping Information to add the shipping details to this block;
  • Billing Information to enable the billing data displaying;
  • Expand Order Items List By Default to allow/disallow this option.


  • Enable Block to place the Contacts block to the Order Success Page;
  • Position to choose between top/bottom/left/right positions of this block;
  • Sort Order to assign the block priority;
  • Name to customize the title of this block;
  • Short Description to create the text message relevant to your intends.
Note that while this block is intended for showing a link to your 'Contact us' page, generally, you can use it for any purpose, when you just need to show some text to all of your customers.


Customer Registration


  • Enable Block to display the Checkout Registration block on the Order Success Page;
  • Position to choose between top/bottom/left/right positions of this block;
  • Sort Order to assign the block priority;
  • Name to create a special title of this block;
  • Short Description to type the text message which encourages customers to create the account.


Newsletter Subscription

  • Enable Block to allow customers to subscribe to the newsletter;
  • Position to choose between top/bottom/left/right positions of this block;
  • Sort Order to assign the block priority;
  • Name to create a special title of this block;
  • Short Description for the message which invites shoppers to subscribe to the newsletter.


Static Block

  • Enable Block to place any block on your order success page;
  • Position to choose between top/bottom/left/right positions of this block;
  • Sort Order to assign the block priority;
  • Static Block to choose the block you need to display additionally basing on your primary goals.
Note that this block is visible for all customers by default. Use the Rules for more targeted content.


Cross-Sell Block

  • Enable Block to demonstrate native cross-sells configured in the settings of the definite products;
  • Position to choose between page top/bottom position;
  • Sort Order to assign the block priority.
Note that the Cross-Sell block displays 5 products by default.



General Information

Find the Rules section following the pass Content-> Order Success Page by Aheadworks -> Rules. Here you can see a standard grid with the list of the rules. The rules can be filtered and enabled/disabled/deleted in bulk.

  • Enable Rule to make the rule active;
  • Name the Rule to easily find and manage the rules created;
  • Description contains a summary of the rule functionality;
  • Store View is a scope of application of the rule created;
  • Customer Group includes different customer segments for you to choose;
  • Active From / Active To options allow scheduling the rule duration.

Rule setup examples

Each rule can display one of the following block types:

  • Text / Html - a basic type of the block; the content is configured right in the rule, in the WYSIWYG editor;

  • Static block - a static block created beforehand in Content-> Elements-> Blocks;

  • FAQ Category - a list of articles from a selected FAQ category. Requires FAQ extension by Aheadworks to be installed.

  • Blog Category - a list of blog posts from a selected Blog category. Requires Blog extension by Aheadworks to be installed.

a) If you want to add a static block

b) If you want to display a text message when a customer chooses a certain shipping method

c) If you want to display a coupon code when a purchase is made at a certain price


Product Page

Need Customization?

Magento 2 Custom Development Services by Aheadworks

You can always find the latest version of the software, full documentation, demos, screenshots, and reviews on
License agreement:
Contact Us:
Copyright © 2019 Aheadworks Co.

  • No labels