Steps to integrate shiprocket B2C carrier

Steps to integrate shiprocket B2C carrier

This article offers a step-by-step walkthrough to help you with the carrier configuration process of Shiprocket (B2C) carrier. This is B2C carrier.

Step 1: Login to Shiprocket.
Step 2: Navigate to API settings (Settings → API → Add New API User)
Step 3: Click on Create API user.
  1. In the pop-up form:
  2. Email address: enter unique email address.
    (    Note: This must be different from the one used for your main Shiprocket login.)
  3. Modules to access: Select all.
  4. Buyer's details access: Choose Allowed or Not Allowed depending on your requirement.
Step 4: Click on create user to complete the process.
Step 5: The API user’s password will be sent to your registered email address.
            (Note: the one linked to your main Shiprocket account, not the API user email ID).

Step 6: 
On the eShipz platform dashboard, Go to Settings > Integrations, then select Carrier Configuration.


Image:1

Step 7: 
Now the ‘Carrier configuration’ page will be displayed.Search for the carrier by name or scroll through the list to find it. Select Shiprocket. You can also identify the carrier name displayed below the carrier logo.


Image:2

Step 8: 
The “Service configuration” page will now be displayed and you can click on Add service icon in the top right corner.


Image:3

Step 9:
The “Carrier setup” page will now be displayed, Fill the valid details i.e. Account Configuration(Alias Name,Testing or Production type), Credentials, Label Settings, POC details.

Image:4.1

Fill in the valid details for the following fields:
  • Username
  • Password
  • Pickup Location
Click on Next after completing each section.

Note 1: The Credentials will be given by the carrier as per the agreement or Contract made by the customer.

‘Service type’: In the left side you can see the service types available as shown in image 4.2.


Image:4.2

Step 10: (Optional
Label Settings: In Label Settings there are several label formats mentioned,choose the options under Label Formats. If none of the options are selected then the default label will be generated in Shiprocket Custom-Default Label (A5/A4) format after shipment creation.

“Upload Logo”, users can upload the image here that they want to showcase in the labels. Valid file formats for upload are PNG, GIF and JPEG. Logo upload is NOT applicable for Shiprocket Custom-Default Label (A5/A4) label format. If the logo is not uploaded then normal labels will be generated without the logo.

Step 11: 
“Product Mask” - generally description of Items will be displayed on label. If the user wants to mask the items on the label with some specific name it can be done by entering the value on the Product Mask field in the shipper account page. In the label,data entered on the Product Mask field will be displayed instead of items being shipped.


Image:5

Step 12: 
“Message”, data entered in this field will be displayed at the bottom of the label [as shown in the label image attached below refer Image:7]

Image:6

Step 13: 
“Shipper Setting”
  1. Enabling the “Hide Shipper Address On Label” checkbox, hides the shipper address on the label i.e., shipper address will not be displayed on label.
  2. Enabling the “Hide Shipper Name On Label” checkbox, hides shipper name on the label.
  3. Enabling the “Hide Shipper Company On Label” checkbox, hides shipper company name on the label.
  4. Enabling the “Hide Entire Shipper Details On Label” checkbox, hides entire shipper details on the label.
  5. Enabling the “Hide Entire Return Address On Label” checkbox, hides the return address on the label.
  6. Enabling the “Hide Invoice Value On Label” checkbox, hides the invoice value on the label.

Step 14: 
The POC section allows you to add and manage Point of Contact for smooth communication related to operations, support, escalations, and pickup coordination.
To designate a contact as the primary Point of Contact for the carrier account, enable the "Set as Default POC" option.


Image:7

Step 15: 
Check the “I have read and agree to the carrier Terms and Conditions” checkbox after reading the terms and conditions document and click on the “Complete” button.


Image:8

Once saved, eShipz shows a "Service added successfully" confirmation and takes you to the Service Configuration summary.


Image:9
Finally, the Shiprocket account appears as an Active service under Service Configuration → Active Services, ready to use for shipment creation.
Two additional sections available:
  • Pincode, EDD & AWBs Uploads: Upload serviceable pincodes and pre-allocated AWBs.
  • Freight Audit Settings: Configure zone rate mappings for freight audits.
Now, you can go ahead and create shipments for the configured Shiprocket (B2C)carrier.