Ongoing WMS logo

Ongoing WMS Developer

UpdateOrder (automation API)

This function allows you to update certain fields on orders.

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

  1. UpdateOrder in the goods owner SOAP API.
  2. UpdateOrder in the automation API (the function described on this page).
These two functions are very similar. However, the UpdateOrders 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: UpdateOrder, UpdateOrderResult

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

<?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>
      <UpdateOrder xmlns="http://ongoingsystems.se/Automation">
         <UserName>string</UserName>
         <Password>string</Password>
         <Order>
            <OrderId>int</OrderId>
            <UpdateOrderWaybill>
               <Waybill>string</Waybill>
            </UpdateOrderWaybill>
            <UpdateOrderTransporterOrderNumber>
               <TransporterOrderNumber>string</TransporterOrderNumber>
            </UpdateOrderTransporterOrderNumber>
            <UpdateOrderTransporterFreightWeight>
               <TransporterFreightWeight>decimal</TransporterFreightWeight>
            </UpdateOrderTransporterFreightWeight>
            <UpdateOrderFreightPrice>
               <FreightPrice>decimal</FreightPrice>
            </UpdateOrderFreightPrice>
            <UpdateOrderInvoiceUrl>
               <InvoiceUrl>string</InvoiceUrl>
            </UpdateOrderInvoiceUrl>
            <UpdateOrderComment>
               <Comment>string</Comment>
            </UpdateOrderComment>
            <UpdateOrderStatus>
               <OrderStatus>int</OrderStatus>
            </UpdateOrderStatus>
            <UpdateOrderTransporterContract>
               <TransporterContract>
                  <TransporterContractIdentification>CodeAndServiceCodeAndCustomerNumber or CodeAndServiceCode or Code or ServiceCode</TransporterContractIdentification>
                  <TransporterContractOperation>Find or CreateOrUpdate</TransporterContractOperation>
                  <TransportPayment>Collect or Prepaid or ThirdParty or UnKnown</TransportPayment>
                  <TransporterCode>string</TransporterCode>
                  <TransporterServiceCode>string</TransporterServiceCode>
                  <CustomerNumber>string</CustomerNumber>
                  <ConsigneePalletCustomerNumber>string</ConsigneePalletCustomerNumber>
               </TransporterContract>
            </UpdateOrderTransporterContract>
            <UpdateOrderWarehouseInstruction>
               <WarehouseInstruction>string</WarehouseInstruction>
            </UpdateOrderWarehouseInstruction>
            <UpdateOrderReturnWaybill>
               <ReturnWaybill>string</ReturnWaybill>
            </UpdateOrderReturnWaybill>
            <UpdateOrderInvoiceTypeCode>
               <InvoiceTypeCode>string</InvoiceTypeCode>
            </UpdateOrderInvoiceTypeCode>
            <UpdateOrderTermsOfDeliveryType>
               <Operation>Find or FindOrCreate</Operation>
               <Identification>TermsOfDeliveryTypeCode</Identification>
               <TermsOfDeliveryTypeCode>string</TermsOfDeliveryTypeCode>
               <TermsOfDeliveryTypeName>string</TermsOfDeliveryTypeName>
            </UpdateOrderTermsOfDeliveryType>
            <UpdateOrderServicePointCode>
               <ServicePointCode>string</ServicePointCode>
            </UpdateOrderServicePointCode>
            <UpdateOrderWayOfDeliveryType>
               <Operation>Find or FindOrCreate</Operation>
               <Identification>WayOfDeliveryTypeCode</Identification>
               <WayOfDeliveryTypeCode>string</WayOfDeliveryTypeCode>
               <WayOfDeliveryTypeName>string</WayOfDeliveryTypeName>
            </UpdateOrderWayOfDeliveryType>
            <SetTransportPrinted>
               <Tracking>
                  <Url>string</Url>
                  <Waybill>string</Waybill>
               </Tracking>
            </SetTransportPrinted>
            <UpdatePreparedTransportDocumentId>
              <PreparedTransportDocumentId>string</PreparedTransportDocumentId>
            </UpdatePreparedTransportDocumentId>
         </Order>
      </UpdateOrder>
   </soap:Body>
