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, ShipmentUpdateIdentification, UpdateShipmentComment, UpdateShipmentCustomsReferenceNumber, UnlockInboundArticleItemsOperation, UpdateShipmentStatus, UpdateShipmentWaybill, UpdateShipmentResponse, 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 />
        <UpdateShipmentSetCustomsStatusFetchedByCustomsSystem />
        <UpdateShipmentSetCustomsStatusRejectedByCustomsSystem />
        <UpdateShipmentStatus>
          <ShipmentStatus>int</ShipmentStatus>
        </UpdateShipmentStatus>
        <UpdateShipmentWaybill>
          <Waybill>long</Waybill>
        </UpdateShipmentWaybill>
      </updateShipment>
    </UpdateShipment>
  </soap:Body>
</soap:Envelope>

Request specification

UpdateShipment
UserName string(50) Req. Your username
Password string(50) Req. Your password
updateShipment UpdateShipment Req. An element updateShipment.
UpdateShipment
ShipmentUpdateIdentification ShipmentUpdateIdentification Contains information about how to identify the shipment
UpdateShipmentComment UpdateShipmentComment The new comment for the shipment.
UpdateShipmentCustomsReferenceNumber UpdateShipmentCustomsReferenceNumber The new reference number for the shipment.
UnlockInboundArticleItemsOperation UnlockInboundArticleItemsOperation If you want to unlock all article items on the shipment.
UpdateShipmentSetCustomsStatusApproved UpdateShipmentSetCustomsStatusApproved If you send in this object, then the shipment status will be set to Approved.
UpdateShipmentSetCustomsStatusFetchedByCustomsSystem UpdateShipmentSetCustomsStatusFetchedByCustomsSystem If you send in this object, then the shipment status will be set to Fetched by customs system.
UpdateShipmentSetCustomsStatusRejectedByCustomsSystem UpdateShipmentSetCustomsStatusRejectedByCustomsSystem If you send in this object, then the shipment status will be set to Rejected by customs system.
UpdateShipmentStatus UpdateShipmentStatus Used to update the status of the shipment.
UpdateShipmentWaybill UpdateShipmentWaybill Used to update the waybill of the shipment
ShipmentUpdateIdentification
ShipmentIdentificationType enum Determines how you want the system to identify the shipment. Must be one of these values:
WayBill long Waybill number. Required if ShipmentIdentificationType = WayBill.
ShipmentOrderNumber string Shipment order number. Required if ShipmentIdentificationType = ShipmentOrderNumber.
ShipmentId int Ongoing WMS internal id (SystemId) of the shipment. Required if ShipmentIdentificationType = ShipmentId .
UpdateShipmentComment
ShipmentComment string The new comment for the shipment.
UpdateShipmentCustomsReferenceNumber
CustomsReferenceNumber string The new reference number for the shipment.
UnlockInboundArticleItemsOperation
Unlock boolean True to unlock all items on the shipment.
UpdateShipmentStatus
ShipmentStatus int The id of the status the shipment should receive
UpdateShipmentWaybill
Waybill long The new waybill for the shipment.

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

Response specification

UpdateShipmentResponse
UpdateShipmentResult UpdateShipmentResult
UpdateShipmentResult
Success boolean True if successful, false otherwise.
Message string Error message, if the call was unsuccessful.
ShipmentId int The internal Ongoing WMS shipment id of the shipment.