iSAMS Customer API Web Service

iSAMS Customer API

Click here for a complete list of operations.

RetrieveCustomers

Retrieves the specified customers.

Test

The test form is only available for methods with primitive types as parameters.

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

<?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>
    <RetrieveCustomers xmlns="http://www.estaronline.com/api/">
      <authenticationToken>string</authenticationToken>
      <customerIDs>
        <int>int</int>
        <int>int</int>
      </customerIDs>
    </RetrieveCustomers>
  </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>
    <RetrieveCustomersResponse xmlns="http://www.estaronline.com/api/">
      <RetrieveCustomersResult>
        <Data>
          <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 xsi:nil="true" />
            <Account xsi:nil="true" />
            <Notes xsi:nil="true" />
            <Attributes xsi:nil="true" />
            <Addresses xsi:nil="true" />
            <Websites xsi:nil="true" />
            <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 xsi:nil="true" />
            <Account xsi:nil="true" />
            <Notes xsi:nil="true" />
            <Attributes xsi:nil="true" />
            <Addresses xsi:nil="true" />
            <Websites xsi:nil="true" />
            <DateCreated>dateTime</DateCreated>
            <DateModified>dateTime</DateModified>
            <AdditionalDetails>string</AdditionalDetails>
          </Customer>
        </Data>
      </RetrieveCustomersResult>
    </RetrieveCustomersResponse>
  </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>
    <RetrieveCustomers xmlns="http://www.estaronline.com/api/">
      <authenticationToken>string</authenticationToken>
      <customerIDs>
        <int>int</int>
        <int>int</int>
      </customerIDs>
    </RetrieveCustomers>
  </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>
    <RetrieveCustomersResponse xmlns="http://www.estaronline.com/api/">
      <RetrieveCustomersResult>
        <Data>
          <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 xsi:nil="true" />
            <Account xsi:nil="true" />
            <Notes xsi:nil="true" />
            <Attributes xsi:nil="true" />
            <Addresses xsi:nil="true" />
            <Websites xsi:nil="true" />
            <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 xsi:nil="true" />
            <Account xsi:nil="true" />
            <Notes xsi:nil="true" />
            <Attributes xsi:nil="true" />
            <Addresses xsi:nil="true" />
            <Websites xsi:nil="true" />
            <DateCreated>dateTime</DateCreated>
            <DateModified>dateTime</DateModified>
            <AdditionalDetails>string</AdditionalDetails>
          </Customer>
        </Data>
      </RetrieveCustomersResult>
    </RetrieveCustomersResponse>
  </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 /global/api/Customers.asmx/RetrieveCustomers?authenticationToken=string&customerIDs=string&customerIDs=string HTTP/1.1
Host: demo.viare.io

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

<?xml version="1.0" encoding="utf-8"?>
<CustomerApiResponse xmlns="http://www.estaronline.com/api/">
  <Data>
    <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 d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CustomerNote d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Notes>
      <Attributes>
        <NameValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <NameValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Attributes>
      <Addresses>
        <CustomerAddress d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CustomerAddress d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </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 d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CustomerNote d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Notes>
      <Attributes>
        <NameValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <NameValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Attributes>
      <Addresses>
        <CustomerAddress d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CustomerAddress d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Addresses>
      <Websites>
        <int>int</int>
        <int>int</int>
      </Websites>
      <DateCreated>dateTime</DateCreated>
      <DateModified>dateTime</DateModified>
      <AdditionalDetails>string</AdditionalDetails>
    </Customer>
  </Data>
</CustomerApiResponse>

HTTP POST

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

POST /global/api/Customers.asmx/RetrieveCustomers HTTP/1.1
Host: demo.viare.io
Content-Type: application/x-www-form-urlencoded
Content-Length: length

authenticationToken=string&customerIDs=string&customerIDs=string

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

<?xml version="1.0" encoding="utf-8"?>
<CustomerApiResponse xmlns="http://www.estaronline.com/api/">
  <Data>
    <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 d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CustomerNote d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Notes>
      <Attributes>
        <NameValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <NameValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Attributes>
      <Addresses>
        <CustomerAddress d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CustomerAddress d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </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 d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CustomerNote d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Notes>
      <Attributes>
        <NameValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <NameValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Attributes>
      <Addresses>
        <CustomerAddress d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CustomerAddress d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Addresses>
      <Websites>
        <int>int</int>
        <int>int</int>
      </Websites>
      <DateCreated>dateTime</DateCreated>
      <DateModified>dateTime</DateModified>
      <AdditionalDetails>string</AdditionalDetails>
    </Customer>
  </Data>
</CustomerApiResponse>