Orders Web Service

Orders

Click here for a complete list of operations.

GetByID

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /Orders.asmx HTTP/1.1
Host: ws.adido.org.uk
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ws.Orders.adido.org.uk/GetByID"

<?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>
    <GetByID xmlns="http://ws.Orders.adido.org.uk/">
      <Key>string</Key>
      <OrderID>int</OrderID>
    </GetByID>
  </soap:Body>
</soap:Envelope>

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>
    <GetByIDResponse xmlns="http://ws.Orders.adido.org.uk/">
      <GetByIDResult>
        <ID>int</ID>
        <Date>dateTime</Date>
        <Customer>
          <ID>int</ID>
          <Title>string</Title>
          <Firstname>string</Firstname>
          <Lastname>string</Lastname>
          <Email>string</Email>
          <Company>string</Company>
          <Position>string</Position>
        </Customer>
        <BillingAddress>
          <ID>int</ID>
          <Title>string</Title>
          <Firstname>string</Firstname>
          <Lastname>string</Lastname>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <City>string</City>
          <PostCode>string</PostCode>
          <County>string</County>
          <CountryCode>string</CountryCode>
          <PhoneLandline>string</PhoneLandline>
          <PhoneMobile>string</PhoneMobile>
          <Fax>string</Fax>
        </BillingAddress>
        <DeliveryAddress>
          <ID>int</ID>
          <Title>string</Title>
          <Firstname>string</Firstname>
          <Lastname>string</Lastname>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <City>string</City>
          <PostCode>string</PostCode>
          <County>string</County>
          <CountryCode>string</CountryCode>
          <PhoneLandline>string</PhoneLandline>
          <PhoneMobile>string</PhoneMobile>
          <Fax>string</Fax>
        </DeliveryAddress>
        <Items>
          <Item>
            <OrderID>int</OrderID>
            <OrderLineID>int</OrderLineID>
            <ProductID>int</ProductID>
            <ProductName>string</ProductName>
            <ProductRef>string</ProductRef>
            <Qty>int</Qty>
            <ItemPrice>double</ItemPrice>
            <TotalPrice>double</TotalPrice>
            <ItemVAT>double</ItemVAT>
            <TotalVAT>double</TotalVAT>
            <TaxCode>string</TaxCode>
            <TaxRate>double</TaxRate>
            <AuxData>string</AuxData>
          </Item>
          <Item>
            <OrderID>int</OrderID>
            <OrderLineID>int</OrderLineID>
            <ProductID>int</ProductID>
            <ProductName>string</ProductName>
            <ProductRef>string</ProductRef>
            <Qty>int</Qty>
            <ItemPrice>double</ItemPrice>
            <TotalPrice>double</TotalPrice>
            <ItemVAT>double</ItemVAT>
            <TotalVAT>double</TotalVAT>
            <TaxCode>string</TaxCode>
            <TaxRate>double</TaxRate>
            <AuxData>string</AuxData>
          </Item>
        </Items>
        <Notes>
          <Note>
            <ID>int</ID>
            <Date>dateTime</Date>
            <Text>string</Text>
          </Note>
          <Note>
            <ID>int</ID>
            <Date>dateTime</Date>
            <Text>string</Text>
          </Note>
        </Notes>
        <Total>double</Total>
        <CurrencyCode>string</CurrencyCode>
        <CurrencyRate>double</CurrencyRate>
        <Dub3StatusID>int</Dub3StatusID>
        <Dub3StausRating>int</Dub3StausRating>
        <Dub3StatusDetail>string</Dub3StatusDetail>
        <SageVendorTxCode>string</SageVendorTxCode>
        <SageStatusDetail>string</SageStatusDetail>
      </GetByIDResult>
    </GetByIDResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /Orders.asmx HTTP/1.1
