Skip to main content

AddFreightResponse

Response returned after adding a freight to a shipment

externalIdstringnullable

Unique freight id in source system

Example: a62f7d2b-2ddf-4c1c-9a93-98c39f05f382
referencestringnullable

The Swipref, a unique id in Swipload

Example: DPOS4972
statusFreightStatusCode (string)

Freight status id enum.

Possible values: [Draft, PendingApproval, Open, InTransit, Delivered, Deleted, PendingDetails, PendingPickup, Cancelled]

documentBase64Results object[]nullable

Results of any document uploads included with the freight

  • Array [
    • fileNamestringnullable

    Name of the uploaded file

    Example: delivery_note.pdf
    successboolean

    Whether the upload was successful

    Example: true
    errorMessagestringnullable

    Error message if the upload failed, null on success

  • ]
    • AddFreightResponse
    {
      "externalId": "a62f7d2b-2ddf-4c1c-9a93-98c39f05f382",
      "reference": "DPOS4972",
      "status": "Draft",
      "documentBase64Results": [
        {
          "fileName": "delivery_note.pdf",
          "success": true,
          "errorMessage": "string"
        }
      ]
    }