Welcome

This non-technical documentation explains what each dispatchly. module does from a business/user workflow perspective.

How to use this page

• Open modules from the left sidebar to view purpose and flow details.
• Use these notes as process guidance for operations teams.
• Use Swagger UI only when you need exact API field-level details.

Scope

The content covers day-to-day usage flow across sales, dispatch, marketing, and accounts operations.

What changed operationally (read this first)

• Lead → quote: converting a lead now copies the linked customer’s mailing city/state/ZIP (and address lines) onto the quote automatically, so sales sees the same customer location everywhere.
• Attachments: quotes, orders, and dispatches support adding files via PATCH; you can upload multiple files in one request, and quote attachment changes stay in sync with linked orders/dispatches when updated at the quote level.
• eDoc signing links: the API can store full public URLs for signed PDFs when TENANT_API_PUBLIC_ORIGIN is configured for your environment (see .env.example).
• Sales users: sales and sales-head are intended to have orders.update so order edits match how routes already treat those roles.

User/business-focused docs. For exact request/response fields, use Swagger UI.

Swagger UI: Open Swagger

What it does

This module helps you manage **Auth** in the dispatchly. workflow.

When to use

Use this module whenever you need to work with the auth part of the shipment lifecycle.

Key capabilities

• List and view records related to Auth
• Apply filters/search and inspect statuses
• Perform the actions defined by your role/permissions

Swagger UI: Open Swagger

Typical workflow

• Start by using the main list view for Auth (or open Swagger for testing).
• Create or update records using the fields relevant to your operation.
• Changes are scoped to your tenant and enforced by role/permission checks.

What to look for

• Correct required fields (validation failures will surface in Swagger responses).
• Relationships (e.g., linking customers across the workflow where supported).
• Role-based access (Admin/Sub-Admin and functional roles).

What it does

This module helps you manage **SSE** in the dispatchly. workflow.

When to use

Use this module whenever you need to work with the sse part of the shipment lifecycle.

Key capabilities

• List and view records related to SSE
• Apply filters/search and inspect statuses
• Perform the actions defined by your role/permissions

Swagger UI: Open Swagger

Typical workflow

• Start by using the main list view for SSE (or open Swagger for testing).
• Create or update records using the fields relevant to your operation.
• Changes are scoped to your tenant and enforced by role/permission checks.

What to look for

• Correct required fields (validation failures will surface in Swagger responses).
• Relationships (e.g., linking customers across the workflow where supported).
• Role-based access (Admin/Sub-Admin and functional roles).

What it does

This module helps you manage **Users** in the dispatchly. workflow.

When to use

Use this module whenever you need to work with the users part of the shipment lifecycle.

Key capabilities

• List and view records related to Users
• Apply filters/search and inspect statuses
• Perform the actions defined by your role/permissions

Swagger UI: Open Swagger

Typical workflow

• Start by using the main list view for Users (or open Swagger for testing).
• Create or update records using the fields relevant to your operation.
• Changes are scoped to your tenant and enforced by role/permission checks.

What to look for

• Correct required fields (validation failures will surface in Swagger responses).
• Relationships (e.g., linking customers across the workflow where supported).
• Role-based access (Admin/Sub-Admin and functional roles).

What it does

This module helps you manage **Departments** in the dispatchly. workflow.

When to use

Use this module whenever you need to work with the departments part of the shipment lifecycle.

Key capabilities

• List and view records related to Departments
• Apply filters/search and inspect statuses
• Perform the actions defined by your role/permissions

Swagger UI: Open Swagger

Typical workflow

• Start by using the main list view for Departments (or open Swagger for testing).
• Create or update records using the fields relevant to your operation.
• Changes are scoped to your tenant and enforced by role/permission checks.

What to look for

• Correct required fields (validation failures will surface in Swagger responses).
• Relationships (e.g., linking customers across the workflow where supported).
• Role-based access (Admin/Sub-Admin and functional roles).

What it does

This module helps you manage **Roles** in the dispatchly. workflow.

When to use

Use this module whenever you need to work with the roles part of the shipment lifecycle.

Key capabilities

• List and view records related to Roles
• Apply filters/search and inspect statuses
• Perform the actions defined by your role/permissions

Swagger UI: Open Swagger

Typical workflow

• Start by using the main list view for Roles (or open Swagger for testing).
• Create or update records using the fields relevant to your operation.
• Changes are scoped to your tenant and enforced by role/permission checks.

What to look for

