Shippit shipping for GoCommerce

What it does

Configuration

Two settings are required: the API key and a default service band. 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. Get an API keyIn Shippit, create an API key — a staging key if you are trying it against Shippit’s staging host — and decide the service band to book by default.
2. Install the moduleImport it and pass shippit.New to gocommerce.New, as below — or run the reference binary with -carriers, which installs every carrier module idle.
3. Fill in the settingsKey and service band, in Config or under Settings › Shipping providers, and authority to leave if the store’s default is yes. A value typed into the panel counts on the next shipment.
4. Ship an orderPOST /api/admin/create-fulfillment with the order id and the provider shippit. The engine records the tracking number and label URL and moves the order to shipped, or to partial.

import (
	"os"

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

app, err := gocommerce.New(cfg,
	shippit.New(shippit.Config{
		APIKey:      os.Getenv("SHIPPIT_API_KEY"),
		CourierType: "standard",
	}),
)

How it works

• Book, then fetch the label

  The booking gives the tracking number; the label comes from a second call. A booking with no tracking number is an error. A label that cannot be fetched is logged, and the shipment is recorded without one.

• A seven-day label link

  Shippit’s label URL is pre-signed and expires after seven days. It is stored as it comes; the package says a store that needs it later fetches it again from Shippit rather than expecting the engine to hold a live link.

• Kilograms and metres

  Shippit reads kilograms and metres, so grams and millimetres are both divided by a thousand. A typical parcel’s sides are numbers below one — 0.305, not 30.5 — which the package calls worth reading twice.

• One parcel, whatever is in it

  The booking says one parcel. The engine has already resolved the lines, and telling Shippit three would book three boxes.

• Per-parcel options

  Meta can override courier_type, pass the shopper’s authority_to_leave, add delivery_instructions, or name a carrier with courier_allocation for a parcel already promised to one.

• Carrier from the allocation

  The carrier code is read from the courier Shippit allocated — eParcel and StarTrack track as Australia Post; FedEx, DHL, TNT, Aramex and UPS are recognised — so the tracking number gets the right link.

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.

• No tracking updatesNo webhook and no stored state: delivery events in Shippit do not reach the order. Marking it delivered is still the operator’s job.
• No cancel callThere is no call to cancel a booking. Deleting the fulfillment in GoCommerce does not touch the order in Shippit.
• The label link expiresAfter seven days the stored label URL no longer works; the label has to be fetched again from Shippit.
• A missing label is only loggedIf the label fetch fails, the shipment is recorded with no label URL and the failure is in the application log; the label then has to be printed from Shippit.
• No contents sentThe booking carries the parcel’s weight and size, the address and the order number — not the items in it or their values.
• A guessed box for several itemsFor anything but a single unit, the size sent is the configured default, not a measurement. The engine does not pack cartons.