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, AutomationUpdateOrder, UpdateOrderWaybill, UpdateOrderTransporterOrderNumber, UpdateOrderTransporterFreightWeight, UpdateOrderFreightPrice, UpdateOrderInvoiceUrl, UpdateOrderComment, UpdateOrderStatus, UpdateOrderTransporterContract, UpdateOrderWarehouseInstruction, UpdateOrderReturnWaybill, UpdateOrderInvoiceTypeCode, UpdateOrderTermsOfDeliveryType, UpdateOrderServicePointCode, UpdateOrderWayOfDeliveryType, UpdateOrderSetTransportPrinted, UpdatePreparedTransportDocumentId, UpdateOrderSortLocation, UpdateOrderClasses, UpdateOrderShippedTime, UpdateOrderAutomationClearPersonallyIdentifiableInformation, TransporterContractClass, UpdateOrderTracking, OrderClasses, OrderClass, UpdateOrderResponse, AutomationUpdateOrderResult

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 or FiltersSpecified</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>
            <EDICustomerCode>string</EDICustomerCode>
            <WaybillTemplate>string</WaybillTemplate>
          </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>
        <UpdateOrderSortLocation>
          <OrderSortLocation>string</OrderSortLocation>
        </UpdateOrderSortLocation>
        <UpdateOrderSetOrderClasses>
          <OrderClasses>
            <Operation>FindOrCreate or Find</Operation>
            <Identification>Code</Identification>
            <Classes>
              <Class>
                <Name>string</Name>
                <Code>string</Code>
                <Comment>string</Comment>
                <IsPalletTypeSuggestion>boolean</IsPalletTypeSuggestion>
              </Class>
              <Class>
                <Name>string</Name>
                <Code>string</Code>
                <Comment>string</Comment>
                <IsPalletTypeSuggestion>boolean</IsPalletTypeSuggestion>
              </Class>
            </Classes>
          </OrderClasses>
        </UpdateOrderSetOrderClasses>
        <UpdateOrderAddOrderClasses>
          <OrderClasses>
            <Operation>FindOrCreate or Find</Operation>
            <Identification>Code</Identification>
            <Classes>
              <Class>
                <Name>string</Name>
                <Code>string</Code>
                <Comment>string</Comment>
                <IsPalletTypeSuggestion>boolean</IsPalletTypeSuggestion>
              </Class>
              <Class>
                <Name>string</Name>
                <Code>string</Code>
                <Comment>string</Comment>
                <IsPalletTypeSuggestion>boolean</IsPalletTypeSuggestion>
              </Class>
            </Classes>
          </OrderClasses>
        </UpdateOrderAddOrderClasses>
        <UpdateOrderShippedTime>
          <ShippedTime>dateTime</ShippedTime>
        </UpdateOrderShippedTime>
        <UpdateOrderClearPersonallyIdentifiableInformation>
          <Operation>Clear</Operation>
        </UpdateOrderClearPersonallyIdentifiableInformation>
      </Order>
    </UpdateOrder>
  </soap:Body>
</soap:Envelope>

Request specification

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

Response specification