Shiprocket Plugin

The Shiprocket plugin integrates your store with Shiprocket, one of India's leading courier aggregator platforms. When an order is confirmed, the plugin automatically creates a shipment on Shiprocket, fetches the AWB (Air Waybill) tracking number, and updates the order with tracking information.

What It Does

• Auto-creates shipments on Shiprocket when you confirm an order
• Fetches AWB tracking numbers and stores them on the order
• Generates tracking URLs so customers can track their deliveries
• Works with all courier partners available through Shiprocket (Delhivery, BlueDart, FedEx, DTDC, and more)
• Handles both prepaid and COD (Cash on Delivery) orders

Requirements

• An active Shiprocket account (shiprocket.in)
• Your Shiprocket login credentials (email and password)
• A Channel created in Shiprocket (for order syncing)
• A Pickup Location registered in your Shiprocket dashboard

Setting Up Shiprocket

Step 1: Create a Shiprocket Account

If you do not have one already, sign up at shiprocket.in. They offer various plans including a pay-per-order option.

Step 2: Set Up a Pickup Location

1. Log in to your Shiprocket dashboard
2. Go to Settings > Pickup Addresses
3. Add your warehouse or store address
4. Note the pickup location name exactly as you entered it -- you will need this for the plugin

Step 3: Create a Channel

1. In your Shiprocket dashboard, go to Settings > Channels
2. Create a Custom channel for your Shop Craft store
3. Note the Channel ID (visible in the channel list)

Step 4: Configure the Plugin

1. Go to Admin Panel > Plugins
2. Find Shiprocket and click Enable
3. Click Settings
4. Fill in all the required fields (see table below)
5. Click Save

Plugin Settings

Setting	What to Enter
Shiprocket Email	Your Shiprocket account email address
Shiprocket Password	Your Shiprocket account password
Channel ID	Your Shiprocket channel ID (find it under Settings > Channels)
Pickup Location	The exact name of your pickup location as registered in Shiprocket
Default Weight (kg)	Default package weight in kilograms (e.g., 0.5). Used when product weight is not specified
Default Length (cm)	Default package length in centimeters (e.g., 10)
Default Breadth (cm)	Default package breadth in centimeters (e.g., 10)
Default Height (cm)	Default package height in centimeters (e.g., 10)
Auto-create Shipment on Confirm	Toggle on to automatically create shipments when orders are confirmed

WARNING

The Pickup Location name must match exactly what you entered in your Shiprocket dashboard, including capitalization and spacing. If it does not match, shipment creation will fail.

How It Works

Once the plugin is configured and the auto-create toggle is enabled:

1. A customer places an order on your store
2. You go to Admin Panel > Orders and change the order status to Confirmed
3. The plugin automatically sends the order details to Shiprocket
4. Shiprocket creates the shipment and assigns an AWB number
5. The AWB number and tracking URL are saved to the order in your store
6. Customers can see the tracking information in their order details

TIP

If you prefer to create shipments manually, you can turn off the Auto-create Shipment on Confirm toggle. You would then create shipments directly in your Shiprocket dashboard.

Tracking Information

When a shipment is created successfully, the plugin adds:

• Tracking ID -- the AWB number assigned by the courier
• Tracking URL -- a direct link to track the shipment on Shiprocket's tracking page

This information is stored on the order and can be seen by both you (in the admin panel) and the customer (in their order history).

Troubleshooting

Shipments are not being created automatically

• Make sure the plugin is enabled and the Auto-create Shipment on Confirm toggle is on
• Verify that the order status was changed to Confirmed (the plugin only triggers on confirmation)
• Check that the order has a valid shipping address

"Missing API credentials" error in logs

• Double-check your Shiprocket email and password in the plugin settings

"Pickup location not configured" error in logs

• Make sure the Pickup Location field is filled in and matches your Shiprocket dashboard exactly

Shipment created but no AWB number

• The courier may not have assigned an AWB yet. Check your Shiprocket dashboard for the shipment status

TIP

If something goes wrong, check the log file at storage/logs/laravel.log for detailed error messages from the Shiprocket plugin.