Ongoing Warehouse logo
Ongoing Warehouse Developer

UpdateShipment (automation API)

This function allows you to update a shipment.

Note that the goods owner SOAP API contains a function with the exact same name. So we have:

  1. UpdateShipment in the goods owner SOAP API.
  2. UpdateShipment in the automation API (the function described on this page).
These two functions are very similar. However, the UpdateShipment function in the automation API (the function described in this page) allows you to update any order regardless of which goods owner the order belongs to.

Tags: UpdateShipment, updateShipment, UpdateShipmentResult

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/UpdateShipment"

<?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>
      <UpdateShipment xmlns="http://ongoingsystems.se/Automation">
         <UserName>string</UserName>
         <Password>string</Password>
         <updateShipment>
            <ShipmentUpdateIdentification>
               <ShipmentIdentificationType>WayBill or ShipmentOrderNumber or ShipmentId</ShipmentIdentificationType>
               <WayBill>long</WayBill>
               <ShipmentOrderNumber>string</ShipmentOrderNumber>
               <ShipmentId>int</ShipmentId>
            </ShipmentUpdateIdentification>
            <UpdateShipmentComment>
               <ShipmentComment>string</ShipmentComment>
            </UpdateShipmentComment>
            <UpdateShipmentCustomsReferenceNumber>
               <CustomsReferenceNumber>string</CustomsReferenceNumber>
            </UpdateShipmentCustomsReferenceNumber>
            <UnlockInboundArticleItemsOperation>
               <Unlock>boolean</Unlock>
            </UnlockInboundArticleItemsOperation>
            <UpdateShipmentSetCustomsStatusApproved />
         </updateShipment>
      </UpdateShipment>
   </soap:Body>
</soap:Envelope>
+

Request specification

UpdateShipment
UserName str(50) Req. Your username
Password str(50) Req. Your password
updateShipment object Req. An element updateShipment.
updateShipment
ShipmentUpdateIdentification object Req.
> ShipmentIdentificationType enum Req. Determines how you want the system to identify the shipment. Must be one of these values:
- WayBill
- ShipmentOrderNumber
- ShipmentId
> WayBill int Req.* Waybill number. Required if ShipmentIdentificationType = WayBill.
> ShipmentOrderNumber str Req.* Shipment order number. Required if ShipmentIdentificationType = ShipmentOrderNumber.
> ShipmentId int Req.* Ongoing id (SystemId) of the shipment. Required if ShipmentIdentificationType = ShipmentId .
UpdateShipmentComment object
> ShipmentComment str Req.* The new comment for the shipment.

Response XML

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?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>
      <UpdateShipmentResponse xmlns="http://ongoingsystems.se/Automation">
         <UpdateShipmentResult>
            <Success>boolean</Success>
            <Message>string</Message>
            <ShipmentId>int</ShipmentId>
         </UpdateShipmentResult>
      </UpdateShipmentResponse>
   </soap:Body>
</soap:Envelope>
+

Response specification

UpdateShipmentResult
Success bool True if successful, false otherwise.
Message str(*) Error message, if the call was unsuccessful.
ShipmentId int The internal Ongoing shipment id of the shipment.