Authenticates against FreightWare and returns a secure FreightWare session token. The returned token must be supplied in the X-FreightWare request header for protected FreightWare-backed endpoints.

{
  "Username": "string",
  "Password": "string"
}

• Authenticates directly against FreightWare
• Returns a FreightWare session token
• Used before calling protected FreightWare endpoints
• Token must be supplied in the X-FreightWare header

Creates a waybill directly in FreightWare. The request includes consignor details, consignee details, service type, references, parcel items, dimensions, mass and routing information required by FreightWare.

• Creates an operational FreightWare waybill
• Supports shipment, consignor and consignee information
• Supports multi-parcel waybill creation
• Includes parcel dimensions, mass and references
• Returns the FreightWare create result

Saves a draft waybill into DCB Online/TMS. This endpoint is used when a shipment must be stored in DCB Online/TMS but not yet finalised into FreightWare.

• Creates draft DCB Online/TMS waybill records
• Creates or updates destination delivery site details
• Saves parcel line information
• Saves invoice reference information
• Calculates totals, mass, volume and chargeable units
• Uses transactional SQL rollback protection

Creates a finalised DCB Online/TMS waybill and pushes the shipment into FreightWare. This endpoint uses the same shipment structure as POST /api/DCBOnlineWaybillSave, but finalises the shipment instead of saving it as a draft.

• Uses the same payload structure as DCBOnlineWaybillSave
• Saves finalised DCB Online/TMS waybill records
• Saves parcel and invoice reference information
• Calls FreightWare waybill creation
• Commits only after the full finalisation process succeeds
• Uses rollback protection if any step fails

Retrieves advanced shipment tracking information from FreightWare. The endpoint is used when detailed waybill movement, parcel events, manifest information and POD status are required.

• Detailed tracking history
• Manifest and hub movement visibility
• Parcel-level operational visibility
• Delivery progress and shipment status
• POD status visibility where available

Public-facing tracking endpoint allowing customers, websites, external platforms and third-party systems to retrieve shipment status using a waybill number without authentication.

• Public shipment tracking by waybill number
• No username, password or token required
• Returns shipment tracking milestones
• Returns delivery progress and available POD visibility

Returns FreightWare shipment quotation estimates using account, service type, origin, destination, parcel dimensions, mass, volumetric calculations and routing information.

• Returns estimated FreightWare quote values
• Supports parcel dimensions and mass
• Uses FreightWare account and service information
• Can be used before waybill creation
• Quotation values remain subject to final operational validation

Generates a secure browser-accessible link for waybill label rendering. The label includes parcel barcode information, route code details, consignee details and RDLC PDF label output.

• Generates secure label access links
• Renders labels in the browser
• Supports parcel barcodes and route codes
• Supports PDF/RDLC label output
• Designed for customer portals and automated print workflows

Retrieves an archived proof of delivery document directly from eDocs using the supplied waybill number. The endpoint logs into eDocs with the supplied username and password, searches for the waybill barcode and returns the POD PDF as Base64.

{
  "Username": "string",
  "Password": "string",
  "Waybill": "string"
}

• Searches eDocs by exact waybill number
• Uses eDocs username and password in the request body
• Returns structured JSON response
• Returns the POD PDF in base64Pdf
• Useful when the DCB waybill number is already known

Retrieves POD documents using the customer's own reference or order number instead of a DCB waybill number. The endpoint searches DCB Online/TMS for matching waybills under the supplied account number or account numbers, then attempts to retrieve the POD for each matching waybill from eDocs.

If the same reference exists on more than one waybill, the endpoint loops through the matching waybills and returns the POD for each waybill where a POD is available. The lookup returns a maximum of 10 matching waybills per account search.

{
  "Username": "string",
  "Password": "string",
  "AccountNumber": "string",
  "AccountNumbers": [
    "string"
  ],
  "ReferenceNumber": "string"
}

• Searches by customer reference or order number
• Supports a single account number using AccountNumber
• Supports multiple account numbers using AccountNumbers
• Finds matching DCB waybill numbers from DCB Online/TMS
• Loops through all matching waybills
• Attempts to retrieve each available POD from eDocs
• Returns each available POD in base64Pdf
• Returns structured results showing POD found, no POD available or empty POD document

Retrieves multiple POD documents from eDocs using a supplied list of DCB waybill numbers. The endpoint logs into eDocs once, loops through each waybill number, retrieves each available POD PDF, places the PDFs into a ZIP file, and returns the ZIP as a Base64 string.

This endpoint is designed for customers who already have the DCB waybill numbers and need to download multiple PODs in one request. A maximum of 50 waybill numbers can be supplied per request to keep the response size manageable.

{
  "Username": "string",
  "Password": "string",
  "Waybills": [
    "string"
  ]
}

• Accepts up to 50 waybill numbers per request
• Logs into eDocs once using the supplied username and password
• Loops through each supplied waybill number
• Retrieves each available POD PDF from eDocs
• Packages all available POD PDFs into one ZIP file
• Returns the ZIP file as base64Zip
• Includes a status text file inside the ZIP showing which PODs were found or not found

Deletes an imported waybill from FreightWare and then marks the matching waybill as deleted in DCB Online/TMS if the waybill exists locally. FreightWare controls the status validation and will only allow deletion when the waybill status is still Imported.

If FreightWare rejects the deletion, DCB Online/TMS will not be updated. If FreightWare deletion succeeds but the waybill does not exist in DCB Online/TMS, the local update is skipped and the API still returns a successful FreightWare deletion response.

{
  "Username": "string",
  "Password": "string",
  "Waybill": "string",
  "DeleteReason": "string"
}

{
  "Username": "User",
  "Password": "Pass",
  "Waybill": "DCB000123456",
  "DeleteReason": "Customer cancelled request"
}

{
  "success": true,
  "message": "Waybill deleted successfully on FreightWare.",
  "waybill": "DCB000123456",
  "freightWareDeleted": true,
  "dcbOnlineUpdated": true,
  "dcbOnlineStatus": "Updated on DCB Online."
}

• Deletes imported waybills using FreightWareli>
• Encrypts the supplied FreightWare username and password before calling FreightWare
• Requires a freeform deletion reason using DeleteReason
• FreightWare only allows deletion if the waybill status is Imported
• Only updates DCB Online/TMS after FreightWare confirms deletion
• Skips the DCB Online/TMS update if the waybill does not exist locally