Host: ws.adido.org.uk
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetByID xmlns="http://ws.Orders.adido.org.uk/">
      <Key>string</Key>
      <OrderID>int</OrderID>
    </GetByID>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetByIDResponse xmlns="http://ws.Orders.adido.org.uk/">
      <GetByIDResult>
        <ID>int</ID>
        <Date>dateTime</Date>
        <Customer>
          <ID>int</ID>
          <Title>string</Title>
          <Firstname>string</Firstname>
          <Lastname>string</Lastname>
          <Email>string</Email>
          <Company>string</Company>
          <Position>string</Position>
        </Customer>
        <BillingAddress>
          <ID>int</ID>
          <Title>string</Title>
          <Firstname>string</Firstname>
          <Lastname>string</Lastname>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <City>string</City>
          <PostCode>string</PostCode>
          <County>string</County>
          <CountryCode>string</CountryCode>
          <PhoneLandline>string</PhoneLandline>
          <PhoneMobile>string</PhoneMobile>
          <Fax>string</Fax>
        </BillingAddress>
        <DeliveryAddress>
          <ID>int</ID>
          <Title>string</Title>
          <Firstname>string</Firstname>
          <Lastname>string</Lastname>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <City>string</City>
          <PostCode>string</PostCode>
          <County>string</County>
          <CountryCode>string</CountryCode>
          <PhoneLandline>string</PhoneLandline>
          <PhoneMobile>string</PhoneMobile>
          <Fax>string</Fax>
        </DeliveryAddress>
        <Items>
          <Item>
            <OrderID>int</OrderID>
            <OrderLineID>int</OrderLineID>
            <ProductID>int</ProductID>
            <ProductName>string</ProductName>
            <ProductRef>string</ProductRef>
            <Qty>int</Qty>
            <ItemPrice>double</ItemPrice>
            <TotalPrice>double</TotalPrice>
            <ItemVAT>double</ItemVAT>
            <TotalVAT>double</TotalVAT>
            <TaxCode>string</TaxCode>
            <TaxRate>double</TaxRate>
            <AuxData>string</AuxData>
          </Item>
          <Item>
            <OrderID>int</OrderID>
            <OrderLineID>int</OrderLineID>
            <ProductID>int</ProductID>
            <ProductName>string</ProductName>
            <ProductRef>string</ProductRef>
            <Qty>int</Qty>
            <ItemPrice>double</ItemPrice>
            <TotalPrice>double</TotalPrice>
            <ItemVAT>double</ItemVAT>
            <TotalVAT>double</TotalVAT>
            <TaxCode>string</TaxCode>
            <TaxRate>double</TaxRate>
            <AuxData>string</AuxData>
          </Item>
        </Items>
        <Notes>
          <Note>
            <ID>int</ID>
            <Date>dateTime</Date>
            <Text>string</Text>
          </Note>
          <Note>
            <ID>int</ID>
            <Date>dateTime</Date>
            <Text>string</Text>
          </Note>
        </Notes>
        <Total>double</Total>
        <CurrencyCode>string</CurrencyCode>
        <CurrencyRate>double</CurrencyRate>
        <Dub3StatusID>int</Dub3StatusID>
        <Dub3StausRating>int</Dub3StausRating>
        <Dub3StatusDetail>string</Dub3StatusDetail>
        <SageVendorTxCode>string</SageVendorTxCode>
        <SageStatusDetail>string</SageStatusDetail>
      </GetByIDResult>
    </GetByIDResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /Orders.asmx/GetByID?Key=string&OrderID=string HTTP/1.1
Host: ws.adido.org.uk

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<Order xmlns="http://ws.Orders.adido.org.uk/">
  <ID>int</ID>
  <Date>dateTime</Date>
  <Customer>
    <ID>int</ID>
    <Title>string</Title>
    <Firstname>string</Firstname>
    <Lastname>string</Lastname>
    <Email>string</Email>
    <Company>string</Company>
    <Position>string</Position>
  </Customer>
  <BillingAddress>
    <ID>int</ID>
    <Title>string</Title>
    <Firstname>string</Firstname>
    <Lastname>string</Lastname>
    <Address1>string</Address1>
    <Address2>string</Address2>
    <Address3>string</Address3>
    <City>string</City>
    <PostCode>string</PostCode>
    <County>string</County>
    <CountryCode>string</CountryCode>
    <PhoneLandline>string</PhoneLandline>
    <PhoneMobile>string</PhoneMobile>
    <Fax>string</Fax>
  </BillingAddress>
  <DeliveryAddress>
    <ID>int</ID>
    <Title>string</Title>
    <Firstname>string</Firstname>
    <Lastname>string</Lastname>
    <Address1>string</Address1>
    <Address2>string</Address2>
    <Address3>string</Address3>
    <City>string</City>
    <PostCode>string</PostCode>
    <County>string</County>
    <CountryCode>string</CountryCode>
    <PhoneLandline>string</PhoneLandline>
    <PhoneMobile>string</PhoneMobile>
    <Fax>string</Fax>
  </DeliveryAddress>
  <Items>
    <Item>
      <OrderID>int</OrderID>
      <OrderLineID>int</OrderLineID>
      <ProductID>int</ProductID>
      <ProductName>string</ProductName>
      <ProductRef>string</ProductRef>
      <Qty>int</Qty>
      <ItemPrice>double</ItemPrice>
      <TotalPrice>double</TotalPrice>
      <ItemVAT>double</ItemVAT>
      <TotalVAT>double</TotalVAT>
      <TaxCode>string</TaxCode>
      <TaxRate>double</TaxRate>
      <AuxData>string</AuxData>
    </Item>
    <Item>
      <OrderID>int</OrderID>
      <OrderLineID>int</OrderLineID>
      <ProductID>int</ProductID>
      <ProductName>string</ProductName>
      <ProductRef>string</ProductRef>
      <Qty>int</Qty>
      <ItemPrice>double</ItemPrice>
      <TotalPrice>double</TotalPrice>
      <ItemVAT>double</ItemVAT>
      <TotalVAT>double</TotalVAT>
      <TaxCode>string</TaxCode>
      <TaxRate>double</TaxRate>
      <AuxData>string</AuxData>
    </Item>
  </Items>
  <Notes>
    <Note>
      <ID>int</ID>
      <Date>dateTime</Date>
      <Text>string</Text>
    </Note>
    <Note>
      <ID>int</ID>
      <Date>dateTime</Date>
      <Text>string</Text>
    </Note>
  </Notes>
  <Total>double</Total>
  <CurrencyCode>string</CurrencyCode>
  <CurrencyRate>double</CurrencyRate>
  <Dub3StatusID>int</Dub3StatusID>
  <Dub3StausRating>int</Dub3StausRating>
  <Dub3StatusDetail>string</Dub3StatusDetail>
  <SageVendorTxCode>string</SageVendorTxCode>
  <SageStatusDetail>string</SageStatusDetail>
