Skip to main content

FreightStatusUpdateRequest

Request to update the status of a freight

referencestringrequired

The Swipref, a unique id in Swipload

Possible values: non-empty

Example: OXCQ134
statusIdExternalUpdateFreightStatusCode (string)required

Enum for Freight statuses that can be updated by external systems.

Possible values: [InTransit, Delivered, Cancelled]

timeStampstring<date-time>

Timestamp of status change

Example: 2024-08-22T13:00Z
signeestringnullable

Name of person signing for pickup/delivery (Optional)

Example: John Doe
commentstringnullable

Comment (Optional)

Example: www.trackingurl.com
co2number<double>nullable

Total CO2 in grams (Optional)

Example: 7600
distancenumber<double>nullable

Distance in Km (Optional)

Example: 300.5
documentData object

A document encoded in Base64 for upload

fileNamestringnullable

Name of the file including extension

Example: delivery_note.pdf
fileContentTypestringnullable

MIME content type of the file. If omitted, it will be inferred from the file extension.

Example: application/pdf
fileContentBase64stringnullable

File content encoded as a Base64 string. Do not include the Data URI prefix (e.g. "data:image/png;base64,").

Example: JVBERi0xLjQKJcOkw7zDtsOf...
documentURLstringnullable

URL to external document (Optional)

Example: https://example.com/documents/pod_12345.pdf
FreightStatusUpdateRequest
{
  "reference": "OXCQ134",
  "statusId": "InTransit",
  "timeStamp": "2024-08-22T13:00Z",
  "signee": "John Doe",
  "comment": "www.trackingurl.com",
  "co2": 7600,
  "distance": 300.5,
  "documentData": {
    "fileName": "delivery_note.pdf",
    "fileContentType": "application/pdf",
    "fileContentBase64": "JVBERi0xLjQKJcOkw7zDtsOf..."
  },
  "documentURL": "https://example.com/documents/pod_12345.pdf"
}