• Correct required fields (validation failures will surface in Swagger responses).
• Relationships (e.g., linking customers across the workflow where supported).
• Role-based access (Admin/Sub-Admin and functional roles).

What it does

This module helps you manage **Permissions** in the dispatchly. workflow.

When to use

Use this module whenever you need to work with the permissions part of the shipment lifecycle.

Key capabilities

• List and view records related to Permissions
• Apply filters/search and inspect statuses
• Perform the actions defined by your role/permissions

Swagger UI: Open Swagger

Typical workflow

• Start by using the main list view for Permissions (or open Swagger for testing).
• Create or update records using the fields relevant to your operation.
• Changes are scoped to your tenant and enforced by role/permission checks.

What to look for

• Correct required fields (validation failures will surface in Swagger responses).
• Relationships (e.g., linking customers across the workflow where supported).
• Role-based access (Admin/Sub-Admin and functional roles).

What it does

This module helps you manage **Admin** in the dispatchly. workflow.

When to use

Use this module whenever you need to work with the admin part of the shipment lifecycle.

Key capabilities

• List and view records related to Admin
• Apply filters/search and inspect statuses
• Perform the actions defined by your role/permissions

Swagger UI: Open Swagger

Typical workflow

• Start by using the main list view for Admin (or open Swagger for testing).
• Create or update records using the fields relevant to your operation.
• Changes are scoped to your tenant and enforced by role/permission checks.

What to look for

• Correct required fields (validation failures will surface in Swagger responses).
• Relationships (e.g., linking customers across the workflow where supported).
• Role-based access (Admin/Sub-Admin and functional roles).

What it does

This module helps you manage **Leads** in the dispatchly. workflow.

When to use

Use this module whenever you need to work with the leads part of the shipment lifecycle.

Key capabilities

• List and view records related to Leads
• Apply filters/search and inspect statuses
• Perform the actions defined by your role/permissions

Lead conversion reminder

• When you convert a lead to a quote, the system now copies the customer’s saved address (city, state, postal code, lines, country) from the customer profile onto the quote automatically.
• If you still see blanks, update the customer profile first, then convert again (existing quotes are not retro-edited).

Swagger UI: Open Swagger

Typical workflow

• Start by using the main list view for Leads (or open Swagger for testing).
• Create or update records using the fields relevant to your operation.
• Changes are scoped to your tenant and enforced by role/permission checks.

What to look for

• Correct required fields (validation failures will surface in Swagger responses).
• Relationships (e.g., linking customers across the workflow where supported).
• Role-based access (Admin/Sub-Admin and functional roles).

What it does

This module helps you manage **Quotes** in the dispatchly. workflow.

When to use

Use this module whenever you need to work with the quotes part of the shipment lifecycle.

Key capabilities

• List and view records related to Quotes
• Apply filters/search and inspect statuses
• Perform the actions defined by your role/permissions

Attachments & downstream records

• Quotes can carry supporting documents; updating quote-level attachments keeps linked orders/dispatches aligned when those relationships exist.
• You may upload multiple supporting files in one save action from integrations that support multipart uploads.

Swagger UI: Open Swagger

Typical workflow

• Start by using the main list view for Quotes (or open Swagger for testing).
• Create or update records using the fields relevant to your operation.
• Changes are scoped to your tenant and enforced by role/permission checks.

What to look for

• Correct required fields (validation failures will surface in Swagger responses).
• Relationships (e.g., linking customers across the workflow where supported).
• Role-based access (Admin/Sub-Admin and functional roles).

What it does

This module helps you manage **Orders** in the dispatchly. workflow.

When to use

Use this module whenever you need to work with the orders part of the shipment lifecycle.

Key capabilities

• List and view records related to Orders
• Apply filters/search and inspect statuses
• Perform the actions defined by your role/permissions

Editing orders as sales

• Sales and sales-head users are expected to be able to update operational order fields (including attachments) without admin intervention—permissions are aligned with that workflow.
• Order-level attachments can be added after the quote stage; large files should respect the standard upload size limits configured for the API.

Swagger UI: Open Swagger

Typical workflow

• Start by using the main list view for Orders (or open Swagger for testing).
• Create or update records using the fields relevant to your operation.
• Changes are scoped to your tenant and enforced by role/permission checks.

What to look for

• Correct required fields (validation failures will surface in Swagger responses).
• Relationships (e.g., linking customers across the workflow where supported).
• Role-based access (Admin/Sub-Admin and functional roles).

What it does