</Order>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /Orders.asmx/GetByID HTTP/1.1
Host: ws.adido.org.uk
Content-Type: application/x-www-form-urlencoded
Content-Length: length

Key=string&OrderID=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<Order xmlns="http://ws.Orders.adido.org.uk/">
  <ID>int</ID>
  <Date>dateTime</Date>
  <Customer>
    <ID>int</ID>
    <Title>string</Title>
    <Firstname>string</Firstname>
    <Lastname>string</Lastname>
    <Email>string</Email>
    <Company>string</Company>
    <Position>string</Position>
  </Customer>
  <BillingAddress>
    <ID>int</ID>
    <Title>string</Title>
    <Firstname>string</Firstname>
    <Lastname>string</Lastname>
    <Address1>string</Address1>
    <Address2>string</Address2>
    <Address3>string</Address3>
    <City>string</City>
    <PostCode>string</PostCode>
    <County>string</County>
    <CountryCode>string</CountryCode>
    <PhoneLandline>string</PhoneLandline>
    <PhoneMobile>string</PhoneMobile>
    <Fax>string</Fax>
  </BillingAddress>
  <DeliveryAddress>
    <ID>int</ID>
    <Title>string</Title>
    <Firstname>string</Firstname>
    <Lastname>string</Lastname>
    <Address1>string</Address1>
    <Address2>string</Address2>
    <Address3>string</Address3>
    <City>string</City>
    <PostCode>string</PostCode>
    <County>string</County>
    <CountryCode>string</CountryCode>
    <PhoneLandline>string</PhoneLandline>
    <PhoneMobile>string</PhoneMobile>
    <Fax>string</Fax>
  </DeliveryAddress>
  <Items>
    <Item>
      <OrderID>int</OrderID>
      <OrderLineID>int</OrderLineID>
      <ProductID>int</ProductID>
      <ProductName>string</ProductName>
      <ProductRef>string</ProductRef>
      <Qty>int</Qty>
      <ItemPrice>double</ItemPrice>
      <TotalPrice>double</TotalPrice>
      <ItemVAT>double</ItemVAT>
      <TotalVAT>double</TotalVAT>
      <TaxCode>string</TaxCode>
      <TaxRate>double</TaxRate>
      <AuxData>string</AuxData>
    </Item>
    <Item>
      <OrderID>int</OrderID>
      <OrderLineID>int</OrderLineID>
      <ProductID>int</ProductID>
      <ProductName>string</ProductName>
      <ProductRef>string</ProductRef>
      <Qty>int</Qty>
      <ItemPrice>double</ItemPrice>
      <TotalPrice>double</TotalPrice>
      <ItemVAT>double</ItemVAT>
      <TotalVAT>double</TotalVAT>
      <TaxCode>string</TaxCode>
      <TaxRate>double</TaxRate>
      <AuxData>string</AuxData>
    </Item>
  </Items>
  <Notes>
    <Note>
      <ID>int</ID>
      <Date>dateTime</Date>
      <Text>string</Text>
    </Note>
    <Note>
      <ID>int</ID>
      <Date>dateTime</Date>
      <Text>string</Text>
    </Note>
  </Notes>
  <Total>double</Total>
  <CurrencyCode>string</CurrencyCode>
  <CurrencyRate>double</CurrencyRate>
  <Dub3StatusID>int</Dub3StatusID>
  <Dub3StausRating>int</Dub3StausRating>
  <Dub3StatusDetail>string</Dub3StatusDetail>
  <SageVendorTxCode>string</SageVendorTxCode>
  <SageStatusDetail>string</SageStatusDetail>
</Order>

Parameter	Value
Key:
OrderID: