Tenant documentation

Run your logistics business on Fauward.

Set up your branded portal, manage shipments, coordinate field teams, invoice customers, and keep every customer informed from one workspace.

Getting Started

Sign up at fauward.com/signup. No card is required, and every new workspace starts with a 14-day free trial.

What you get immediately

A tenant workspace, branded customer portal, shipment dashboard, tracking references, team invites, and access to the onboarding wizard.

What you should prepare

Your business name, logo, preferred brand colours, sender address, first team member, and one real shipment to test your workflow.

Onboarding wizard

After signup, the onboarding wizard walks you through the minimum setup:

  1. 1Set your business name and subdomain, such as yourcompany.fauward.com.
  2. 2Upload your logo and set your brand colours for the portal, emails, and widget.
  3. 3Invite your first team member and choose the right role for them.
  4. 4Create your first shipment and confirm the tracking timeline looks right.
  5. 5Add the tracking or booking widget to your website when you are ready for customer traffic.

Workspace setup order

StepWhy it mattersWhere to do it
IdentitySets the name, slug, support details, and public presence customers will see.Settings -> Workspace
BrandingApplies your logo and colours to the portal, widget, emails, and customer documents.Settings -> Branding
TeamGives admins, dispatchers, finance users, and drivers the correct access before live work starts.Settings -> Team
OperationsValidates shipment creation, tracking references, assignment, and proof of delivery.Shipments and Dispatch
IntegrationsConnects booking forms, tracking pages, APIs, and webhooks after the core workflow is proven.Settings -> API Keys and Webhooks

First-day checklist

  • Create a test shipment from your own address to a known recipient.
  • Assign it to yourself or a dispatcher, then move it through each status.
  • Generate a proof of delivery document and confirm the customer timeline is clear.
  • Check that the sender, recipient, package, price, and service fields are accurate before invoicing.
  • Send yourself a sample notification so you can review the sender name and branding.
  • Invite the team members who will operate live jobs and enforce MFA for sensitive roles.

First integration path

Most teams start with the hosted booking page or tracking widget, then add API keys and webhooks once they know which shipment fields their own systems should send and receive. Use one internal test key first, then rotate to a dedicated production key for each connected system.

Portal access

Your portal is available immediately at your subdomain. Customers can use your branded tracking page as soon as a shipment has a tracking reference.

Your Dashboard

The dashboard is the daily control room for your operation. It is designed for owners, managers, dispatchers, and finance users who need a live summary without digging through every module.

MetricWhat it meansWhat to do next
Shipments todayJobs created, processing, picked up, in transit, out for delivery, or delivered today.Open the shipment list filtered to today.
Active driversDrivers or agents with assigned jobs that have not been completed.Review dispatch capacity before assigning more work.
Revenue MTDInvoiceable shipment revenue for the current month to date.Open Finance to review draft, sent, paid, and overdue invoices.
ExceptionsFailed deliveries, exception shipments, cancelled jobs, or returns that need attention.Prioritise exception resolution before new dispatch planning.

Reading the dashboard

AreaUse it to answerTypical action
Operations summaryHow many shipments are waiting, moving, completed, or blocked today?Open the filtered shipment list and clear the oldest operational blockers first.
Dispatch viewWhich drivers, agents, routes, or depots are overloaded?Reassign work, split a route, or delay new bookings before service levels slip.
Finance healthWhat is draft, sent, partially paid, paid, or overdue?Send draft invoices, chase overdue balances, or reconcile partial payments.
Customer activityWhich messages, exceptions, or tracking events need a customer response?Respond before the customer calls support or escalates a failed delivery.

Activity feed

The feed shows recent operational activity such as new shipments, status changes, assignments, invoice updates, customer messages, and failed delivery events. Use it during shift handovers to understand what changed while a manager or dispatcher was away.

Quick actions

Create shipment

Open a blank shipment form for sender, recipient, cargo, pricing, and notification details.

Assign job

Move unassigned shipments into dispatch by choosing a driver, agent, pickup window, or route.

Generate invoice

Create a draft invoice using shipment pricing and customer account details.

Review exceptions

Jump to failed deliveries, exception shipments, returns, and cancelled work that needs a decision.

Real-time updates

