UploadShipmentFile (automation API)

This function allows you to attach files to shipments.

A possible use-case for this is if there are documents which you want the warehouse to print and send along with an consolidated shipment. You can use this function to attach the documents to the shipment. The warehouse can then print the documents when required.

Tags: UploadShipmentFile, ShipmentFile, File, UploadShipmentFileResponse, AutomationUploadShipmentFileResult

Request XML

POST /xxx/Automation.asmx HTTP/1.1
Host: api.ongoingsystems.se
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ongoingsystems.se/Automation/UploadShipmentFile"

<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <UploadShipmentFile xmlns="http://ongoingsystems.se/Automation">
      <UserName>string</UserName>
      <Password>string</Password>
      <ShipmentFile>
        <File>
          <FileName>string</FileName>
          <FileBytes>base64Binary</FileBytes>
          <MimeType>string</MimeType>
          <FileId>int</FileId>
          <FileWillBeDeletedAt>dateTime</FileWillBeDeletedAt>
        </File>
        <ShipmentId>int</ShipmentId>
      </ShipmentFile>
    </UploadShipmentFile>
  </soap:Body>
</soap:Envelope>

Request specification

UploadShipmentFile
UserName string(50) Req. Your username
Password string(50) Req. Your password
ShipmentFile ShipmentFile Req.
ShipmentFile
File File An element of type File.
ShipmentId int Ongoing WMS internal shipment id.
File
FileName string(300) The filename.
FileBytes base64Binary The contents of the file, encoded using Base64.
MimeType string(50) The MIME type of the file, specifying what kind of file it is.
FileId int Should always be -1.
FileWillBeDeletedAt dateTime The date when the file will be deleted (may be null).

Response XML

<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <UploadShipmentFileResponse xmlns="http://ongoingsystems.se/Automation">
      <UploadShipmentFileResult>
        <Success>boolean</Success>
        <Message>string</Message>
        <ShipmentId>int</ShipmentId>
        <FileId>int</FileId>
      </UploadShipmentFileResult>
    </UploadShipmentFileResponse>
  </soap:Body>
</soap:Envelope>

Response specification

UploadShipmentFileResponse
UploadShipmentFileResult AutomationUploadShipmentFileResult
AutomationUploadShipmentFileResult
Success boolean true if successful, false otherwise.
Message string Error message, if the call was unsuccessful.
ShipmentId int Ongoing WMS internal id of the shipment.
FileId int Ongoing WMS internal id of the file.