Shiprocket shipping for GoCommerce

What it does

Configuration

Three settings are required: the API user’s email and password, and the pickup location’s nickname. Set them in Config from your own main(), or leave Config empty and fill them in under Settings › Shipping providers.

The module reads its Config struct, not the environment. The variable names are the ones the package’s own example or the reference binary uses; in your own main() you choose where each value comes from. Where a setting has a panel label, the admin’s settings drawer can hold it too, and a value typed there wins over Config.

Setting it up

1. Create an API userIn Shiprocket, set up the API user the module will log in as, and note the nickname of the pickup address it should collect from.
2. Install the moduleImport it and pass shiprocket.New to gocommerce.New, as below — or run the reference binary with -carriers, which installs every carrier module idle.
3. Configure itEmail, password and pickup location, in Config or under Settings › Shipping providers. Record weights on your variants; the default is only a fallback.
4. Ship an orderChoose Shiprocket in the admin’s ship dialog, or POST /api/admin/create-fulfillment with "provider": "shiprocket". The waybill becomes the tracking number.

import (
	"os"

	"github.com/itswadesh/gocommerce/core"
	shiprocket "github.com/itswadesh/gocommerce/ext/fulfill-shiprocket"
)

app, err := gocommerce.New(cfg,
	shiprocket.New(shiprocket.Config{
		Email:          os.Getenv("SHIPROCKET_EMAIL"),
		Password:       os.Getenv("SHIPROCKET_PASSWORD"),
		PickupLocation: "Primary",
	}),
)

How it works

• Three calls per parcel

  Create an ad hoc order in Shiprocket, assign a waybill, then generate a label. The waybill is returned as the shipment’s tracking number and the label URL is stored with it.

• Outside the transaction

  The carrier call runs before the engine opens its transaction, so a slow minute at Shiprocket never holds a lock on the orders table. The engine re-checks the order afterwards.

• COD or prepaid, from the order

  An order whose payment status is paid is booked as Prepaid; anything else as COD. Getting it wrong, the code notes, means a courier who does not ask for money or one who asks a customer who has paid.

• Measured weight first

  Three sources, in order: a figure passed in the request’s meta, the weight the engine summed from the variants — used only when every line was weighed — and the default per unit.

• A new id per parcel

  Shiprocket rejects a duplicate order id, so the first parcel goes as the order number and later ones as number-2, number-3 and so on.

• Token cached, dropped on 401

  The API user logs in once and the token is reused for nine days. A 401 clears it, so the next call logs in afresh.

What it does not do

Read these before an order depends on it. No store is known to run GoCommerce in production yet, so these come from the code, not from anyone’s experience.

• Half-booked parcels need a handIf Shiprocket creates the order but assigns no waybill, the call fails and names the shipment id. The engine records nothing, so finish or cancel that shipment in Shiprocket before retrying.
• No tracking updatesNothing comes back after booking: no webhook, no polling. Marking an order delivered is a separate step, in the admin or through the API.
• No rates, no cancellationThe module quotes no shipping rates, and deleting a fulfillment in GoCommerce does not cancel it in Shiprocket.
• Courier and box size need the APIThe admin’s ship dialog sends the provider, tracking and lines. A courier_id, or a box’s length, breadth, height and weight, go in the request’s meta, which only an API call sends.
• Two-decimal moneyPrices are sent as minor units divided by 100 — right for rupees, wrong for a currency with none or three decimals.
• The label is best effortIf Shiprocket cannot generate a label, the shipment is still recorded, without a label URL. Print it from Shiprocket’s dashboard instead.