iSAMS Customer API Web Service

iSAMS Customer API

Click here for a complete list of operations.

UpdateCustomer

Adds or updates a single customer.

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

<?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>
    <UpdateCustomer xmlns="http://www.estaronline.com/api/">
      <authenticationToken>string</authenticationToken>
      <customer>
        <ID>int</ID>
        <ForeignIdentity>string</ForeignIdentity>
        <Email>string</Email>
        <Title>string</Title>
        <FirstName>string</FirstName>
        <LastName>string</LastName>
        <Phone>string</Phone>
        <Fax>string</Fax>
        <Mobile>string</Mobile>
        <Password>string</Password>
        <Protected>boolean</Protected>
        <LpmStatus>int</LpmStatus>
        <SmsStatus>int</SmsStatus>
        <EmailFormat>string</EmailFormat>
        <CustomerType>int</CustomerType>
        <PreferencesToken>string</PreferencesToken>
        <InterestGroups>
          <string>string</string>
          <string>string</string>
        </InterestGroups>
        <Account>
          <AccountID>string</AccountID>
          <AccountType>string</AccountType>
          <AccountName>string</AccountName>
          <DateCreated>dateTime</DateCreated>
          <Discount>double</Discount>
          <FreeFreight>boolean</FreeFreight>
        </Account>
        <Notes>
          <CustomerNote>
            <ID>int</ID>
            <Note>string</Note>
            <DateCreated>dateTime</DateCreated>
            <DisplayLevel>int</DisplayLevel>
          </CustomerNote>
          <CustomerNote>
            <ID>int</ID>
            <Note>string</Note>
            <DateCreated>dateTime</DateCreated>
            <DisplayLevel>int</DisplayLevel>
          </CustomerNote>
        </Notes>
        <Attributes>
          <NameValuePair>
            <Name>string</Name>
            <Value>string</Value>
          </NameValuePair>
          <NameValuePair>
            <Name>string</Name>
            <Value>string</Value>
          </NameValuePair>
        </Attributes>
        <Addresses>
          <CustomerAddress>
            <Type>string</Type>
            <Title>string</Title>
            <FirstName>string</FirstName>
            <LastName>string</LastName>
            <ContactPhone>string</ContactPhone>
            <Company>string</Company>
            <Street>string</Street>
            <Suburb>string</Suburb>
            <State>string</State>
            <City>string</City>
            <Postcode>string</Postcode>
            <ExtraInformation>string</ExtraInformation>
            <Country>string</Country>
            <ID>int</ID>
          </CustomerAddress>
          <CustomerAddress>
            <Type>string</Type>
            <Title>string</Title>
            <FirstName>string</FirstName>
            <LastName>string</LastName>
            <ContactPhone>string</ContactPhone>
            <Company>string</Company>
            <Street>string</Street>
            <Suburb>string</Suburb>
            <State>string</State>
            <City>string</City>
            <Postcode>string</Postcode>
            <ExtraInformation>string</ExtraInformation>
            <Country>string</Country>
            <ID>int</ID>
          </CustomerAddress>
        </Addresses>
        <Websites>
          <int>int</int>
          <int>int</int>
        </Websites>
        <DateCreated>dateTime</DateCreated>
        <DateModified>dateTime</DateModified>
        <AdditionalDetails>string</AdditionalDetails>
      </customer>
    </UpdateCustomer>
  </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>
    <UpdateCustomerResponse xmlns="http://www.estaronline.com/api/">
      <UpdateCustomerResult>
        <Success>boolean</Success>
        <Code>int</Code>
        <Message>string</Message>
      </UpdateCustomerResult>
    </UpdateCustomerResponse>
  </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/Customers.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>
    <UpdateCustomer xmlns="http://www.estaronline.com/api/">
      <authenticationToken>string</authenticationToken>
      <customer>
        <ID>int</ID>
        <ForeignIdentity>string</ForeignIdentity>
        <Email>string</Email>
        <Title>string</Title>
        <FirstName>string</FirstName>
        <LastName>string</LastName>
        <Phone>string</Phone>
        <Fax>string</Fax>
        <Mobile>string</Mobile>
        <Password>string</Password>
        <Protected>boolean</Protected>
        <LpmStatus>int</LpmStatus>
        <SmsStatus>int</SmsStatus>
        <EmailFormat>string</EmailFormat>
        <CustomerType>int</CustomerType>
        <PreferencesToken>string</PreferencesToken>
        <InterestGroups>
          <string>string</string>
          <string>string</string>
        </InterestGroups>
        <Account>
          <AccountID>string</AccountID>
          <AccountType>string</AccountType>
          <AccountName>string</AccountName>
          <DateCreated>dateTime</DateCreated>
          <Discount>double</Discount>
          <FreeFreight>boolean</FreeFreight>
        </Account>
        <Notes>
          <CustomerNote>
            <ID>int</ID>
            <Note>string</Note>
            <DateCreated>dateTime</DateCreated>
            <DisplayLevel>int</DisplayLevel>
          </CustomerNote>
          <CustomerNote>
            <ID>int</ID>
            <Note>string</Note>
            <DateCreated>dateTime</DateCreated>
            <DisplayLevel>int</DisplayLevel>
          </CustomerNote>
        </Notes>
        <Attributes>
          <NameValuePair>
            <Name>string</Name>
            <Value>string</Value>
          </NameValuePair>
          <NameValuePair>
            <Name>string</Name>
            <Value>string</Value>
          </NameValuePair>
        </Attributes>
        <Addresses>
          <CustomerAddress>
            <Type>string</Type>
            <Title>string</Title>
            <FirstName>string</FirstName>
            <LastName>string</LastName>
            <ContactPhone>string</ContactPhone>
            <Company>string</Company>
            <Street>string</Street>
            <Suburb>string</Suburb>
            <State>string</State>
            <City>string</City>
            <Postcode>string</Postcode>
            <ExtraInformation>string</ExtraInformation>
            <Country>string</Country>
            <ID>int</ID>
          </CustomerAddress>
          <CustomerAddress>
            <Type>string</Type>
            <Title>string</Title>
            <FirstName>string</FirstName>
            <LastName>string</LastName>
            <ContactPhone>string</ContactPhone>
            <Company>string</Company>
            <Street>string</Street>
            <Suburb>string</Suburb>
            <State>string</State>
            <City>string</City>
            <Postcode>string</Postcode>
            <ExtraInformation>string</ExtraInformation>
            <Country>string</Country>
            <ID>int</ID>
          </CustomerAddress>
        </Addresses>
        <Websites>
          <int>int</int>
          <int>int</int>
        </Websites>
        <DateCreated>dateTime</DateCreated>
        <DateModified>dateTime</DateModified>
        <AdditionalDetails>string</AdditionalDetails>
      </customer>
    </UpdateCustomer>
  </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>
    <UpdateCustomerResponse xmlns="http://www.estaronline.com/api/">
      <UpdateCustomerResult>
        <Success>boolean</Success>
        <Code>int</Code>
        <Message>string</Message>
      </UpdateCustomerResult>
    </UpdateCustomerResponse>
  </soap12:Body>
</soap12:Envelope>