Skip to main content

Revise & Regenerate

When the underlying shipment data changes — a weight correction, a new consignee, or a reclassified HS code — you can update the shipment and regenerate clean documents instead of manually editing individual PDFs.

When to Revise vs. Use Fillable Fields

ScenarioApproach
Carrier assigned a B/L numberFill the field in the existing PDF
Inspector needs to sign a certificateFill the signature field in the PDF
Weight was recorded incorrectlyRevise the shipment and regenerate
Consignee changed after bookingRevise the shipment and regenerate
HS code reclassified by customsRevise the shipment and regenerate
Line item added or removedRevise the shipment and regenerate

Rule of thumb: if the change affects validated data (weights, values, HS codes, parties), regenerate. If the change only fills in data that was missing at generation time, use the fillable field.

How to Regenerate

Via Dashboard

  1. Open the shipment in the Klervex dashboard
  2. Click Edit Shipment to return to the Data Entry stage
  3. Update the shipment data (e.g., correct the gross weight)
  4. Click Re-validate to run compliance checks on the updated data
  5. Once validation passes, click Regenerate Documents
  6. Select the document types to regenerate (or regenerate all)

Via API

  1. Update the shipment data using PUT /api/v1/shipments/:id
  2. Re-validate with POST /api/v1/shipments/:id/validate
  3. Regenerate with POST /api/v1/shipments/:id/generate

Generation Limits by Tier

Each shipment has a maximum number of generation cycles (initial generation + subsequent regenerations).

PlanGenerations per ShipmentIncludes
Free21 initial + 1 regeneration
Starter51 initial + 4 regenerations
Growth101 initial + 9 regenerations
Scale201 initial + 19 regenerations

When you reach the limit, you can still use fillable fields to complete missing data and finalize existing documents. You just cannot regenerate from scratch.

Audit Trail

Every generation cycle is recorded with:

  • Timestamp — when the documents were generated
  • Generation number — sequential counter (v1, v2, v3, ...)
  • Verification hash — unique SHA-256 hash for each generated document
  • Data snapshot — the shipment data used for that generation cycle
  • User — who triggered the regeneration

Viewing the Audit Trail

  1. Open the shipment in the dashboard
  2. Go to the Deliver stage
  3. Click Version History on any document
  4. Each version shows the generation timestamp, hash, and a link to download

Previous versions remain downloadable and verifiable for the duration of the data retention window (5 days). After that, only the verification hash is retained permanently.

What Happens to Previous Versions

  • Previous document versions remain verifiable — anyone with the hash can confirm the document was generated by Klervex
  • Previous versions are downloadable for 5 days after generation (Klervex data retention window)
  • The latest version is always the one shown by default in the dashboard
  • Verification links for previous versions continue to work — they show the generation timestamp and confirm the document existed

Best Practices

  • Regenerate early — if you know data will change, regenerate before distributing documents to trading partners
  • Regenerate all affected documents — a weight change affects the commercial invoice, packing list, and bill of lading. Regenerate the full set to keep data consistent
  • Use version history for disputes — if a trading partner questions a document change, the audit trail shows exactly what changed and when