FreightPostResponse

Response returned after creating or updating a freight

externalIdstringrequired

Unique freight id in source system

Possible values: non-empty

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

externalShipmentIdstringnullable

Unique shipment id in source system

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

idinteger<int32>

A unique id in Swipload

Example: 8923421

shipmentIdinteger<int32>

Shipment id in Swipload

Example: 53430964

referencestringnullable

The Swipref, a unique id in Swipload

Example: DPOS4972

shipmentReferencestringnullable

Shipment reference, a unique id in Swipload

Example: FERS2794

statusIdFreightStatusCode (string)

Freight status id enum.

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

shippersReferencestringnullable

Literal reference id shown in system and invoice.

Example: MySysRef#405

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

]

FreightPostResponse

{
  "externalId": "a62f7d2b-2ddf-4c1c-9a93-98c39f05f382",
  "externalShipmentId": "a62f7d2b-2ddf-4c1c-9a93-98c39f05f382",
  "id": 8923421,
  "shipmentId": 53430964,
  "reference": "DPOS4972",
  "shipmentReference": "FERS2794",
  "statusId": "Draft",
  "shippersReference": "MySysRef#405",
  "documentBase64Results": [
    {
      "fileName": "delivery_note.pdf",
      "success": true,
      "errorMessage": "string"
    }
  ]
}