Dashboard counts, activity, and status changes update in real time. If another user assigns a job or a driver confirms delivery, the dashboard reflects it without a manual refresh.

Shipments

Shipments are the core record in Fauward. A shipment contains the sender, recipient, cargo, pricing, route, status history, documents, and customer-facing tracking timeline.

Every shipment moves through a defined status lifecycle:

PENDING -> PROCESSING -> PICKED_UP -> IN_TRANSIT -> OUT_FOR_DELIVERY -> DELIVERED
StatusMeaningTypical owner
PENDINGThe shipment has been created and is waiting for operational processing.Dispatcher or operations team
PROCESSINGThe job is accepted, priced, assigned, or being prepared for pickup.Operations team or dispatcher
PICKED_UPThe parcel, pallet, or cargo has been collected from the sender.Driver, agent, or depot team
IN_TRANSITThe shipment is moving through your network or between hubs.Driver, linehaul team, or agent
OUT_FOR_DELIVERYThe shipment is assigned for final delivery to the recipient.Driver or delivery agent
DELIVEREDDelivery is complete and proof of delivery can be generated.Driver, agent, or dispatcher

Exception branches

StatusWhen to use it
FAILED_DELIVERYRecipient unavailable, wrong address, refused delivery, or delivery attempt failed.
EXCEPTIONA shipment needs investigation because of a delay, damage report, customs issue, route issue, or manual override.
RETURNEDThe shipment is being returned to the sender or origin depot.
CANCELLEDThe shipment should no longer move through the network.

Status transition rules

Fauward accepts only valid next statuses. This protects timelines, invoices, and customer notifications from skipping operational evidence.

FromAllowed next statuses
PENDINGPROCESSING or CANCELLED
PROCESSINGPICKED_UP or CANCELLED
PICKED_UPIN_TRANSIT, FAILED_DELIVERY, or EXCEPTION
IN_TRANSITOUT_FOR_DELIVERY, FAILED_DELIVERY, or EXCEPTION
OUT_FOR_DELIVERYDELIVERED, FAILED_DELIVERY, or EXCEPTION
FAILED_DELIVERY or EXCEPTIONRetry, return, or recover into the next operational state.

Proof before delivered

A shipment cannot be completed as delivered until proof of delivery evidence is available. Capture the recipient name, OTP, signature, photo, or other required POD fields before closing the job.

Creating a shipment

Create shipments from the dashboard, shipment list, booking widget, or API. Fill in sender, recipient, cargo details, service type, pricing, and any collection or delivery instructions. A tracking reference such as FW-10482 is generated automatically.

  • Sender details: name, company, address, phone, email, pickup notes, and preferred pickup window.
  • Recipient details: name, company, address, phone, email, delivery notes, and notification preference.
  • Cargo details: item description, quantity, weight, dimensions, declared value, fragility, and special handling notes.
  • Commercial details: service level, price, tax treatment, customer account, and invoice reference.
  • Compliance details: customs category, item value, HS code, return instructions, and required labels where your workflow uses them.

Tracking & timeline

Every status change is logged with a timestamp, source, and user where available. The internal timeline helps your team audit what happened. The customer timeline presents the customer-safe version of the same journey, including milestones, exception states, delivery attempts, and proof-of-delivery availability without exposing internal notes.

Bulk operations

In the shipment list, select multiple shipments to assign a driver, move them to a new status, export them to CSV, or prepare a manifest. Use filters before selecting rows if you only want to update a specific depot, customer, route, service type, or status.

Documents

Proof of delivery

Generated after completion using captured recipient name, OTP, signature, photo, and delivery timestamp.

Cargo manifest

A route or depot-level document listing shipments, references, destinations, and handling notes.

Shipping labels

Printable labels containing the tracking reference, barcode or QR code, sender, recipient, and routing details.

CSV exports

Operational exports for finance review, customer reporting, depot handovers, and exception analysis.

Dispatch & Field Ops

Dispatch

The Dispatch page turns shipments into work. Assign jobs to drivers or agents, plan routes, set pickup windows, and monitor progress as field updates come in.

Unassigned queue

See shipments that need a driver, agent, route, pickup window, or operational decision.

Driver workload

Compare active jobs by driver before assigning additional pickups or deliveries.

Route planning