This module helps you manage **Dispatch** in the dispatchly. workflow.

When to use

Use this module whenever you need to work with the dispatch part of the shipment lifecycle.

Key capabilities

• List and view records related to Dispatch
• Apply filters/search and inspect statuses
• Perform the actions defined by your role/permissions

Carrier paperwork

• Dispatches can store their own POD/BOL attachments separate from the sales quote packet—use dispatch attachments when the field team uploads documents after pickup.

Swagger UI: Open Swagger

Typical workflow

• Start by using the main list view for Dispatch (or open Swagger for testing).
• Create or update records using the fields relevant to your operation.
• Changes are scoped to your tenant and enforced by role/permission checks.

What to look for

• Correct required fields (validation failures will surface in Swagger responses).
• Relationships (e.g., linking customers across the workflow where supported).
• Role-based access (Admin/Sub-Admin and functional roles).

What it does

This module helps you manage **Carriers** in the dispatchly. workflow.

When to use

Use this module whenever you need to work with the carriers part of the shipment lifecycle.

Key capabilities

• List and view records related to Carriers
• Apply filters/search and inspect statuses
• Perform the actions defined by your role/permissions

Swagger UI: Open Swagger

Typical workflow

• Start by using the main list view for Carriers (or open Swagger for testing).
• Create or update records using the fields relevant to your operation.
• Changes are scoped to your tenant and enforced by role/permission checks.

What to look for

• Correct required fields (validation failures will surface in Swagger responses).
• Relationships (e.g., linking customers across the workflow where supported).
• Role-based access (Admin/Sub-Admin and functional roles).

What it does

This module helps you manage **Invoices** in the dispatchly. workflow.

When to use

Use this module whenever you need to work with the invoices part of the shipment lifecycle.

Key capabilities

• List and view records related to Invoices
• Apply filters/search and inspect statuses
• Perform the actions defined by your role/permissions

Swagger UI: Open Swagger

Typical workflow

• Start by using the main list view for Invoices (or open Swagger for testing).
• Create or update records using the fields relevant to your operation.
• Changes are scoped to your tenant and enforced by role/permission checks.

What to look for

• Correct required fields (validation failures will surface in Swagger responses).
• Relationships (e.g., linking customers across the workflow where supported).
• Role-based access (Admin/Sub-Admin and functional roles).

What it does

This module helps you manage **Payments** in the dispatchly. workflow.

When to use

Use this module whenever you need to work with the payments part of the shipment lifecycle.

Key capabilities

• List and view records related to Payments
• Apply filters/search and inspect statuses
• Perform the actions defined by your role/permissions

Swagger UI: Open Swagger

Typical workflow

• Start by using the main list view for Payments (or open Swagger for testing).
• Create or update records using the fields relevant to your operation.
• Changes are scoped to your tenant and enforced by role/permission checks.

What to look for

• Correct required fields (validation failures will surface in Swagger responses).
• Relationships (e.g., linking customers across the workflow where supported).
• Role-based access (Admin/Sub-Admin and functional roles).

What it does

This module helps you manage **Accounts** in the dispatchly. workflow.

When to use

Use this module whenever you need to work with the accounts part of the shipment lifecycle.

Key capabilities

• List and view records related to Accounts
• Apply filters/search and inspect statuses
• Perform the actions defined by your role/permissions

Swagger UI: Open Swagger

Typical workflow

• Start by using the main list view for Accounts (or open Swagger for testing).
• Create or update records using the fields relevant to your operation.
• Changes are scoped to your tenant and enforced by role/permission checks.

What to look for

• Correct required fields (validation failures will surface in Swagger responses).
• Relationships (e.g., linking customers across the workflow where supported).
• Role-based access (Admin/Sub-Admin and functional roles).

What it does

This module helps you manage **Marketing** in the dispatchly. workflow.

When to use

Use this module whenever you need to work with the marketing part of the shipment lifecycle.

Key capabilities

• List and view records related to Marketing
• Apply filters/search and inspect statuses
• Perform the actions defined by your role/permissions

Swagger UI: Open Swagger

Typical workflow

• Start by using the main list view for Marketing (or open Swagger for testing).
• Create or update records using the fields relevant to your operation.
• Changes are scoped to your tenant and enforced by role/permission checks.

What to look for

• Correct required fields (validation failures will surface in Swagger responses).
• Relationships (e.g., linking customers across the workflow where supported).
• Role-based access (Admin/Sub-Admin and functional roles).

What it does

