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, UpdateOrderRemoveFromPickOrder, UpdateOrderCustomerAndNotification, TransporterContractClass, UpdateOrderTracking, OrderClasses, Customer, OrderNotification, OrderClass, Coordinates, InvoiceAddress, CustomerGroup, AddressClasses, CustomerAdvanced, CustomerClasses, AddressClassClass, CustomerTransportContract, CustomerClass, 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>
            <Operation>Create or ClearAndCreate</Operation>
          </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>
        <UpdateOrderRemoveFromPickOrder>
          <Operation>RemoveAllOrderLinesFromPickOrder</Operation>
        </UpdateOrderRemoveFromPickOrder>
        <UpdateOrderCustomerAndNotification>
          <Customer>
            <CustomerOperation>Create or CreateOrUpdate or CreateNotUpdate or Find</CustomerOperation>
            <CustomerIdentification>ExternalCustomerCode or SystemId or CustomerNumber or FullNameAndAddress</CustomerIdentification>
            <ExternalCustomerCode>string</ExternalCustomerCode>
            <CustomerNumber>string</CustomerNumber>
            <CustomerId>int</CustomerId>
            <DeliveryAddressId>int</DeliveryAddressId>
            <InvoiceAddressId>int</InvoiceAddressId>
            <Coordinates>
              <Longitude>decimal</Longitude>
              <Latitude>decimal</Latitude>
            </Coordinates>
            <Name>string</Name>
            <Address>string</Address>
            <Address2>string</Address2>
            <Address3>string</Address3>
            <PostCode>string</PostCode>
            <City>string</City>
            <TelePhone>string</TelePhone>
            <Remark>string</Remark>
            <Email>string</Email>
            <MobilePhone>string</MobilePhone>
            <CountryCode>string</CountryCode>
            <CountryStateCode>string</CountryStateCode>
            <DeliveryInstruction>string</DeliveryInstruction>
            <IsVisible>boolean</IsVisible>
            <NotifyBySMS>boolean</NotifyBySMS>
            <NotifyByEmail>boolean</NotifyByEmail>
            <NotifyByTelephone>boolean</NotifyByTelephone>
            <InvoiceAddress>
              <Coordinates>
                <Longitude>decimal</Longitude>
                <Latitude>decimal</Latitude>
              </Coordinates>
              <Name>string</Name>
              <Address>string</Address>
              <Address2>string</Address2>
              <Address3>string</Address3>
              <PostCode>string</PostCode>
              <City>string</City>
              <TelePhone>string</TelePhone>
              <Remark>string</Remark>
              <Email>string</Email>
              <MobilePhone>string</MobilePhone>
              <CountryStateCode>string</CountryStateCode>
              <CountryCode>string</CountryCode>
              <DeliveryInstruction>string</DeliveryInstruction>
              <IsVisible>boolean</IsVisible>
              <NotifyBySMS>boolean</NotifyBySMS>
              <NotifyByEmail>boolean</NotifyByEmail>
              <NotifyByTelephone>boolean</NotifyByTelephone>
              <AddressClasses>
                <Operation>FindOrCreate or Find</Operation>
                <Identification>Code</Identification>
                <AssignAddressClassMode>NoAssign or Add or Set</AssignAddressClassMode>
                <Classes>
                  <Class>
                    <Name>string</Name>
                    <Code>string</Code>
                    <Comment>string</Comment>
                  </Class>
                  <Class>
                    <Name>string</Name>
                    <Code>string</Code>
                    <Comment>string</Comment>
                  </Class>
                </Classes>
              </AddressClasses>
            </InvoiceAddress>
            <CustomerGroup>
              <CustomerGroupOperation>Find or CreateOrFind</CustomerGroupOperation>
              <CustomerGroupIdentification>CustomerGroupCode or CustomerGroupName</CustomerGroupIdentification>
              <CustomerGroupCode>string</CustomerGroupCode>
              <CustomerGroupName>string</CustomerGroupName>
            </CustomerGroup>
            <OrganisationNumber>string</OrganisationNumber>
            <VATNumber>string</VATNumber>
            <DoorCode>string</DoorCode>
            <AddressFreeText1>string</AddressFreeText1>
            <AddressFreeText2>string</AddressFreeText2>
            <AddressClasses>
              <Operation>FindOrCreate or Find</Operation>
              <Identification>Code</Identification>
              <AssignAddressClassMode>NoAssign or Add or Set</AssignAddressClassMode>
              <Classes>
                <Class>
                  <Name>string</Name>
                  <Code>string</Code>
                  <Comment>string</Comment>
                </Class>
                <Class>
                  <Name>string</Name>
                  <Code>string</Code>
                  <Comment>string</Comment>
                </Class>
              </Classes>
            </AddressClasses>
            <Advanced>
              <CustomerTransportContracts>
                <CustomerTransportContract>
                  <TransporterCode>string</TransporterCode>
                  <CustomerNumber>string</CustomerNumber>
                  <PalletRegistrationNumber>string</PalletRegistrationNumber>
                </CustomerTransportContract>
                <CustomerTransportContract>
                  <TransporterCode>string</TransporterCode>
                  <CustomerNumber>string</CustomerNumber>
                  <PalletRegistrationNumber>string</PalletRegistrationNumber>
                </CustomerTransportContract>
              </CustomerTransportContracts>
            </Advanced>
            <CustomerClasses>
              <Operation>FindOrCreate or Find</Operation>
              <Identification>Code</Identification>
              <AssignCustomerClassMode>NoAssign or Add or Set</AssignCustomerClassMode>
              <Classes>
                <Class>
                  <Name>string</Name>
                  <Code>string</Code>
                  <Comment>string</Comment>
                </Class>
                <Class>
                  <Name>string</Name>
                  <Code>string</Code>
                  <Comment>string</Comment>
                </Class>
              </Classes>
            </CustomerClasses>
          </Customer>
          <OrderNotification>
            <Telephone>string</Telephone>
            <MobilePhone>string</MobilePhone>
            <Email>string</Email>
            <NotifyByEmail>boolean</NotifyByEmail>
            <NotifyBySms>boolean</NotifyBySms>
            <NotifyByTelephone>boolean</NotifyByTelephone>
          </OrderNotification>
        </UpdateOrderCustomerAndNotification>
      </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