Group shipments by area, depot, delivery window, service level, or customer account.

Live progress

Track when jobs are picked up, scanned, delayed, failed, or delivered without calling the field team.

fauward Go

Your field team uses fauward Go, a mobile web app installed directly to their phone with no app store required. Drivers see only their assigned work and step through each job in the correct order.

  • View assigned pickups, linehaul movements, deliveries, and exception tasks.
  • Scan QR codes or barcodes at each stop to verify the right parcel.
  • Capture proof of delivery with recipient name, OTP, signature, or photo.
  • Add delivery notes when access is blocked, a recipient is unavailable, or cargo is damaged.
  • Work offline while scans and confirmations queue locally and sync when the device is back online.

Stop workflow

Field actionSystem updateBack-office result
Accept assigned workConfirms the driver or agent owns the stop list.Dispatch can see who is responsible before pickup or delivery begins.
Scan at pickupMoves the shipment toward PICKED_UP when the right label is scanned.Customers and dispatchers know collection has happened.
Start final deliveryMoves eligible jobs to OUT_FOR_DELIVERY.SMS or email updates can be sent for time-sensitive deliveries.
Capture proofStores POD evidence and completes the job as DELIVERED.Finance and support can reference a completion record.
Report a problemMarks FAILED_DELIVERY or EXCEPTION with notes and evidence.The desk can reattempt, return, contact the customer, or investigate.

Proof of delivery options

Proof typeBest forCustomer value
Recipient nameLow-risk courier and depot handover workflows.Shows who accepted the shipment.
OTPHigher-value deliveries where the recipient must confirm possession.Reduces disputes and mistaken handoffs.
SignatureB2B delivery, regulated goods, or contract-required proof.Creates a signed completion record.
PhotoLeave-safe locations, door drops, damaged cargo, or site proof.Provides visual confirmation of the delivery state.

Agents

For simpler scan-and-advance workflows, the agents app lets field staff quickly update shipment status by scanning a tracking label. It is useful at depots, warehouses, partner counters, and temporary collection points.

Offline behaviour

Fauward Go stores assigned stops, scans, notes, signatures, photos, and completion attempts locally when connectivity drops. Field users should keep the app open until queued actions sync, then confirm the job no longer shows as pending before leaving a low-signal area.

Finance & Invoicing

Finance connects shipment operations to billing. Pricing entered on shipments can flow into quotes, invoices, payment tracking, and reconciliation.

Quotes

Prepare a customer price before the job is accepted. Convert the quote to an invoice when the work is confirmed.

Invoices

Invoice line items can auto-populate from shipment pricing, service fees, surcharges, and customer account details.

Payments

Accept payment via Stripe, including card and bank transfer where enabled for your account.

Reconciliation

Match payments to invoices, review partial payments, and identify overdue customer balances.

Invoice lifecycle

DRAFT -> SENT -> PARTIALLY_PAID -> PAIDwith OVERDUE and VOID for exception cases
StatusMeaning
DRAFTEditable invoice that has not been sent to the customer.
SENTIssued invoice awaiting payment.
PARTIALLY_PAIDOne or more payments have been recorded, but the invoice total is not fully collected.
PAIDCompleted payments meet or exceed the invoice total.
OVERDUEA sent invoice passed its due date without being fully paid.
VOIDInvoice is cancelled for billing purposes and should not be collected.
  • Create quotes and convert them to invoices in one click.
  • Auto-populate line items from shipment pricing, service type, and customer account details.
  • Add manual line items for waiting time, storage, customs handling, insurance, or special services.
  • Record partial payments when a customer pays in stages or a remittance covers several invoices.
  • Send invoices to customer billing contacts and track when they become overdue.
  • Export invoice history, payments, and reconciliation reports to CSV.

Adjustments and cash workflows

Credit notes

Use credit notes to record approved billing corrections, refunds, service failures, or negotiated adjustments.

Cash on delivery

Track COD collections where your plan and regional payment setup support collection and reconciliation.

Payouts

Review payout-ready collections and mark settlement progress for finance handover.

Voids

Void invoices that should no longer be collected instead of editing historical paid records.

Operational habit

Keep pricing accurate on each shipment before delivery. That gives finance a cleaner invoice draft and reduces manual edits at month end.