This module helps you manage **Calendar** in the dispatchly. workflow.

When to use

Use this module whenever you need to work with the calendar part of the shipment lifecycle.

Key capabilities

• List and view records related to Calendar
• Apply filters/search and inspect statuses
• Perform the actions defined by your role/permissions

Swagger UI: Open Swagger

Typical workflow

• Start by using the main list view for Calendar (or open Swagger for testing).
• Create or update records using the fields relevant to your operation.
• Changes are scoped to your tenant and enforced by role/permission checks.

What to look for

• Correct required fields (validation failures will surface in Swagger responses).
• Relationships (e.g., linking customers across the workflow where supported).
• Role-based access (Admin/Sub-Admin and functional roles).

What it does

This module helps you manage **Notifications** in the dispatchly. workflow.

When to use

Use this module whenever you need to work with the notifications part of the shipment lifecycle.

Key capabilities

• List and view records related to Notifications
• Apply filters/search and inspect statuses
• Perform the actions defined by your role/permissions

Swagger UI: Open Swagger

Typical workflow

• Start by using the main list view for Notifications (or open Swagger for testing).
• Create or update records using the fields relevant to your operation.
• Changes are scoped to your tenant and enforced by role/permission checks.

What to look for

• Correct required fields (validation failures will surface in Swagger responses).
• Relationships (e.g., linking customers across the workflow where supported).
• Role-based access (Admin/Sub-Admin and functional roles).

What it does

This module helps you manage **Email Templates** in the dispatchly. workflow.

When to use

Use this module whenever you need to work with the email templates part of the shipment lifecycle.

Key capabilities

• List and view records related to Email Templates
• Apply filters/search and inspect statuses
• Perform the actions defined by your role/permissions

Swagger UI: Open Swagger

Typical workflow

• Start by using the main list view for Email Templates (or open Swagger for testing).
• Create or update records using the fields relevant to your operation.
• Changes are scoped to your tenant and enforced by role/permission checks.

What to look for

• Correct required fields (validation failures will surface in Swagger responses).
• Relationships (e.g., linking customers across the workflow where supported).
• Role-based access (Admin/Sub-Admin and functional roles).

What it does

This module helps you manage **Files** in the dispatchly. workflow.

When to use

Use this module whenever you need to work with the files part of the shipment lifecycle.

Key capabilities

• List and view records related to Files
• Apply filters/search and inspect statuses
• Perform the actions defined by your role/permissions

Two different “file” concepts

• The Files module tracks structured file metadata for tenant workflows.
• Quote/order/dispatch attachments are stored as public uploads for quick preview/download—do not confuse the two when training new staff.

Swagger UI: Open Swagger

Typical workflow

• Start by using the main list view for Files (or open Swagger for testing).
• Create or update records using the fields relevant to your operation.
• Changes are scoped to your tenant and enforced by role/permission checks.

What to look for

• Correct required fields (validation failures will surface in Swagger responses).
• Relationships (e.g., linking customers across the workflow where supported).
• Role-based access (Admin/Sub-Admin and functional roles).

What it does

This module helps you manage **Search** in the dispatchly. workflow.

When to use

Use this module whenever you need to work with the search part of the shipment lifecycle.

Key capabilities

• List and view records related to Search
• Apply filters/search and inspect statuses
• Perform the actions defined by your role/permissions

Swagger UI: Open Swagger

Typical workflow

• Start by using the main list view for Search (or open Swagger for testing).
• Create or update records using the fields relevant to your operation.
• Changes are scoped to your tenant and enforced by role/permission checks.

What to look for

• Correct required fields (validation failures will surface in Swagger responses).
• Relationships (e.g., linking customers across the workflow where supported).
• Role-based access (Admin/Sub-Admin and functional roles).

What it does

This module helps you manage **Knowledge Base** in the dispatchly. workflow.

When to use

Use this module whenever you need to work with the knowledge base part of the shipment lifecycle.

Key capabilities

• List and view records related to Knowledge Base
• Apply filters/search and inspect statuses
• Perform the actions defined by your role/permissions

Swagger UI: Open Swagger

Typical workflow

• Start by using the main list view for Knowledge Base (or open Swagger for testing).
• Create or update records using the fields relevant to your operation.
• Changes are scoped to your tenant and enforced by role/permission checks.

What to look for

• Correct required fields (validation failures will surface in Swagger responses).
• Relationships (e.g., linking customers across the workflow where supported).
• Role-based access (Admin/Sub-Admin and functional roles).

What it does

