iSAMS Customer API Web Service

iSAMS Customer API

Click here for a complete list of operations.

UpdateCustomers

Adds or updates a set of customers.

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/UpdateCustomers"

<?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>
    <UpdateCustomers xmlns="http://www.estaronline.com/api/">
      <authenticationToken>string</authenticationToken>
      <customers>
        <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 xsi:nil="true" />
            <CustomerNote xsi:nil="true" />
          </Notes>
          <Attributes>
            <NameValuePair xsi:nil="true" />
            <NameValuePair xsi:nil="true" />
          </Attributes>
          <Addresses>
            <CustomerAddress xsi:nil="true" />
            <CustomerAddress xsi:nil="true" />
          </Addresses>
          <Websites>
            <int>int</int>
            <int>int</int>
          </Websites>
          <DateCreated>dateTime</DateCreated>
          <DateModified>dateTime</DateModified>
          <AdditionalDetails>string</AdditionalDetails>
        </Customer>
        <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 xsi:nil="true" />
            <CustomerNote xsi:nil="true" />
          </Notes>
          <Attributes>
            <NameValuePair xsi:nil="true" />
            <NameValuePair xsi:nil="true" />
          </Attributes>
          <Addresses>
            <CustomerAddress xsi:nil="true" />
            <CustomerAddress xsi:nil="true" />
          </Addresses>
          <Websites>
            <int>int</int>
            <int>int</int>
          </Websites>
          <DateCreated>dateTime</DateCreated>
          <DateModified>dateTime</DateModified>
          <AdditionalDetails>string</AdditionalDetails>
        </Customer>
      </customers>
    </UpdateCustomers>
  </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>
    <UpdateCustomersResponse xmlns="http://www.estaronline.com/api/">
      <UpdateCustomersResult>
        <Success>boolean</Success>
        <Code>int</Code>
        <Message>string</Message>
      </UpdateCustomersResult>
    </UpdateCustomersResponse>
  </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>
    <UpdateCustomers xmlns="http://www.estaronline.com/api/">
      <authenticationToken>string</authenticationToken>
      <customers>
        <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 xsi:nil="true" />
            <CustomerNote xsi:nil="true" />
          </Notes>
          <Attributes>
            <NameValuePair xsi:nil="true" />
            <NameValuePair xsi:nil="true" />
          </Attributes>
          <Addresses>
            <CustomerAddress xsi:nil="true" />
            <CustomerAddress xsi:nil="true" />
          </Addresses>
          <Websites>
            <int>int</int>
            <int>int</int>
          </Websites>
          <DateCreated>dateTime</DateCreated>
          <DateModified>dateTime</DateModified>
          <AdditionalDetails>string</AdditionalDetails>
        </Customer>
        <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 xsi:nil="true" />
            <CustomerNote xsi:nil="true" />
          </Notes>
          <Attributes>
            <NameValuePair xsi:nil="true" />
            <NameValuePair xsi:nil="true" />
          </Attributes>
          <Addresses>
            <CustomerAddress xsi:nil="true" />
            <CustomerAddress xsi:nil="true" />
          </Addresses>
          <Websites>
            <int>int</int>
            <int>int</int>
          </Websites>
          <DateCreated>dateTime</DateCreated>
          <DateModified>dateTime</DateModified>
          <AdditionalDetails>string</AdditionalDetails>
        </Customer>
      </customers>
    </UpdateCustomers>
  </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>
    <UpdateCustomersResponse xmlns="http://www.estaronline.com/api/">
      <UpdateCustomersResult>
        <Success>boolean</Success>
        <Code>int</Code>
        <Message>string</Message>
      </UpdateCustomersResult>
    </UpdateCustomersResponse>
  </soap12:Body>
</soap12:Envelope>