Your Team

Invite team members from Settings -> Team. Each member gets a role that controls what they can see and do.

RoleBest forAccess
TENANT_ADMINBusiness owners and senior operatorsFull access to billing, settings, users, branding, API keys, finance, and all operational data.
TENANT_MANAGEROperations leads and finance managersBroad operational access for shipments, dispatch, customers, reporting, and day-to-day exceptions.
TENANT_FINANCEFinance and reconciliation usersFinance workflows such as invoices, payments, credit notes, exports, and billing reports.
TENANT_STAFFDispatch desk and depot coordinatorsCreate shipments, assign jobs, manage statuses, and monitor routes.
TENANT_DRIVERDrivers, warehouse scanners, and field staffField operations through Fauward Go, assigned stops, scan flows, proof capture, and status updates.
CUSTOMER_ADMINCustomer account ownersCustomer-organisation visibility for their own shipments, returns, tickets, and account users.
CUSTOMER_USERShippers, account customers, or consignee usersView their own shipments, timelines, and documents only.

Invites and onboarding

Members receive an email invite and set their own password. If the invite expires, resend it from the team settings page. For operational staff, confirm they can log in before their first shift and that their assigned role matches the work they need to do.

Role assignment guidance

The role names above are the exact tenant and customer role values used by the platform. Platform-only administration is not assignable from a tenant workspace. Use customer roles only for external customer account access, not for your internal dispatch, finance, or driver staff.

  • Use TENANT_ADMIN only for users who can change billing, API keys, branding, and account settings.
  • Use TENANT_MANAGER for operations leads who need broad control without every account-level responsibility.
  • Use TENANT_FINANCE for users who mainly manage invoices, payments, exports, and reconciliation.
  • Use TENANT_STAFF for dispatchers and depot operators who create and move shipments.
  • Use TENANT_DRIVER for field users who should work through Fauward Go instead of the full portal.

Security controls

  • Enforce MFA with an authenticator app for admins, managers, finance users, and API key owners.
  • Use the lowest role that lets each user do their job.
  • Reset passwords from team settings when a user cannot complete the self-service flow.
  • Suspend users instead of deleting them when you need to preserve ownership history.
  • Remove inactive users when staff leave, change depot, or no longer need access.
  • Create separate user accounts instead of sharing one dispatcher or driver login.

Customer Tracking Widget

Embed a branded tracking widget on your own website so customers can check shipment status without contacting your team. This reduces inbound calls and gives customers a self-service way to see the latest timeline.

Embed code

Add one script tag to your site:

<script
  src="https://fauward.com/embed.js"
  data-tenant="yourslug"
  data-api-key="fw_your_public_widget_key"
  async
></script>

Hosted booking page

If you do not want to embed the form on your own site first, send customers to your hosted booking page at https://ship.fauward.com/yourslug. The hosted page uses the same tenant branding and shipment-creation workflow as the embeddable widget.

Widget token flow

The widget exchanges its tenant slug and API key for a short-lived embed token before it submits shipment data. Your site never needs to expose a server secret value.

GET /api/embed/token?tenant=yourslug
Authorization: Bearer fw_your_public_widget_key

What customers see

  • A branded tracking search field using your logo and colours.
  • Current shipment status, tracking reference, and customer-safe timeline.
  • Milestone timestamps such as processing, picked up, in transit, out for delivery, and delivered.
  • Exception states when a shipment has a failed delivery, exception, return, or cancellation.
  • Phone verification or payment prompts where your workflow enables them for customer-created shipments.

Recommended placement

Add the widget to your public tracking page, customer support page, and post-booking confirmation page. If your website has a customer portal, place it where customers already go for shipment updates.

Brand inheritance

The widget inherits your configured brand colours and logo automatically, so changes made in Settings -> Branding appear consistently across the portal and widget.

Branding & White-Label

Fauward is fully white-label, so your customers experience your logistics brand rather than Fauward. Branding applies across the portal, tracking widget, customer emails, and customer-facing documents where supported.

What you can customise

Business identity

Set your business name, logo, portal display name, and customer-facing support identity.

Colours

Set primary and accent colours used across the tenant portal, customer tracking, and widget.

Domain

