AddShipmentResponse

Response returned after creating a shipment

shipmentReferencestringnullable

Shipment reference, a unique id in Swipload

Example: FERS2794

externalShipmentIdstringnullable

The external shipment identifier you provided in the request

Example: SH-2024-001

freightResponses object[]nullable

Responses for each freight added to the shipment

Array [

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

]

]

AddShipmentResponse

{
  "shipmentReference": "FERS2794",
  "externalShipmentId": "SH-2024-001",
  "freightResponses": [
    {
      "externalId": "a62f7d2b-2ddf-4c1c-9a93-98c39f05f382",
      "reference": "DPOS4972",
      "status": "Draft",
      "documentBase64Results": [
        {
          "fileName": "delivery_note.pdf",
          "success": true,
          "errorMessage": "string"
        }
      ]
    }
  ]
}