Veeqo shipment sync for GoCommerce

What it does

Configuration

Only the API key is required. Set it in Config from your own main(), or leave Config empty and type it 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. Have the order in VeeqoThe module expects the order to exist in Veeqo already, under the same order number and allocated to a warehouse. How it gets there is outside this module.
2. Install the moduleImport it and pass veeqo.New to gocommerce.New, as below — or run the reference binary with -carriers, which installs every carrier module idle.
3. Give it the keyIn Config, or under Settings › Shipping providers, with a carrier id if the store always ships with one carrier. A value typed into the panel counts on the next shipment.
4. Record the parcelPOST /api/admin/create-fulfillment with the provider veeqo and the tracking number. For an order with several allocations, pass meta allocation_id and order_id together.

import (
	"os"

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

app, err := gocommerce.New(cfg,
	veeqo.New(veeqo.Config{APIKey: os.Getenv("VEEQO_API_KEY")}),
)

How it works

• A tracking number is required

  The module records a parcel that has gone out, so a ship request without a tracking number is refused rather than sent to Veeqo empty.

• Found by exact number

  Without meta, it searches Veeqo for the order number. Veeqo’s search is fuzzy — GC-100 also finds GC-1001 — so only an exact match counts.

• Refuses rather than guesses

  No match, several matches, no allocation, or several allocations each give a specific error saying what to pass. A parcel is never recorded against a warehouse the module picked by chance.

• The operator’s number wins

  The tracking number stored is the one the operator gave, not Veeqo’s echo of it: if the two ever differ, what actually went out is the truth.

• Carrier from Veeqo’s name

  The carrier code is read from what Veeqo calls the carrier, then from the ship request’s own carrier, so a store that set a real carrier id gets a tracking link.

• No double emails, no loop

  Veeqo’s own customer email and its push to the sales channel are both off unless switched on, so one parcel means one message and no round trip.

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.

• Does not create Veeqo ordersNothing here sends a GoCommerce order to Veeqo. If the order is not already in Veeqo under the same number, the shipment is refused.
• Buys no labelThe label is bought somewhere else — in Veeqo, or with another carrier module — and this module records the result.
• Pass both ids, or neitherMeta allocation_id is used directly only when order_id comes with it. Passed alone, the module still searches, and an order with several allocations is then refused.
• Nothing flows backStock levels, cancellations and delivery events stay in Veeqo; the module writes to Veeqo and reads nothing into GoCommerce but the carrier’s name.
• One page of search resultsThe search reads 25 results. An order number that fuzzily matches more orders than that may be missed — pass the ids instead.