Use your Fauward subdomain immediately. Pro and Enterprise customers can add a custom customer-facing subdomain with DNS verification.

Email sender

Set the sender name and support identity customers see when receiving tracking and finance notifications.

Languages and layout

Use RTL layout support for right-to-left languages where your customer experience requires it.

Documents

Keep labels, manifests, and proof of delivery documents consistent with your customer-facing brand.

Branding checklist

  • Use a clear logo that works on white backgrounds and small screens.
  • Choose a primary colour with enough contrast for buttons and important labels.
  • Add a support email, support phone number, and customer-facing business address where appropriate.
  • Preview the customer tracking page after making changes.
  • For a custom domain, add the CNAME shown in Settings -> Domain and wait for the verification status to become Live.
  • Send yourself a test notification to confirm the customer-facing sender name.
  • Review documents after brand changes if your team prints labels or PODs.

Domain setup flow

  1. 1Choose the customer-facing hostname you want to use, such as track.yourcompany.com.
  2. 2Add it in Settings -> Domain and copy the DNS record shown in the portal.
  3. 3Create the CNAME with your DNS provider and wait for verification.
  4. 4Preview tracking, widget, emails, and documents before sharing the domain with customers.

Update your branding any time from Settings -> Branding.

Notifications

Fauward sends automatic notifications to your customers at key shipment milestones. Use notifications to reduce support volume, improve customer confidence, and keep delivery expectations clear.

Channels

ChannelUse it forSetup
EmailShipment confirmations, delivery updates, invoices, PODs, and longer messages.Uses your configured sender name.
SMSTime-sensitive collection, out-for-delivery, delivery, and exception alerts.Enable Twilio in Settings -> Notifications.
MessagingDirect customer conversations inside your support inbox.Use the Messaging tab powered by Relay.
In-appInternal reminders, unread conversation state, and operational prompts.Available in the tenant portal for users with the right role.

Common triggers

TriggerCustomer messageUsual channel
Shipment createdConfirms the booking and shares the tracking reference.Email
ProcessingConfirms the shipment is booked and being prepared.Email
Picked upConfirms the item has been picked up.Email or SMS
Out for deliveryTells the recipient to expect delivery soon.SMS
DeliveredConfirms completion and can include proof of delivery details.Email or SMS
Failed delivery / exceptionExplains the exception and prompts the customer to contact you or wait for updates.Email and SMS

Customer messaging tips

  • Keep milestone messages short and specific.
  • Use your brand sender name so customers recognise the update.
  • Avoid exposing internal route, depot, or staff details in customer-facing messages.
  • Use failed-delivery messages to tell customers what happens next.
  • Use Relay conversations for two-way support instead of putting long operational notes into SMS templates.
  • Test templates after changing branding, phone verification, payment prompts, or support routing.
  • Review notifications when you change your operating hours or support process.

API & Webhooks

API keys and webhooks help you connect Fauward to your own booking forms, ecommerce systems, finance tools, customer portals, warehouse software, and reporting workflows.

API keys

Generate API keys from Settings -> API Keys. Keys are scoped to your tenant and should be treated like passwords.

All API calls use:

Authorization: Bearer fw_your_api_key
ScopeUse
shipments:readRead shipment records and tracking state.
shipments:writeCreate shipments and update shipment workflows.
labels:readRead generated label metadata and label documents.
rates:read / rates:writeRead or maintain rate and quote-related resources where enabled.
webhooks:read / webhooks:writeList endpoints, create endpoints, send tests, and replay deliveries.
api-keys:read / api-keys:writeRead usage and manage API keys for integrations.
domains:read / domains:writeRead or update custom-domain settings.
returns:read / customs:readRead returns and customs workflows where your plan exposes those modules.

Request safety

  • Create a separate key for each integration so you can revoke one system without breaking another.
  • Use read-only scopes for reporting, tracking, and dashboard sync jobs.
  • Use write scopes only for systems that create shipments, update routes, send webhook tests, or manage domains.
  • Use idempotency keys for retryable create or update calls where the endpoint supports them.
  • Rotate keys when a team member leaves or a connected vendor changes access.

Common API uses

Create shipments

Send new bookings from your website, ecommerce checkout, warehouse system, or customer portal into Fauward.

Read tracking status

