DCB Logistics REST API Platform

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

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

• FreightWare session token
• Authentication status
• Error message if authentication fails

Creates the operational waybill inside FreightWare using shipment header information, consignee and consignor details, service type, references, parcels, dimensions and weights.

• Creating FreightWare waybills
• Submitting parcel and dimension information
• Returning the FreightWare create result

Saves a DCB Online/TMS waybill as a draft. This endpoint stores the shipment internally but does not finalise it and does not push the waybill into FreightWare.

• Draft shipment creation
• Destination delivery site creation or linking
• Parcel line saving
• Invoice reference saving
• Transactional SQL rollback protection

Finalises a DCB Online/TMS waybill. It uses the same payload structure as DCBOnlineWaybillSave, but saves the waybill as finalised and creates the operational waybill in FreightWare.

• Saving finalised DCB Online/TMS waybills
• Creating the operational FreightWare waybill
• Saving parcel and invoice data
• Rolling back if the finalisation fails

Retrieves advanced tracking information from FreightWare including waybill details, consignor and consignee details, parcel data, financial status, tracking events and POD visibility where available.

• Detailed tracking history
• Manifest and hub movement visibility
• Parcel-level tracking information
• Delivery progress and POD status

Public shipment tracking endpoint used by customers, websites and external systems to retrieve tracking status using a waybill number without authentication.

• Public waybill tracking
• Customer-facing tracking pages
• Tracking milestone visibility

Returns a FreightWare quick quote estimate based on account, service type, origin, destination, consignment type, parcel quantities, dimensions and mass.

Quotation values are estimates and remain subject to final operational validation, actual dimensions, mass and applicable sundries.

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

• Temporary secure label link
• Browser-accessible label rendering
• PDF/RDLC label output

Retrieves an archived POD document from eDocs using the supplied waybill number. The endpoint logs into eDocs with the supplied credentials and returns the POD PDF as Base64.

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

• Structured JSON response
• PDF file name
• Content type application/pdf
• POD document in base64Pdf

Retrieves multiple archived POD documents from eDocs using a list of waybill numbers. The API logs into eDocs once, loops through each supplied waybill, retrieves each available POD PDF, places all available PODs into one ZIP file and returns the ZIP as Base64.

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

• One ZIP file returned as base64Zip
• Each available POD is included as a PDF inside the ZIP
• Includes a POD_Lookup_Status.txt file inside the ZIP
• Maximum 50 waybills per request
• Returns total waybills requested, PODs found and PODs not found or failed

Retrieves POD documents using the customer's own reference or order number instead of a DCB waybill number. The API searches one or more account numbers, finds matching DCB waybills and attempts to retrieve the POD for each matched waybill.

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

• All matching waybill results, maximum 10 per account search
• POD status for each matched waybill
• Available PODs as base64Pdf
• Account number, waybill number and customer reference details

Deletes an imported waybill from FreightWare. FreightWare controls the status validation and will only allow deletion if the waybill status is still Imported. Once FreightWare confirms the deletion, the API marks the waybill as deleted in DCB Online/TMS if it exists locally.

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

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

• FreightWare deletion status
• FreightWare validation or general error if deletion fails
• DCB Online/TMS update status
• Skips DCB Online/TMS update if the waybill does not exist locally
• Only updates DCB Online/TMS after FreightWare confirms deletion

Resolves suburb, postal code, city, route code and hub information used for address validation, route resolution and logistics processing.

• Suburb and postal code validation
• Route and hub lookup
• Address validation before waybill creation