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:
- UpdateShipment in the goods owner SOAP API.
- UpdateShipment in the automation API (the function described on this page).
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 />
</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 | 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. | |
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. |
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 | Ongoing WMS internal shipment id of the shipment. |