Reading list Switch to dark mode

    User Guide for Magento 2 Dealership Extension

    Updated 4 September 2023

    Magento 2 Dealership Extension: Store owners who want dealers in their store will benefit greatly from the dealership management module.

    This module allows the customers to register themselves as a dealer, and check the dealership status for their dealership request. The customers can also find the dealers at the nearest location in their region.

    Note: This module is using Geolocation. To have these services you must have the Google API Key to make use of this extension. You can generate one by clicking  here

    Check a brief overview of the module-



    • The Admin can approve, disapprove, and as well as delete the dealership request of a customer.
    • The display fields for an attribute can be hidden or displayed by the admin.
    • The Admin can enable or disable the attribute status.
    • The Admin can create, delete or assign a group for the attribute.
    • Group status can also be set as enable or disable.
    • The customers can register to become a seller.
    • The customers can check the status of their dealership requests.
    • A customer can also search for the dealers at any location.

    Install Extension from Webkul Store

    #1 Download Module

    Firstly, you need to log in to Webkul Store, go to My Account>My Purchased Products section, verify and then download and extract the contents of this zip folder on the system.

    Start your headless eCommerce
    Read More

    #2 Upload Folder

    Once the module zip is extracted, follow path src>app and then copy the app folder into the Magento 2 root directory on the server as shown below:


    #3 Run Commands

    After uploading the module folder, you need to run the following commands in the Magento 2 root directory:

    • php bin/magento setup:upgrade
    • php bin/magento setup:di:compile
    • php bin/magento setup:static-content:deploy
    • php bin/magento indexer:reindex
    • php bin/magento cache:flush

    Install Extension from Magento Marketplace

    If you have purchased this extension from the Magento Marketplace then please follow the below process or visit this link.

    #1 Get Access Keys

    You need to get access keys, navigate to My Profile in Magento Marketplace, then choose Access Keys in the My Products section.


    Go to Magento 2 and then you need to copy both the Access Keys – Public Key and Private Key. These access keys will be needed in the next steps for authentication.


    If access keys are not created earlier, click Create A New Access Key, enter any name and click OK.


    #2 Update composer.json File

    To know the component name and version number, go to your Magento Marketplace account section, My Profile>My Purchases, then find this extension to view the details. Please note – Below is an example image, every extension will have its unique component name and version.


    After that, navigate to your Magento project directory and update your composer.json file in the following format.

    composer require <component-name>:<version>

    For example, to install version 5.0.0 of this extension you need to run the following command:

    composer require webkul/module-dealership:5.0.0

    #3 Enter Access Keys

    Now you will need to enter the Access Keys that you obtained as explained in the first step #1 Get Access Keys. Wait for Composer to finish updating your project dependencies and make sure there aren’t any errors.

    #4 Run Command

    You need to run the following commands:

    • php bin/magento setup:upgrade
    • php bin/magento setup:di:compile
    • php bin/magento setup:static-content:deploy
    • php bin/magento indexer:reindex
    • php bin/magento cache:flush

    Language Translation

    For translating the module language, navigate through src/app/code/Webkul/Dealership/i18n and edit the en_US.csv file. Thereafter, rename the CSV as “en_SA.csv” and translate all right side content after the comma in the Arabic language. After editing the CSV, save it.

    Then upload it to the path src/app/code/Webkul/Dealership/i18n where the Magento 2 is installed on the server. The module gets translated into the Arabic Language. It supports both RTL and LTR languages.


    The user can edit the CSV like the image below.

    Quick Product Edit--a

    Admin Configuration-Magento 2 Dealership Extension

    After the successful installation of the module, the admin can configure the Dealership Management module by navigating through Store>Configuration>Dealership. However, The admin has to follow the below steps for general settings:


    Enable: The admin has to select yes to enable the module status.

    Google API Key: Enter the Google API key.

    Radius Unit: Set the radius to a mile or kilometre from here.

    Allow Image Extension: The admin can allow the image extensions by entering the image extension separated by commas.

    Allow File Extension: The admin can allow the file extensions by entering the file type separated by commas.

    Dealership Management-Magento 2 (Adobe Commerce) Dealership Extension

    The admin can manage the dashboard, dealers, attributes, and as well as attribute groups from the Dealership Management option from the back-end admin panel.


    Dealership Dashboard

    Please note that before checking the dashboard, the admin has the ability to allocate orders to dealers. This enables dealers to review their sales graphs. To assign orders to dealers, please follow the steps below.

    If a customer places an order, the admin has the ability to assign that order to a dealer by navigating to the “Sales > Order > View > Dealer” section and taking action.


    Once an order has been assigned, the admin has the ability to see the dealer’s name within the order list.


    In the dashboard, the admin has the ability to review comprehensive dealer information along with a sales graph.


    Manage Dealers

    Furthermore, The admin can Delete, Approve, and disapprove the dealership request from Actions drop-down list.


    Dealer Attribute Manager

    Moreover, The admin can delete, manage the display fields, attribute status, and assign groups from the drop-down list. The Manage Display Fields has an option to display or hide the attribute on the dealer profile by the admin.


    Thereafter, the Attribute status can be set as enable or disable by the admin.


    The admin can assign the group from the Assign Group option from the drop-down.


    The Admin can also create a new attribute by clicking on Add Attribute button. Firstly, The admin has to enter the following details to add an attribute:


    Default Label: The Admin can enter the default label for the attribute.

    Attribute Code: The attribute code needs to enter for the attribute.

    Front-end Input Type: The admin will select the front-end input type.

    Values Required: The admin can select Yes or No for the value.

    Input Validation: The admin can apply input validation from here.

    Input Field Sort Oder: The admin can set a sort order for the input field.

    Assign Group: From here the admin can assign an attribute group.

    Attribute Status: The admin can enable or disable the attribute status.


    Manage Labels: The admin can set the default store view and test store view for the attribute.


    Now the admin can click on the Save Attribute button to save that attribute.

    Attribute Group Manager

    The admin can delete the group and can enable or disable the status of the attribute group from the action drop-down list.


    The Admin can create a new attribute group by clicking on Add New Group button. The admin will enter the group name and will have to enable the status of the group.


    Assign Attributes

    The Admin has to enter the attribute code and attribute label for the group. Now click on the Save Group button to save the group.


    Front-End Workflow-Magento 2 Dealership Extension

    In the front-end, the customer visits the website landing page and there the customer will find the options for becoming a Dealer, Find Dealer, and Dealership status.

    Become a Dealer form :

    dealership-Magento2 Dealership Extension

    If a customer wants to become a dealer then the customer has to click on Become a Dealer option and the below page will open:

    The customer will have to enter personal details like; First Name, Last Name, email, password, and confirm password.

    dealership-Magento2 Dealership Extension

    When the customer clicks on Proceed button, the Business details page will appear.

    In the Business details, the address information like; Company, street address, city, etc. will be entered by the customer and in the Business Information, the customer will have to enter the dealership location.

    Note: The admin can add or delete additional attributes according to the business requirement.

    Become a dealer-Magento2 Dealership Extension

    By clicking on Proceed button the Review & Submit page will appear. The customer can review the application before submitting it. Now the customer will click on Submit button.


    However, After submitting the application, a page with the message of Application Submission will appear. A Check Status button will appear below this message. The customer can check the status of his application from here.

    Application Submitted-Magento2 Dealership Extension

    Dealership status :

    The customer will enter the email address and click on submit button to check the status.

    dealership Status-Magento2 Dealership Extension

    The dealership application status can also be checked by the Dealership Status option. The customer will enter the email and click on submit button to check the status.

    dealership status-Magento2 Dealership Extension

    If the dealership application request has been approved by the admin then the status will be shown as Active as in the below screenshot:

    dealership status- Active-Magento2 Dealership Extension

    If the dealership application has been disapproved by the admin then the dealership status will be shown as Disapprove.

    dealership status -disapprove-Magento2 Dealership Extension

    Find a Dealer :

    A dealer can be found by the Find Dealer option. The city and postal code need to enter to find the dealer as shown in the below image:

    find a dealer-Magento2 Dealership Extension

    A customer can also check the dealer information in their account in the Dealer Information option.

    Dealer Information-Magento2 Dealership Extension

    That’s all in Magento 2 (Adobe Commerce) Dealership Extension. Still, have any issues, feel free to add a ticket and let us know your views at

    Explore the Adobe Commerce Cloud development service by Webkul. Also our quality Magento 2 extensions.

    Current Product Version - 5.0.2

    Supported Framework Version - 2.0.x , 2.1.x , 2.2.x , 2.3.x , 2.4.x

    . . .
    Discuss on Helpdesk

    Leave a Comment

    Your email address will not be published. Required fields are marked*

    Be the first to comment.

    Back to Top

    Message Sent!

    If you have more details or questions, you can reply to the received confirmation email.

    Back to Home