SHIPMANX
Complete User Guide
Action-First Logistics Platform for Shipping Teams — covering every feature, from Night Watch to Rate Database, with real screenshots from the live system.
- Open the invitation email and click Activate Account. If you don't have an invite, ask your company Admin to add you from Settings → Company → Users.
- Set your password (minimum 8 characters). Your email address is your login identity.
- On the login screen, enter your email and password, then click Sign In.
- If MFA is enabled by your admin, you'll be prompted for a verification code from your authenticator app — enter the 6-digit code to proceed.
The main navigation is on the left sidebar. Click any section to expand it:
- Dashboard — KPIs, active shipments summary, action items
- Shipments — Browse/create Export, Import, Domestic, and Samples records
- Documents — Manage CI, PL, BL, AWB, COO and quotation documents
- Rates — Search rates and generate PDF quotations
- Reports — Daily automated reports and saved exports
- Action Center — Prioritized list of shipment issues and follow-up tasks
- Intelligence — Carrier tracking, risk scoring, exception alerts
- Settings — Company, users, notifications, document templates
Before adding shipments, configure your company profile so all generated documents print correctly:
- Navigate to Settings → Company.
- Fill in: Company Name, Address, Phone, default Currency, and upload your Logo.
- Set your address blocks used in CI/PL headers.
- Click Save Changes.
- Go to Settings → Company → Users.
- Click Add Employee.
- Enter their Name and Email address.
- Select their Role: Admin (full control) or User (day-to-day access).
- Click Send Invite. They receive an email with an activation link and can log in immediately.
As Admin you can deactivate any user from the same screen to revoke access instantly.
| Field | What to Fill In | Used On |
|---|---|---|
| Company Name | Your legal trading name | CI, PL, all documents |
| Address | Full street address, city, country | CI header, PL header |
| Phone / Email | Primary contact details | Document footers |
| Default Currency | Your billing currency (USD, EUR, etc.) | Rate quotes, invoices |
| Logo | PNG or JPG, min 200px wide | CI header, reports |
| Address Blocks | Multiple named address snippets | CI/BL issuer field, PL shipper field |
- Timezone — Controls when daily reports are generated and when Night Watch evaluates each shipment. Set this before any other configuration.
- Display preferences — Date format, number format.
- Notification fallback email — Used when the primary email is unreachable.
- CI Template — Choose layout (full-page or A4), set default incoterm, signature block.
- PL Template — Commodity table format, number formatting.
- Quotation Template — Add your company tagline, payment terms default.
- Numbering format — Set prefix, starting number, and padding for each document type.
- Go to Shipments → Export and click New Export Shipment.
- Fill in: Shipper, Consignee, Loading Port, Destination Port, ETD, ETA.
- Add the Carrier, MBL and HBL numbers once received from the forwarder.
- Set the Goods Description, Gross Weight, and Measurement.
- Assign the shipment to a Rate from the database if a quotation has been issued.
- Click Save Shipment. The record appears in Shipments → Browse Export.
As the shipment progresses, update milestone fields from Shipments → Browse Export by clicking the shipment row:
- ETD / ETA — Update when the schedule changes.
- ATA (Actual Time of Arrival) — Set once cargo arrives at destination.
- Gate-In / Loading / Departure — Update as containers move through the terminal.
- BL Release / Delivery — Mark when documents are released or cargo is delivered.
From Shipments → Browse Export, click any shipment row to open it in edit mode. Use the Delete Export Shipment button to remove archived records. You cannot delete a shipment that has attached documents — remove documents first.
- Go to Shipments → Import and click New Import Shipment.
- Enter Shipper, Consignee, Loading Port, Destination Port, ETA.
- Add Carrier, MBL, HBL, Container Number(s).
- Set Gross Weight, CBM, and cargo description.
- Click Save Shipment.
Import shipments track a different milestone sequence than exports. Update these from the shipment edit screen:
- ETA — Estimated arrival at destination port.
- Arrival (ATA) — Vessel arrives at port.
- Gate-In — Container cleared into terminal / CFS.
- Documents Received — BL, CI, packing list received from forwarder.
- Customs Clearance — Importer or customs broker clears the cargo.
- Delivery / Do Collected — Delivery order collected, cargo out-gated.
The Reports → Import Daily Report generates a daily snapshot of all active import shipments sorted by ETA. Scheduled recipients receive this automatically each morning. Configure recipients at Settings → Notifications → Import Report Recipients.
- Go to Shipments → Domestic and click New Domestic Shipment.
- Enter Shipper, Consignee, Origin, Destination, ETD, ETA.
- Add Carrier, AWB / Tracking Number.
- Fill in Gross Weight and cargo details.
- Click Save Shipment.
Domestic shipments do not use CI/BL documents — they rely on the AWB or carrier tracking number as the primary reference. Use the Document Workflow for quotation or delivery-note generation if needed.
Domestic milestones: ETD → Departure → Arrival (ATA) → Delivery. Update from the shipment edit screen or from the browse table's inline edit.
- Go to Shipments → Samples and click New Sample Shipment.
- Enter Shipper, Consignee, Origin, Destination, ETD.
- Add Carrier / Courier and tracking number.
- Set the Description of Samples and weight.
- Click Save.
Samples shipments use a simplified lifecycle: Created → ETD Set → Dispatched → Delivered. There are no BL/CI documents for samples — the courier tracking number is the primary reference. Night Watch flags samples that have passed their ETD with no delivery confirmation.
- Open the shipment from Shipments → Browse Export (or Import).
- Scroll to the Documents section and click Generate CI / PL.
- The system populates shipper, consignee, goods, weight, and values from the shipment record.
- Review the generated CI — edit values inline before saving if needed.
- Click Save & Preview to view the print layout.
- Use Print Summary to open a print-ready view. From the browser print dialog, choose Save as PDF.
- Go to Shipments → Browse Export and click the shipment row.
- Click Upload Document and select the file (PDF, JPG, PNG).
- Choose the Document Type (Bill of Lading, AWB, Certificate of Origin, etc.).
- Click Upload. The document appears in the shipment's document list.
- Attach the uploaded BL or AWB to the Shipment Document field so Night Watch can track its release date.
If a document needs correction after submission to the bank or customs:
- Go to Documents → Document Revision Upload.
- Select the Shipment and Document Type.
- Upload the revised file and add a revision note.
- Click Submit Revision. The revised version replaces the previous one with a revision log.
- Go to Rates → Export Rates and click New Export Rate.
- Enter the Carrier, Route (origin port → destination port), 20GP, 40GP, 40HC rates.
- Set the Validity Start and Validity End dates.
- Add Transit Time, Free Time, and any notes.
- Click Save Rate. The rate appears in Rates → Browse Export Rates.
Import rates follow the same process via Rates → Import Rates → New Import Rate.
- Navigate to Rates → Browse Export Rates (or Import Rates).
- Use the search/filter fields to filter by Carrier, Origin, Destination.
- Results update in real time. Click any rate row to view full details.
- With a shipment open, click Rate Quotation from the shipment's action menu.
- The system pre-fills the route, cargo details, and selected rate from the database.
- Review and adjust the total landfall, validity, and payment terms.
- Click Generate PDF. A print-ready quotation opens in a new tab.
- Save as PDF or print directly from the browser.
- Go to Settings → Notifications.
- Scroll to Daily Reports.
- For each mode (Export, Import, Domestic), set the Delivery Time — the clock time at which the report is generated and emailed.
- Choose the Format: PDF, Excel, or Both.
- Add recipient email addresses in the Recipients field — use commas to separate multiple addresses.
- Click Save Notifications.
- Use the Test button to send a sample report immediately and verify delivery.
All generated reports are stored and accessible from Reports → Saved Reports. You can download any historical report as PDF or Excel. Reports are retained for 90 days.
The PDF daily report includes a formatted table of all active shipments for the selected mode, sorted by ETD/ETA. The Excel export includes all data columns for import into other tools. Both are generated server-side and attached to the email at send time.
| Column | What It Shows |
|---|---|
| Ref | Shipment reference number (MBL or internal ID) |
| Mode | Export / Import / Domestic / Samples |
| Issue | Flag type — e.g. Overdue ETA, Missing CI, BL Not Released |
| Days | How many days the issue has been open |
| Recommended Action | Next step to resolve the issue |
- Open the Action Center from the sidebar (lightning bolt icon).
- Read the Recommended Action column for each item.
- Click the Ref to open the shipment record.
- Resolve the issue in the shipment record (e.g., upload BL, update ETA, generate CI).
- Return to the Action Center — the item drops off when Night Watch runs the following night. To dismiss manually, click the X next to the item.
As an Admin, you can adjust flag thresholds in Settings → Action Center Configuration. Available flags include: overdue ETA threshold (days), missing document types, BL release delay threshold, and customs clearance SLA.
Night Watch runs (after midnight): Scans all active shipments, applies flag rules, builds the Action Center.
Before your configured time: Daily reports generated and emailed to recipients.
9 AM (or your set time): Team opens Action Center. Standup is 10 minutes because the list is already prioritized.
| Flag Type | Condition | Severity |
|---|---|---|
| Overdue ETA | ATA is past and Delivery milestone not set | High |
| BL Not Released | ETD has passed but no BL document is attached | Medium |
| Missing CI | Export shipment has Departed but no CI document | Medium |
| Customs Delay | Arrival milestone set but Customs Clearance not updated in X days | High |
| Sample Undelivered | ETD passed with no delivery confirmation | Low |
| Rate Expiring Soon | Assigned rate within 7 days of validity end | Low |
Night Watch is enabled by default for all companies on an active subscription. To pause it temporarily, contact support or disable from Settings → Notifications by pausing daily report generation. The Action Center still updates when shipments are manually saved even if Night Watch is paused.
- Go to Freight Invoice Analysis (may appear under Reports or a dedicated menu item).
- Click Upload Invoice and select the file (PDF, XLSX, or CSV from your freight forwarder).
- For the system to match charges, at least one rate for the relevant shipment must exist in the Rate Database — upload rates for the shipment before uploading the invoice.
- The system parses the invoice and attempts to match each charge line to a stored rate.
- Review the results on the Invoice Analysis Results page.
| Column | What It Shows |
|---|---|
| Charge Type | Ocean Freight, THC, BAF, CAF, etc. |
| Quoted Amount | Rate stored in SHIPMANX for this route/carrier |
| Invoiced Amount | What the forwarder charged on the invoice |
| Difference | Variance — positive = overcharged, negative = undercharged |
| Status | Match / Mismatch / No Rate Found |
| Tile | What It Shows |
|---|---|
| Active Shipments | All in-progress shipments across all modes — live count |
| Closed Shipments | Completed shipments within your configured visibility window |
| Departures Today | Export and import shipments with ETD = today |
| Arrivals Today | Import shipments with ETA or ATA = today |
Below the KPI tiles, the Freight KPI panel shows month-to-date realized freight costs broken down by mode:
- Export — Total invoiced ocean freight + local charges for export shipments this month
- Import — Total charges for import shipments
- Domestic — Domestic shipment costs
- Total MTD — Sum across all modes
- vs Prior Period — Percentage change vs last month (positive = cost increased)
Admins can show/hide tiles and reorder them from Settings → Dashboard. Drag tiles to reorder, toggle visibility with the eye icon. Changes save automatically and apply to all users in the company.
| Tab | What You Configure |
|---|---|
| General | Timezone, date/number format, notification fallback email. Set timezone first. |
| Company | Company name, logo, address blocks, default currency for all documents |
| Documents | CI/PL/quotation template layouts, incoterm defaults, numbering format |
| Dashboard | Visible modules and tile arrangement order for all users |
| Notifications | Daily report schedule, format (PDF/Excel/Both), recipient lists per mode |
| Custom Fields | Company-specific additional fields that appear on shipment records |
- Go to Settings → Company → Users.
- Click Add Employee.
- Enter their Name and Email address.
- Set their Role: Admin (full access) or User (standard access).
- Click Send Invite. They receive an email with an activation link.
- They click the link, set their password, and can log in immediately.
| Role | Can Do | Cannot Do |
|---|---|---|
| Admin | All of the below, plus: manage users, change settings, configure notifications, view billing | — |
| User | Create/edit shipments, upload documents, generate reports, use rate database | Add users, change company settings, access billing |
- Go to Settings → Company → Users.
- Find the user row and click the Deactivate button (or the edit icon → Deactivate).
- The user's session is terminated immediately and they can no longer log in.
- All data they created remains intact.
| Symptom | Likely Cause | Resolution |
|---|---|---|
| Report emails not arriving | Sender domain or recipient spam filter | Check Settings → Notifications · verify inbox spam folder · use Test button |
| Night Watch not flagging expected items | Threshold not yet met or shipment is closed | Review shipment status and milestone dates · check Action Center Configuration |
| Scheduled report didn't run at expected time | UTC timing mismatch in settings | Verify timezone setting in Settings → General · use Test button to confirm |
| Document output looks wrong | Template settings incomplete or required fields missing on shipment | Check Settings → Documents · verify shipment fields are complete · use Print Preview |
| Shipment not appearing in Action Center | Issue doesn't meet configured threshold | Review flag condition thresholds in Action Center Configuration |
| Cannot upload a document | Wrong file format or size over limit | Use PDF, JPG, or PNG · max 10 MB per file |
| Rate not showing in quotation | Rate expired or wrong mode (export vs import) | Check rate validity dates in Rates → Browse · use Export Rate for export quotations |
| Invoice analysis shows "No Rate Found" | No rate stored for this shipment's route/carrier | Add the rate in Rates → Export/Import Rates before uploading the invoice |
Response within 1 business day
Product updates · changelog · trial signup