iSAMS Orders API Web Service

iSAMS Orders API

Click here for a complete list of operations.

UpdateOrderItem

Adds/Updates order item.

Test

The test form is only available for requests from the local machine.

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 /global/api/Orders.asmx HTTP/1.1
Host: demo.viare.io
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.estaronline.com/api/orders/UpdateOrderItem"

<?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>
    <UpdateOrderItem xmlns="http://www.estaronline.com/api/orders">
      <authenticationToken>string</authenticationToken>
      <item>
        <ID xmlns="http://www.estaronline.com/api">int</ID>
        <OrderID xmlns="http://www.estaronline.com/api">int</OrderID>
        <Style xmlns="http://www.estaronline.com/api">string</Style>
        <Title xmlns="http://www.estaronline.com/api">string</Title>
        <Barcode xmlns="http://www.estaronline.com/api">string</Barcode>
        <PackingInstructions xmlns="http://www.estaronline.com/api">string</PackingInstructions>
        <Quantity xmlns="http://www.estaronline.com/api">int</Quantity>
        <QuantityScanned xmlns="http://www.estaronline.com/api">int</QuantityScanned>
        <StatusCode xmlns="http://www.estaronline.com/api">Unordered or WaitingToBeOrdered or Undefined or Backorder or Ordered or Personalise or Indent or SplitToNewOrder or PartialSplit or PartialSplitToNewOrder or Deleted or Preorder</StatusCode>
        <Supplier xmlns="http://www.estaronline.com/api">string</Supplier>
        <DateScanned xmlns="http://www.estaronline.com/api">dateTime</DateScanned>
        <UnitPrice xmlns="http://www.estaronline.com/api">decimal</UnitPrice>
        <UnitDiscount xmlns="http://www.estaronline.com/api">decimal</UnitDiscount>
        <UnitTax xmlns="http://www.estaronline.com/api">decimal</UnitTax>
        <UnitPriceIncludingTax xmlns="http://www.estaronline.com/api">decimal</UnitPriceIncludingTax>
        <UnitDiscountIncludingTax xmlns="http://www.estaronline.com/api">decimal</UnitDiscountIncludingTax>
        <UnitNet xmlns="http://www.estaronline.com/api">decimal</UnitNet>
        <Parent xmlns="http://www.estaronline.com/api">int</Parent>
        <RegistryItemID xmlns="http://www.estaronline.com/api">int</RegistryItemID>
        <ItemCompositeType xmlns="http://www.estaronline.com/api">Product or Group or Set</ItemCompositeType>
        <AdditionalDetails xmlns="http://www.estaronline.com/api">string</AdditionalDetails>
        <ItemInfo xmlns="http://www.estaronline.com/api">
          <OrderItemInfo>
            <Key>string</Key>
            <Value>string</Value>
          </OrderItemInfo>
          <OrderItemInfo>
            <Key>string</Key>
            <Value>string</Value>
          </OrderItemInfo>
        </ItemInfo>
        <Personalisation xmlns="http://www.estaronline.com/api">
          <Components>
            <PersonalisedComponent xsi:nil="true" />
            <PersonalisedComponent xsi:nil="true" />
          </Components>
          <Price>decimal</Price>
          <AdditionalData>string</AdditionalData>
        </Personalisation>
        <SplitOrderID xmlns="http://www.estaronline.com/api">int</SplitOrderID>
      </item>
    </UpdateOrderItem>
  </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>
    <UpdateOrderItemResponse xmlns="http://www.estaronline.com/api/orders">
      <UpdateOrderItemResult>
        <Success>boolean</Success>
        <Code>int</Code>
        <Message>string</Message>
      </UpdateOrderItemResult>
    </UpdateOrderItemResponse>
  </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 /global/api/Orders.asmx HTTP/1.1
Host: demo.viare.io
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>
    <UpdateOrderItem xmlns="http://www.estaronline.com/api/orders">
      <authenticationToken>string</authenticationToken>
      <item>
        <ID xmlns="http://www.estaronline.com/api">int</ID>
        <OrderID xmlns="http://www.estaronline.com/api">int</OrderID>
        <Style xmlns="http://www.estaronline.com/api">string</Style>
        <Title xmlns="http://www.estaronline.com/api">string</Title>
        <Barcode xmlns="http://www.estaronline.com/api">string</Barcode>
        <PackingInstructions xmlns="http://www.estaronline.com/api">string</PackingInstructions>
        <Quantity xmlns="http://www.estaronline.com/api">int</Quantity>
        <QuantityScanned xmlns="http://www.estaronline.com/api">int</QuantityScanned>
        <StatusCode xmlns="http://www.estaronline.com/api">Unordered or WaitingToBeOrdered or Undefined or Backorder or Ordered or Personalise or Indent or SplitToNewOrder or PartialSplit or PartialSplitToNewOrder or Deleted or Preorder</StatusCode>
        <Supplier xmlns="http://www.estaronline.com/api">string</Supplier>
        <DateScanned xmlns="http://www.estaronline.com/api">dateTime</DateScanned>
        <UnitPrice xmlns="http://www.estaronline.com/api">decimal</UnitPrice>
        <UnitDiscount xmlns="http://www.estaronline.com/api">decimal</UnitDiscount>
        <UnitTax xmlns="http://www.estaronline.com/api">decimal</UnitTax>
        <UnitPriceIncludingTax xmlns="http://www.estaronline.com/api">decimal</UnitPriceIncludingTax>
        <UnitDiscountIncludingTax xmlns="http://www.estaronline.com/api">decimal</UnitDiscountIncludingTax>
        <UnitNet xmlns="http://www.estaronline.com/api">decimal</UnitNet>
        <Parent xmlns="http://www.estaronline.com/api">int</Parent>
        <RegistryItemID xmlns="http://www.estaronline.com/api">int</RegistryItemID>
        <ItemCompositeType xmlns="http://www.estaronline.com/api">Product or Group or Set</ItemCompositeType>
        <AdditionalDetails xmlns="http://www.estaronline.com/api">string</AdditionalDetails>
        <ItemInfo xmlns="http://www.estaronline.com/api">
          <OrderItemInfo>
            <Key>string</Key>
            <Value>string</Value>
          </OrderItemInfo>
          <OrderItemInfo>
            <Key>string</Key>
            <Value>string</Value>
          </OrderItemInfo>
        </ItemInfo>
        <Personalisation xmlns="http://www.estaronline.com/api">
          <Components>
            <PersonalisedComponent xsi:nil="true" />
            <PersonalisedComponent xsi:nil="true" />
          </Components>
          <Price>decimal</Price>
          <AdditionalData>string</AdditionalData>
        </Personalisation>
        <SplitOrderID xmlns="http://www.estaronline.com/api">int</SplitOrderID>
      </item>
    </UpdateOrderItem>
  </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>
    <UpdateOrderItemResponse xmlns="http://www.estaronline.com/api/orders">
      <UpdateOrderItemResult>
        <Success>boolean</Success>
        <Code>int</Code>
        <Message>string</Message>
      </UpdateOrderItemResult>
    </UpdateOrderItemResponse>
  </soap12:Body>
</soap12:Envelope>