Display shipment status in your own customer portal or account dashboard.

Sync customers

Keep customer account names, billing contacts, and references aligned with your source system.

Export finance data

Pull invoices, payment status, or shipment charges into your accounting or reporting process.

Common endpoints

EndpointUse
GET /api/v1/shipmentsList shipments for your tenant with filters and pagination.
POST /api/v1/shipmentsCreate a shipment from a booking form, customer portal, or warehouse system.
GET /api/v1/tenant/webhooksList configured webhook endpoints and delivery health where webhooks are enabled.
POST /api/v1/tenant/webhooks/:id/testSend a signed test event to verify your receiving system.
GET /api/v1/tenant/api-usageReview API usage by key, endpoint, and date range.

Webhooks

Register webhook endpoints to receive real-time events when shipments change status, deliveries complete, failed-delivery events occur, and other configured shipment updates happen. Configure endpoints from Settings -> Webhooks.

Each event is delivered as a POST with a JSON payload and signed with your webhook secret. Your receiving system should verify the signature before trusting the payload.

{
  "event": "shipment.status.changed",
  "tenant": "yourslug",
  "data": {
    "trackingReference": "FW-10482",
    "previousStatus": "IN_TRANSIT",
    "status": "OUT_FOR_DELIVERY",
    "updatedAt": "2026-04-26T09:30:00Z"
  }
}

Webhook headers

HeaderPurpose
X-Event-TypeEvent name delivered to the endpoint.
X-Delivery-IdUnique delivery attempt identifier for troubleshooting and replay.
X-Fauward-Event-IdStable event identifier for deduplication.
X-Webhook-Signature / X-Fauward-SignatureHMAC signature your receiver should verify before processing.

Common events

EventSource
shipment.createdShipment creation outbox event.
shipment.status.changedConfigured shipment webhook fired when the operational shipment status changes.
shipment.deliveredTracking webhook for customer-visible delivered events.
shipment.failed_deliveryTracking webhook for failed-delivery events.
shipment.out_for_deliveryTracking webhook for out-for-delivery events.
webhook.testManual test delivery from the webhook settings screen.

Delivery and replay

Webhook deliveries are retried automatically with backoff when your endpoint does not respond successfully. Use the delivery log to inspect response codes, latency, failed attempts, and replay a delivery after fixing the receiving system.

Operational advice

Give each integration its own API key where possible. That makes it easier to rotate or revoke one system without disrupting the rest of your operation.

Account & Billing

Plans

PlanBest fitIncludes
StarterSmall teams starting with core shipment operations.300 shipments/month, 3 staff seats, shipment creation, tracking, branded notifications, basic invoicing, and Fauward Go proof-of-delivery.
ProGrowing logistics businesses that need finance, dispatch, fleet workflows, and integrations.2,000 shipments/month, 15 staff seats, API access, webhooks, custom domain, automation, messaging, Fauward Agent, and advanced reporting.
EnterpriseHigh-volume operators with custom domain, support, security, or procurement needs.Unlimited shipments and staff, SSO, audit logs, SLA-backed uptime, dedicated support, custom controls, and tailored onboarding.

Plan limits and gates

FeatureStarterProEnterprise
Shipments / month3002,000Unlimited
Staff seats315Unlimited
API access and webhooksNoYesYes, higher limits
Custom domainNoYesYes
SSO and audit logsNoNoYes

Upgrade or downgrade from Settings -> Plan & Billing. Changes take effect immediately, and billing is prorated.

Trial

Your 14-day trial includes full Pro features. No card is required to start. Before the trial ends, you will be prompted to add a payment method and choose the plan that fits your shipment volume and operating needs.

Billing administration

  • Only users with billing access should manage plans, payment methods, and invoices.
  • Keep the billing contact email current so invoice and renewal notices reach the right person.
  • Review plan limits before seasonal peaks, new customer launches, or additional depot rollouts.
  • Check API and shipment usage before downgrading so critical workflows do not lose access.
  • Resolve failed payment status quickly to avoid account suspension and interrupted integrations.
  • Export operational and finance data before major account changes if your internal process requires it.

Cancellation

Cancel any time from Settings -> Plan & Billing. Your data is retained for 30 days after cancellation so you can export records or reactivate the workspace if needed.