This module helps you manage **AI Pricing** in the dispatchly. workflow.

When to use

Use this module whenever you need to work with the ai pricing part of the shipment lifecycle.

Key capabilities

• List and view records related to AI Pricing
• Apply filters/search and inspect statuses
• Perform the actions defined by your role/permissions

Swagger UI: Open Swagger

Typical workflow

• Start by using the main list view for AI Pricing (or open Swagger for testing).
• Create or update records using the fields relevant to your operation.
• Changes are scoped to your tenant and enforced by role/permission checks.

What to look for

• Correct required fields (validation failures will surface in Swagger responses).
• Relationships (e.g., linking customers across the workflow where supported).
• Role-based access (Admin/Sub-Admin and functional roles).

What it does

This module helps you manage **Analytics** in the dispatchly. workflow.

When to use

Use this module whenever you need to work with the analytics part of the shipment lifecycle.

Key capabilities

• List and view records related to Analytics
• Apply filters/search and inspect statuses
• Perform the actions defined by your role/permissions

Swagger UI: Open Swagger

Typical workflow

• Start by using the main list view for Analytics (or open Swagger for testing).
• Create or update records using the fields relevant to your operation.
• Changes are scoped to your tenant and enforced by role/permission checks.

What to look for

• Correct required fields (validation failures will surface in Swagger responses).
• Relationships (e.g., linking customers across the workflow where supported).
• Role-based access (Admin/Sub-Admin and functional roles).

What it does

This module helps you manage **Templates** in the dispatchly. workflow.

When to use

Use this module whenever you need to work with the templates part of the shipment lifecycle.

Key capabilities

• List and view records related to Templates
• Apply filters/search and inspect statuses
• Perform the actions defined by your role/permissions

Swagger UI: Open Swagger

Typical workflow

• Start by using the main list view for Templates (or open Swagger for testing).
• Create or update records using the fields relevant to your operation.
• Changes are scoped to your tenant and enforced by role/permission checks.

What to look for

• Correct required fields (validation failures will surface in Swagger responses).
• Relationships (e.g., linking customers across the workflow where supported).
• Role-based access (Admin/Sub-Admin and functional roles).

What it does

This module helps you manage **Settings** in the dispatchly. workflow.

When to use

Use this module whenever you need to work with the settings part of the shipment lifecycle.

Key capabilities

• List and view records related to Settings
• Apply filters/search and inspect statuses
• Perform the actions defined by your role/permissions

Swagger UI: Open Swagger

Typical workflow

• Start by using the main list view for Settings (or open Swagger for testing).
• Create or update records using the fields relevant to your operation.
• Changes are scoped to your tenant and enforced by role/permission checks.

What to look for

• Correct required fields (validation failures will surface in Swagger responses).
• Relationships (e.g., linking customers across the workflow where supported).
• Role-based access (Admin/Sub-Admin and functional roles).

What it does

Customers sign transport paperwork online; the CRM stores the signed PDF and marks linked quote/order/dispatch as signed when applicable.

What you should expect

• Sign links open on the hosted eDoc site; the Tenant API exposes public verify/submit endpoints that only accept approved browser origins.
• Signed PDF links should use your real API hostname in production—your DevOps sets TENANT_API_PUBLIC_ORIGIN so stored URLs are not “localhost” behind proxies.
• Assigned rep now appears as a compact { id, name } object in public eDoc payloads so the signer UI can greet the right salesperson.

Handoff to operations

• After signing, finance/dispatch can rely on the same signedEdocUrl on the quote and mirrored fields on the order/dispatch records.

Swagger UI: Open Swagger

What it does

This module helps you manage **Customers** in the dispatchly. workflow.

When to use

Use this module whenever you need to work with the customers part of the shipment lifecycle.

Key capabilities

• List and view records related to Customers
• Apply filters/search and inspect statuses
• Perform the actions defined by your role/permissions

Swagger UI: Open Swagger

Typical workflow

• Start by using the main list view for Customers (or open Swagger for testing).
• Create or update records using the fields relevant to your operation.
• Changes are scoped to your tenant and enforced by role/permission checks.

What to look for

• Correct required fields (validation failures will surface in Swagger responses).
• Relationships (e.g., linking customers across the workflow where supported).
• Role-based access (Admin/Sub-Admin and functional roles).

How Customers get linked

In dispatchly., customers are primarily identified by email. When Leads/Quotes/Orders are created or updated, the system will find an existing customer by email or create a new one, then keep details in sync.