Ongoing WMS logo

Ongoing WMS Developer

UpdateShipment

This function allows you to update a shipment.

Note: The word "shipment" here refers to Ongoing WMS' own concept of a shipment, which is a way of organizing outbound and inbound deliveries. It has no relation to the "shipments" which a carrier (such as DHL or UPS) deals with. The vast majority of warehouses do not use Ongoing WMS' own shipment functionality, and therefore most integrations will not need to use this function.

Tags: UpdateShipment, updateShipment, UpdateShipmentResult

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/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/WSI">
      <GoodsOwnerCode>string</GoodsOwnerCode>
      <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>
        <UpdateShipmentWaybill>
          <Waybill>long</Waybill>
        </UpdateShipmentWaybill>
        <UpdateShipmentCustomsReferenceNumber>
           <CustomsReferenceNumber>string</CustomsReferenceNumber>
        </UpdateShipmentCustomsReferenceNumber>
        <UnlockInboundArticleItemsOperation>
           <Unlock>boolean</Unlock>
        </UnlockInboundArticleItemsOperation>
        <UpdateShipmentSetCustomsStatusApproved />
        <UpdateShipmentSetCustomsStatusFetchedByCustomsSystem />
        <UpdateShipmentSetCustomsStatusRejectedByCustomsSystem />
        <UpdateShipmentStatus>
            <ShipmentStatus>int</ShipmentStatus>
        </UpdateShipmentStatus>
      </updateShipment>
    </UpdateShipment>
  </soap:Body>
</soap:Envelope>
+

Request specification

UpdateShipment
UserName str(50) Req. Your username
Password str(50) Req. Your password
GoodsOwnerCode str(400) Req. The name/code of your client
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 Waybill number. Required if ShipmentIdentificationType = WayBill.
ShipmentOrderNumber str Shipment order number. Required if ShipmentIdentificationType = ShipmentOrderNumber.
ShipmentId int Ongoing WMS internal id (SystemId) of the shipment. Required if ShipmentIdentificationType = ShipmentId .
UpdateShipmentComment object
> ShipmentComment str The new comment for the shipment.
UpdateShipmentWaybill object
> Waybill long The new waybill for the shipment.
UpdateShipmentCustomsReferenceNumber object
> CustomsReferenceNumber str The new reference number for the shipment.
UnlockInboundArticleItemsOperation object
> Unlock bool True to unlock all items on the shipment.
UpdateShipmentSetCustomsStatusApproved object If you send in this object, then the shipment status will be set to Approved.
UpdateShipmentSetCustomsStatusFetchedByCustomsSystem object If you send in this object, then the shipment status will be set to Fetched by customs system.
UpdateShipmentSetCustomsStatusRejectedByCustomsSystem object If you send in this object, then the shipment status will be set to Rejected by customs system.
UpdateShipmentStatus object
> ShipmentStatus int The id of the status the shipment should receive

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/WSI">
      <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 WMS shipment id of the shipment.