Skip to main content

How to set up and use Shiprocket in BuildMyStore?

Shiprocket allows you to connect your Shiprocket account with BuildMyStore and use Shiprocket for third-party shipping.

Connect Shiprocket​

Step-by-Step Guide​

  1. Open Deliveries: Log in to BuildMyStore Web App. From the left sidebar, go to Settings and open Deliveries.
  2. Connect Shiprocket: Find Shiprocket and click Connect.
  3. Enter Shiprocket Credentials: Enter your Shiprocket Email ID, Password, and the required Token/Password, as applicable.
  4. Connect the Account: Click Connect. Once the connection is successful, Shiprocket will be connected to your store.
  5. Add a Shipping Package: Add a Shipping Package from the Deliveries settings.

Configure the BuildMyStore Webhook in Shiprocket​

Configure the BuildMyStore webhook in your Shiprocket account to receive shipment tracking updates.

Step-by-Step Guide​

  1. Open Webhooks: Log in to your Shiprocket account. From the Shiprocket dashboard, go to Settings → Additional Settings → Webhooks.
  2. Enter the BuildMyStore webhook URL: In the URL field, enter: 
    https://api.buildmystore.io/api/webhook/shipping/update-shipment-status
  3. Select the authentication type: From the Auth Token Type dropdown, select x-api-key.
  4. Enter the token: In the Token field, enter the token provided by Shiprocket.
  5. Save the webhook: Click Save.

The webhook connection is now enabled. Shiprocket can send shipment tracking updates to BuildMyStore through the configured webhook.

Create a Shipment Using Shiprocket​

Step-by-Step Guide​

  1. Open Orders: Click Orders from the Dashboard sidebar navigation menu.
  2. Open the Order: Open the order you want to ship.
  3. Ship the Order: On the Order Details page, click Ship Order in the top-right corner.
  4. Choose Shipping Method: The Choose Shipping Method window will open. Select Shiprocket and click Continue.
  5. Enter Shipment Details: Enter the Shipping Weight and Package Type, then click Next.
  6. Enter Pickup Address: Enter the Pickup Address. Based on the pickup address, the available Shipping Providers will be displayed.
  7. Select Shipping Provider: Select the preferred Shipping Provider (Courier Partner) and click Next.
  8. Confirm Shipment: Review the shipment details and click Confirm Shipment.

The shipment will be created successfully.

Note

After the shipment is created, Shiprocket manages the shipping and delivery of the product. You do not need to manually mark the Shiprocket shipment as delivered from the order page.

Manage a Shiprocket Shipment​

After creating a Shiprocket shipment, you can track the shipment, schedule a pickup, or cancel the shipment from Shipment Details.

Step-by-Step Guide​

  1. Open Deliveries: Click Deliveries from the Dashboard sidebar navigation menu.
  2. Select the Shipment: Select the Shiprocket shipment you want to manage.
  3. Use the Available Actions: On the Shipment Details page, use the available actions:
    • Track: Click Track to view the shipment tracking details and status updates.
    • Schedule Pickup: Click Schedule Pickup, enter the Pickup Date, and click Schedule Pickup.
    • Cancel: Click Cancel. In the confirmation popup, select Keep Shipment to keep the shipment active or Cancel Shipment to cancel it.

Frequently Asked Questions​

You need:

  • An active Shiprocket account.
  • Shiprocket login credentials.
  • The required token provided by Shiprocket for the webhook.
  • A Shipping Package in BuildMyStore.

Go to Settings → Deliveries in BuildMyStore Web App, find Shiprocket, and click Connect.

In your Shiprocket account, go to Settings → Additional Settings → Webhooks.

Use: https://api.buildmystore.io/api/webhook/shipping/update-shipment-status

Select x-api-key from the Auth Token Type dropdown.

The token required for the webhook is provided by Shiprocket.

You can create Shiprocket shipments, select a shipping provider, schedule pickups, track shipments, and cancel shipments from BuildMyStore.

No. After a Shiprocket shipment is created, Shiprocket manages the shipping and delivery. You do not need to manually mark the shipment as delivered from the BuildMyStore order page.

Troubleshooting​

Cause
Local Delivery may be enabled in Feature Preferences.
Solution
Go to Settings → Feature Preferences and turn off Local Delivery. Then go to Settings → Deliveries and check for Shiprocket again.
Cause
The Shiprocket credentials may be incorrect or incomplete.
Solution
Verify the Email ID, Password, and required Token/Password, then try connecting Shiprocket again.
Cause
The BuildMyStore webhook may not be configured correctly in Shiprocket.
Solution
Go to Shiprocket → Settings → Additional Settings → Webhooks and check that the BuildMyStore webhook URL, x-api-key authentication type, and Shiprocket-provided token are entered correctly. Save the webhook configuration again.