User Guide for Magento 2 Multi Vendor Shiprocket Integration

Magento 2 Shiprocket Integration Marketplace allows sellers and admins to manage
shipping by generating labels and scheduling pickups through Shiprocket.

It also enables real-time order tracking, ensuring smooth and reliable delivery management.

It simplifies logistics management, provides real-time shipping rates, and ensures faster, more efficient order delivery.

Sellers and admins can securely save their Shiprocket API credentials, access multiple courier partners, and view real-time shipping rates.

Additionally, you can check the Magento 2 Marketplace Fixed Rate Shipping module, which allows store users to set their own custom fixed rate shipping method for shipping products.

Searching for an experienced
Magento 2 Company ? Find out More

Features

Set a custom Shiprocket shipping title for customers at checkout.

Allow admin and sellers to save their Shiprocket login details securely.

Enable sellers to use their own Shiprocket shipping configuration.

Display shipping rates in INR with configurable currency conversion.

Generate shipping labels automatically for each seller’s pickup location.

Fetch real-time shipping rates from Shiprocket’s courier partners.
Provide order tracking through Shiprocket’s tracking system.

Installation

Please Note: To use this module you must have installed Magento 2 Multi Vendor Module in the first place.

Customers will get a zip folder then they have to extract the contents of this zip folder on their system.

The extracted folder has an src folder, inside the src folder you have the app folder. You need to transfer this app folder into the Magento 2 root directory on the server, as shown below.

After the successful installation, you have to run these 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

Multi-lingual Support

For the multilingual support, the admin will navigate through Store->Configuration->General ->Locale Options and select the locale as German

(the language into which the admin wants to translate his store content).

Language Translation

For Magento 2 AI Base Image Generator translation, navigate to the following path in your system src/app/code/Webkul/MpShiprocketShipping/i18n.

Open the file named en_US.CSV for editing as shown in the below screenshot.

Now, upload it to the path src/app/code/Webkul/MpShiprocketShipping/i18n where the installation of Magento 2 is on the server. The module gets translated into the desired language.

The user can edit the CSV like the image below.

After editing and translating the CSV file, you need to save the translated file name according to your region, language, and country code, such as – de_DE.CSV.

Followed by uploading the translated file to the same folder from where you have obtained it. Now your module translation is complete.

How to get the Shiprocket Integration Credentials

On the Shiprocket side, you must first configure the shipping details, including the
API user and password, and add pickup addresses.

All these details are available once you successfully create a Shiprocket account.

To create a Shiprocket account, you must Sign up.

Now in your Shiprocket account, you need to navigate through Settings> API Users> Add New API User in your profile.

Click the API Users under Additional Settings to view the Add New API User button.

By clicking on the Add New API User button the user will see a popup to Add new API User.

The user can obtain the API password by clicking the Create User button, which becomes active after all required details are filled in.

This is the API password of Shiprocket Integration. Copy and store it securely, as it cannot be viewed again after you close this section.

Here you can view the details of API users.

From here, you can select the courier by navigating to Setup & Manage > Courier.

Manage Pick Up Addresses in Shiprocket

To manage the pickup address locations in Shiprocket, go to Settings > Pickup Addresses

This section shows all pickup addresses added by the user in Shiprocket and provides an option to add a new pickup location.

You can add multiple pickup addresses in Shiprocket, using tags like Home, Work, Warehouse, or others to organize them as needed.

To add a new pickup address in Shiprocket, click the ‘+Add Pickup Address‘ button located at the top right corner.

After entering the address details successfully, the pickup location will be saved in Shiprocket.

After entering the address and contact details, click on the ‘Verify and Save Address‘ button.

You will then be prompted to verify the OTP sent to your registered phone number.

Once the address details are successfully entered, the pickup location will be saved in Shiprocket.

You can then edit these addresses, enable or disable them, or mark any location as your primary pickup location in Shiprocket.

You will then be prompted to verify your account by completing the KYC sent to the email address saved in your account.

Module Configuration – Magento 2 Marketplace Shiprocket Integration

After the successful installation of the module, the admin can configure the module from the back end.

For that, they need to navigate through Stores> Configuration>Sales> Delivery Methods> Webkul MpShiprocket Shipping Method

Note: Please ensure you have active API user credentials before saving them in the Magento Admin to fetch the default pickup location from Shiprocket.

Here, the admin will be able to see the following configuration under Webkul MpShiprocket Shipping Method

Enabled – Dropdown to enable or disable the extension.
Title – Enter the module title that will be visible during checkout.
Allow Seller Shipping – if select Yes, then allow sellers to save their Shiprocket login details at seller-end.
API Email – Enter the API Email
API Password – Enter the API Password
Ship to Applicable Countries – select the countries where you want to ship
Show Method if Not Applicable –
Displayed Error Message – set an error message to display.

Note: The origin country must be set to India.

Seller Management

Once the module is enabled from the Admin panel and allowed for the seller, the seller will be able to access and configure the Shiprocket settings.

Sellers can enter their Shiprocket credentials and click Save to proceed.

API Email – Enter the API Email.
API Password – Enter the API Password.

After saving seller details, the Default Shipping Address fields appear. Select an address from the dropdown list and click Save.

Now, the buyer will add the product to the shopping cart and will View and Edit the shopping cart to estimate the shipping and tax.

After that, the buyer selects the shipping rates under Webkul Shiprocket Shipping and clicks Proceed to Checkout.

Tapping the “Proceed To Checkout” button displays the page where the buyer can review the selected shipping address and shipping method. Click “Next” to continue.

Customers can also view the selected shipping method on the Order Review page. Clicking “Place Order” completes the purchase.

After the order has been place the customer can view the order details under their account with the total shipping charges as shown below.

Seller Order Management – Marketplace Shiprocket Integration For Magento 2

Once the customer places the order, the seller can view it in their Order History with a Pending status. Refer to the image below for better understanding.

Now, if the admin sets the “Allow Seller to Manage Order” option “Yes” then the seller can manage the orders from front-end.

Now the seller can generate invoices for ordered products, create shipments with tracking numbers, notify customers via email, cancel or refund orders, and print order details.