UploadShipmentFile

This function allows you to attach files to shipments.

Tags: UploadShipmentFile, UploadShipmentFileOperation, UploadShipmentFileShipmentIdentification, UploadShipmentFile, UploadShipmentFileResponse, UploadShipmentFileResult, UploadShipmentFileResultError, UploadedShipmentFile

Request XML

POST /xxx/Service.asmx HTTP/1.1
Host: api.ongoingsystems.se
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ongoingsystems.se/WSI/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/WSI">
      <GoodsOwnerCode>string</GoodsOwnerCode>
      <UserName>string</UserName>
      <Password>string</Password>
      <Operation>
        <ShipmentIdentification>
          <ShipmentId>int</ShipmentId>
        </ShipmentIdentification>
        <FileIdentification>FileName</FileIdentification>
        <File>
          <FileName>string</FileName>
          <FileBytes>base64Binary</FileBytes>
          <MimeType>string</MimeType>
          <FileWillBeDeletedAt>dateTime</FileWillBeDeletedAt>
        </File>
      </Operation>
    </UploadShipmentFile>
  </soap:Body>
</soap:Envelope>

Request specification

UploadShipmentFile
GoodsOwnerCode string(400) Req. The name/code of your client
UserName string(50) Req. Your username
Password string(50) Req. Your password
Operation UploadShipmentFileOperation Req. The operation object
UploadShipmentFileOperation
ShipmentIdentification UploadShipmentFileShipmentIdentification Req. An element of type UploadShipmentFileShipmentIdentification.
FileIdentification enum Req. Must be fixed string FileName
File UploadShipmentFile Req. An element of type UploadShipmentFile.
UploadShipmentFileShipmentIdentification
ShipmentId int Ongoing WMS internal system id for the shipment which you want to attach a file to.
UploadShipmentFile
FileName string(300) Req. Filename. Note that if you try to attach two files to the same shipment, then the two files must have different filenames. When comparing filenames, the system does a case-insensitive comparison.
FileBytes base64Binary Req. The contents of the file, encoded using Base64.
MimeType string(50) Req. The MIME type of the file, specifying what kind of file it is.
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/WSI">
      <UploadShipmentFileResult>
        <Errors>
          <UploadShipmentFileResultError>
            <Message>string</Message>
            <ErrorType>UnknownError or LogonError or ShipmentNotFound or ErrorUpdating or InvalidIdentification or NoFileSpecified or InvalidFileSpecified</ErrorType>
          </UploadShipmentFileResultError>
          <UploadShipmentFileResultError>
            <Message>string</Message>
            <ErrorType>UnknownError or LogonError or ShipmentNotFound or ErrorUpdating or InvalidIdentification or NoFileSpecified or InvalidFileSpecified</ErrorType>
          </UploadShipmentFileResultError>
        </Errors>
        <UploadedShipmentFile>
          <FileId>int</FileId>
        </UploadedShipmentFile>
        <Success>boolean</Success>
      </UploadShipmentFileResult>
    </UploadShipmentFileResponse>
  </soap:Body>
</soap:Envelope>

Response specification

UploadShipmentFileResponse
UploadShipmentFileResult UploadShipmentFileResult
UploadShipmentFileResult
Errors UploadShipmentFileResultError[]
UploadedShipmentFile UploadedShipmentFile An element of type UploadedShipmentFile.
Success boolean True if successful, false otherwise.
UploadShipmentFileResultError
Message string Message explaining the error.
ErrorType enum An element of type UploadShipmentFileErrorType.
UploadedShipmentFile
FileId int