</soap:Envelope>
+

Request specification

UpdateOrder
UserName str(50) Req. Your username.
Password str(50) Req. Your password.
OrderId int Req. The order id of the order which you want to update
UpdateOrderWaybill object
> Waybill str(50) The new waybill of the order.
UpdateOrderTransporterOrderNumber object
> UpdateOrderTransporterOrderNumber str(150) The new transporter order number of the order.
UpdateOrderTransporterFreightWeight object
> TransporterFreightWeight dec The new freight weight of the order.
UpdateOrderTransporterFreightPrice object
> TransporterFreightPrice dec The new freight price of the order.
UpdateOrderInvoiceUrl object
> InvoiceUrl str(200) The new invoice URL of the order.
UpdateOrderComment object
> Comment str(500) The new order comment.
UpdateOrderStatus object
> OrderStatus int The new order status.
UpdateOrderTransporterContract object
> TransporterContractIdentification enum Req. Defines what you want to identify the transporter contract by:
 - CodeAndServiceCodeAndCustomerNumber
 - CodeAndServiceCode
 - Code
 - ServiceCode
Most integrations will use CodeAndServiceCode
> TransporterContractOperation enum Req. Defines the operation:
 - Find
 - CreateOrUpdate
Most integrations will use Find
> TransportPayment enum Req. Defines who will pay for the transport:
 - Collect
 - Prepaid
 - ThirdParty
 - UnKnown
Most integrations will use Prepaid
> TransporterCode str(50) Transporter code. See GetTransporterContracts for available codes. Required if TransporterContractIdentification = CodeAndServiceCodeAndCustomerNumber, CodeAndServiceCode or Code
> TransporterServiceCode str(50) Transporter service code. See GetTransporterContracts for available codes. Required if TransporterContractIdentification = CodeAndServiceCodeAndCustomerNumber, CodeAndServiceCode or ServiceCode
> CustomerNumber str(50) Customer number at the transporter. Usually not needed if TransportPayment = PrePaid
> ConsigneePalletCustomerNumber str(50) Pallet reg number
UpdateOrderWarehouseInstruction object
> WarehouseInstruction str(500) The new warehouse instruction for the order.
UpdateOrderReturnWaybill object
> ReturnWaybill str(50) The new return waybill of the order.
UpdateOrderInvoiceTypeCode object
> InvoiceTypeCode str(50) The new invoice type code of the order.
UpdateOrderTermsOfDeliveryType object
> Operation enum Find or FindOrCreate.
> Identification enum Must be the fixed value TermsOfDeliveryTypeCode.
> TermsOfDeliveryTypeCode str(50) The code of the terms of delivery.
> TermsOfDeliveryTypeName str(100) The name of the terms of delivery.
UpdateOrderServicePointCode object
> ServicePointCode str(50) The new return service point code of the order.
UpdateOrderWayOfDeliveryType object
> Operation enum Find or FindOrCreate.
> Identification enum Fixed value WayOfDeliveryTypeCode.
> WayOfDeliveryTypeCode str(300) The code of the way of delivery type.
> WayOfDeliveryTypeName str(100) The name of the way of delivery type.
SetTransportPrinted object Note that inclusion of this (even if empty) will create a transport status event indicating that transport labels have been printed, which may affect other integrations.
> Tracking object
>> Waybill str(50) Waybill for order
>> Url str(300) Tracking URL for order
UpdatePreparedTransportDocumentId object
> PreparedTransportDocumentId str(100) The new prepared transport document id of the order.

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>
      <UpdateOrderResponse xmlns="http://ongoingsystems.se/Automation">
         <UpdateOrderResult>
            <Success>boolean</Success>
            <Message>string</Message>
            <OrderId>int</OrderId>
         </UpdateOrderResult>
      </UpdateOrderResponse>
   </soap:Body>
</soap:Envelope>
+

Response specification

UpdateOrderResult
Success bool True if successful, false otherwise.
Message str(*) Error message, if the call was unsuccessful.
OrderId int Ongoing WMS internal order id of the order.