Install the Merchant Self-Registration feature

This document describes how to install the Merchant Self-Registration feature in your project.

Install the feature core

Follow the steps below to install the Merchant Self-Registration feature core.

Prerequisites

Install the following required features:

1) Install the required modules

Install the required modules by using Composer:

composer require spryker/merchant-registration-request:"^1.1.0" spryker-shop/merchant-registration-request-page:"^1.0.0" --update-with-dependencies

2) Set up the database schema and transfer objects

1. Apply the database changes and generate entity and transfer changes:

console propel:install

2. Generate transfer changes:

console transfer:generate

3) Add translations

1. Append glossary entries for the Back Office and Storefront according to your configuration:

data/import/common/common/glossary.csv

>merchant_registration_request_page.page_title,Register and get started on the Spryker Marketplace,en_US
merchant_registration_request_page.page_title,Registrieren und loslegen auf den Spryker Marktplatz,de_DE
merchant_registration_request_page.company_subform_title,Company Registration,en_US
merchant_registration_request_page.company_subform_title,Registrierung des Unternehmens,de_DE
merchant_registration_request_page.company_subform_text,Fill in your company details to initiate your registration process as a marketplace merchant.,en_US
merchant_registration_request_page.company_subform_text,"Geben Sie Ihre Unternehmensdaten ein, um den Registrierungsprozess als Marktplatz-Händler zu starten.",de_DE
merchant_registration_request_page.account_subform_title,Merchant User Account creation,en_US
merchant_registration_request_page.account_subform_title,Händler-Benutzerkonto erstellen,de_DE
merchant_registration_request_page.account_subform_text,Add the details of your first merchant user account.,en_US
merchant_registration_request_page.account_subform_text,Fügen Sie die Details Ihres ersten Händler-Benutzerkontos hinzu.,de_DE
merchant_registration_request_page.accept_terms,Accept terms,en_US
merchant_registration_request_page.accept_terms,AGB akzeptieren,de_DE
merchant_registration_request_page.contact_person_role,Role,en_US
merchant_registration_request_page.contact_person_role,Role,de_DE
merchant_registration_request_page.contact_person_phone,Phone,en_US
merchant_registration_request_page.contact_person_phone,Telefonnummer,de_DE
merchant_registration_request_page.contact_person_first_name,First name,en_US
merchant_registration_request_page.contact_person_first_name,Vorname,de_DE
merchant_registration_request_page.contact_person_last_name,Last name,en_US
merchant_registration_request_page.contact_person_last_name,Nachname,de_DE
merchant_registration_request_page.contact_person_title,Title,en_US
merchant_registration_request_page.contact_person_title,Titel,de_DE
merchant_registration_request_page.email,Email,en_US
merchant_registration_request_page.email,E-Mail,de_DE
merchant_registration_request_page.company_name,Company name,en_US
merchant_registration_request_page.company_name,Unternehmensname,de_DE
merchant_registration_request_page.country,Country,en_US
merchant_registration_request_page.country,Land,de_DE
merchant_registration_request_page.street,Street,en_US
merchant_registration_request_page.street,Straße,de_DE
merchant_registration_request_page.house_number,House Number,en_US
merchant_registration_request_page.house_number,Hausnummber,de_DE
merchant_registration_request_page.zip_code,Zip Code,en_US
merchant_registration_request_page.zip_code,PLZ,de_DE
merchant_registration_request_page.city,City,en_US
merchant_registration_request_page.city,Stadt,de_DE
merchant_registration_request_page.merchant_registration_number,Registration number,en_US
merchant_registration_request_page.merchant_registration_number,Registrierungsnummer,de_DE
merchant_registration_request_page.form_submit,Submit registration request,en_US
merchant_registration_request_page.form_submit,Registrierungsanfrage senden,de_DE
merchant_registration_request_page.success,Merchant registration request has been successfully submitted for review.,en_US
merchant_registration_request_page.success,Die Händlerregistrierungsanfrage wurde erfolgreich zur Überprüfung übermittelt.,de_DE
merchant_registration_request.error.email_already_exists,Email address already registered.,en_US
merchant_registration_request.error.email_already_exists,E-Mail-Adresse bereits registriert.,de_DE
merchant_registration_request.error.company_name_already_exists,Company name already registered.,en_US
merchant_registration_request.error.company_name_already_exists,Unternehmensname bereits registriert.,de_DE

2. Import data:

console data:import glossary

4) Configure navigation

1. Add the Merchant Registrations section to the Back Office navigation:

config/Zed/navigation.xml

<?xml version="1.0"?>
<config>
    <marketplace>
        <label>Marketplace</label>
        <title>Marketplace</title>
        <icon>fa-shopping-basket</icon>
        <pages>
            <merchant-registration-request>
                <label>Merchant Registrations</label>
                <title>Merchant Registrations</title>
                <bundle>merchant-registration-request</bundle>
                <controller>list</controller>
                <action>index</action>
            </merchant-registration-request>
        </pages>
    </marketplace>
</config>

2. Build the navigation cache:

console navigation:build-cache

5) Set up Storefront routing

Register the route provider plugin to enable the merchant registration page in the Storefront:

src/Pyz/Yves/Router/RouterDependencyProvider.php

<?php

namespace Pyz\Yves\Router;

use Spryker\Yves\Router\RouterDependencyProvider as SprykerRouterDependencyProvider;
use SprykerShop\Yves\MerchantRegistrationRequestPage\Plugin\Router\MerchantRegistrationRequestPageRouteProviderPlugin;

class RouterDependencyProvider extends SprykerRouterDependencyProvider
{
    /**
     * @return array<\Spryker\Yves\RouterExtension\Dependency\Plugin\RouteProviderPluginInterface>
     */
    protected function getRouteProvider(): array
    {
        return [
            new MerchantRegistrationRequestPageRouteProviderPlugin(),
        ];
    }
}

6) Set up Storefront navigation

To add a link to the merchant registration page in the Storefront footer, import the following navigation node:

1. Prepare navigation node data:

data/import/common/common/navigation_node.csv

>navigation_key,node_key,parent_node_key,node_type,title.en_US,url.en_US,css_class.en_US,title.de_DE,url.de_DE,css_class.de_DE,valid_from,valid_to
FOOTER_NAVIGATION,nav-el-footer--5,,link,Sell on Spryker,/en/merchant-registration-request,footer-navigation__item,Auf Spryker verkaufen,/de/merchant-registration-request,footer-navigation__item,,

2. Import data:

console data:import navigation-node