Exigo Web Services API v3.4.244

GetCustomers

Returns one or more customers that match the filter critera passed in.

Input Properties

GetCustomersRequest
PropertyData TypeNotes
CustomerIDInt32Optional. Optionally pull just one customer.
LoginNameStringOptional.
FirstNameStringOptional.
LastNameStringOptional.
CompanyStringOptional.
EmailStringOptional.
PhoneStringOptional.
Phone2StringOptional.
MobilePhoneStringOptional.
FaxStringOptional.
MainAddress1StringOptional.
MainAddress2StringOptional.
MainAddress3StringOptional.
MainCityStringOptional.
MainStateStringOptional.
MainZipStringOptional.
MainCountryStringOptional.
TaxIDStringOptional.
CustomerTypesInt32[]Optional.
CustomerStatusesInt32[]Optional.
EnrollerIDInt32Optional.
SponsorIDInt32Optional.
Field1StringOptional.
Field2StringOptional.
Field3StringOptional.
Field4StringOptional.
Field5StringOptional.
Field6StringOptional.
Field7StringOptional.
Field8StringOptional.
Field9StringOptional.
Field10StringOptional.
Field11StringOptional.
Field12StringOptional.
Field13StringOptional.
Field14StringOptional.
Field15StringOptional.
CreatedDateStartDateTimeOptional.
CreatedDateEndDateTimeOptional.
GreaterThanCustomerIDInt32Optional. Optional paging controller.
GreaterThanModifiedDateDateTimeOptional. Use when pulling changes only.
BatchSizeInt32Optional. Defaults to 100 at a time.

Output Properties

GetCustomersResponse
PropertyData TypeNotes
CustomersCustomerResponse[]
RecordCountInt32
CustomerResponse
PropertyData TypeNotes
CustomerIDInt32Unique identifier for a customer entity.
FirstNameString
LastNameString
CompanyString
CustomerType Int32Classification of a customer as defined by the company.
CustomerStatus Int32Current status of a customer as defined by the company.
EmailString
PhoneString
Phone2String
MobilePhoneString
FaxString
MainAddress1String
MainAddress2String
MainCityString
MainState String
MainZipString
MainCountry String
MainCountyString
MailAddress1String
MailAddress2String
MailCityString
MailState String
MailZipString
MailCountry String
MailCountyString
OtherAddress1String
OtherAddress2String
OtherCityString
OtherState String
OtherZipString
OtherCountry String
OtherCountyString
LoginNameString
EnrollerIDInt32
SponsorIDInt32
RankID Int32
BirthDateDateTime
Field1 String
Field2 String
Field3 String
Field4 String
Field5 String
Field6 String
Field7 String
Field8 String
Field9 String
Field10 String
Field11 String
Field12 String
Field13 String
Field14 String
Field15 String
Date1DateTime
Date2DateTime
Date3DateTime
Date4DateTime
Date5DateTime
CurrencyCode String
PayableToNameString
DefaultWarehouseID Int32Unique location for orders.
PayableType PayableType
CheckThresholdDecimal
PriceType Int32Controls which price band to use.
LanguageID Int32Customize the web experience by setting this.
Gender Gender
SalesTaxIDString
VatRegistrationString
IsSalesTaxExemptBoolean
IsSubscribedToBroadcastsBoolean
CreatedDateDateTime
ModifiedDateDateTime
MiddleNameString
NameSuffixString
MainAddress3String
MailAddress3String
OtherAddress3String

SOAP Request

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

POST /3.0/ExigoApi.asmx HTTP/1.1
Host: api.exigo.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.exigo.com/GetCustomers"

<?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:Header> <ApiAuthentication xmlns="http://api.exigo.com/"> <LoginName>string</LoginName> <Password>string</Password> <Company>string</Company> <Identity>string</Identity> <RequestTimeUtc>dateTime</RequestTimeUtc> <Signature>string</Signature> </ApiAuthentication> </soap:Header> <soap:Body> <GetCustomersRequest xmlns="http://api.exigo.com/"> <CustomerID>int</CustomerID> <LoginName>string</LoginName> <FirstName>string</FirstName> <LastName>string</LastName> <Company>string</Company> <Email>string</Email> <Phone>string</Phone> <Phone2>string</Phone2> <MobilePhone>string</MobilePhone> <Fax>string</Fax> <MainAddress1>string</MainAddress1> <MainAddress2>string</MainAddress2> <MainAddress3>string</MainAddress3> <MainCity>string</MainCity> <MainState>string</MainState> <MainZip>string</MainZip> <MainCountry>string</MainCountry> <TaxID>string</TaxID> <CustomerTypes> <int>int</int> </CustomerTypes> <CustomerStatuses> <int>int</int> </CustomerStatuses> <EnrollerID>int</EnrollerID> <SponsorID>int</SponsorID> <Field1>string</Field1> <Field2>string</Field2> <Field3>string</Field3> <Field4>string</Field4> <Field5>string</Field5> <Field6>string</Field6> <Field7>string</Field7> <Field8>string</Field8> <Field9>string</Field9> <Field10>string</Field10> <Field11>string</Field11> <Field12>string</Field12> <Field13>string</Field13> <Field14>string</Field14> <Field15>string</Field15> <CreatedDateStart>dateTime</CreatedDateStart> <CreatedDateEnd>dateTime</CreatedDateEnd> <GreaterThanCustomerID>int</GreaterThanCustomerID> <GreaterThanModifiedDate>dateTime</GreaterThanModifiedDate> <BatchSize>int</BatchSize> </GetCustomersRequest> </soap:Body> </soap:Envelope>

SOAP Response

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> <GetCustomersResult xmlns="http://api.exigo.com/"> <Customers> <CustomerResponse> <CustomerID>int</CustomerID> <FirstName>string</FirstName> <LastName>string</LastName> <Company>string</Company> <CustomerType>int</CustomerType> <CustomerStatus>int</CustomerStatus> <Email>string</Email> <Phone>string</Phone> <Phone2>string</Phone2> <MobilePhone>string</MobilePhone> <Fax>string</Fax> <MainAddress1>string</MainAddress1> <MainAddress2>string</MainAddress2> <MainCity>string</MainCity> <MainState>string</MainState> <MainZip>string</MainZip> <MainCountry>string</MainCountry> <MainCounty>string</MainCounty> <MailAddress1>string</MailAddress1> <MailAddress2>string</MailAddress2> <MailCity>string</MailCity> <MailState>string</MailState> <MailZip>string</MailZip> <MailCountry>string</MailCountry> <MailCounty>string</MailCounty> <OtherAddress1>string</OtherAddress1> <OtherAddress2>string</OtherAddress2> <OtherCity>string</OtherCity> <OtherState>string</OtherState> <OtherZip>string</OtherZip> <OtherCountry>string</OtherCountry> <OtherCounty>string</OtherCounty> <LoginName>string</LoginName> <EnrollerID>int</EnrollerID> <SponsorID>int</SponsorID> <RankID>int</RankID> <BirthDate>dateTime</BirthDate> <Field1>string</Field1> <Field2>string</Field2> <Field3>string</Field3> <Field4>string</Field4> <Field5>string</Field5> <Field6>string</Field6> <Field7>string</Field7> <Field8>string</Field8> <Field9>string</Field9> <Field10>string</Field10> <Field11>string</Field11> <Field12>string</Field12> <Field13>string</Field13> <Field14>string</Field14> <Field15>string</Field15> <Date1>dateTime</Date1> <Date2>dateTime</Date2> <Date3>dateTime</Date3> <Date4>dateTime</Date4> <Date5>dateTime</Date5> <CurrencyCode>string</CurrencyCode> <PayableToName>string</PayableToName> <DefaultWarehouseID>int</DefaultWarehouseID> <PayableType>Check or WireTransfer or PaymentCard or DirectDeposit or OnHold or BankWire or DebitCardHold or Other100</PayableType> <CheckThreshold>decimal</CheckThreshold> <PriceType>int</PriceType> <LanguageID>int</LanguageID> <Gender>Unknown or Male or Female</Gender> <SalesTaxID>string</SalesTaxID> <VatRegistration>string</VatRegistration> <IsSalesTaxExempt>boolean</IsSalesTaxExempt> <IsSubscribedToBroadcasts>boolean</IsSubscribedToBroadcasts> <CreatedDate>dateTime</CreatedDate> <ModifiedDate>dateTime</ModifiedDate> <MiddleName>string</MiddleName> <NameSuffix>string</NameSuffix> <MainAddress3>string</MainAddress3> <MailAddress3>string</MailAddress3> <OtherAddress3>string</OtherAddress3> </CustomerResponse> </Customers> <RecordCount>int</RecordCount> </GetCustomersResult> </soap:Body> </soap:Envelope>

C#

try

{

    //Create Main API Context Object

    ExigoApi api = new ExigoApi();

 

    //Create Authentication Header

    ApiAuthentication auth = new ApiAuthentication();

    auth.LoginName = "yourLoginName";

    auth.Password = "yourPassword";

    auth.Company = "yourCompany";

    api.ApiAuthenticationValue = auth;

 

    //Create Request

    GetCustomersRequest req = new GetCustomersRequest();

 

    req.CustomerID = 1;             //Optionally pull just one customer

 

    //Send Request to Server and Get Response

    GetCustomersResponse res = api.GetCustomers(req);

 

    //Now examine the results:

 

    foreach (CustomerResponse customer in res.Customers)

    {

        Console.WriteLine("CustomerID: {0}", customer.CustomerID);

        Console.WriteLine("FirstName: {0}", customer.FirstName);

        Console.WriteLine("LastName: {0}", customer.LastName);

        Console.WriteLine("Company: {0}", customer.Company);

        Console.WriteLine("CustomerType: {0}", customer.CustomerType);

        Console.WriteLine("CustomerStatus: {0}", customer.CustomerStatus);

        Console.WriteLine("Email: {0}", customer.Email);

        Console.WriteLine("Phone: {0}", customer.Phone);

        Console.WriteLine("Phone2: {0}", customer.Phone2);

        Console.WriteLine("MobilePhone: {0}", customer.MobilePhone);

        Console.WriteLine("Fax: {0}", customer.Fax);

        Console.WriteLine("MainAddress1: {0}", customer.MainAddress1);

        Console.WriteLine("MainAddress2: {0}", customer.MainAddress2);

        Console.WriteLine("MainCity: {0}", customer.MainCity);

        Console.WriteLine("MainState: {0}", customer.MainState);

        Console.WriteLine("MainZip: {0}", customer.MainZip);

        Console.WriteLine("MainCountry: {0}", customer.MainCountry);

        Console.WriteLine("MainCounty: {0}", customer.MainCounty);

        Console.WriteLine("MailAddress1: {0}", customer.MailAddress1);

        Console.WriteLine("MailAddress2: {0}", customer.MailAddress2);

        Console.WriteLine("MailCity: {0}", customer.MailCity);

        Console.WriteLine("MailZip: {0}", customer.MailZip);

        Console.WriteLine("MailCounty: {0}", customer.MailCounty);

        Console.WriteLine("OtherAddress1: {0}", customer.OtherAddress1);

        Console.WriteLine("OtherAddress2: {0}", customer.OtherAddress2);

        Console.WriteLine("OtherCity: {0}", customer.OtherCity);

        Console.WriteLine("OtherZip: {0}", customer.OtherZip);

        Console.WriteLine("OtherCounty: {0}", customer.OtherCounty);

        Console.WriteLine("LoginName: {0}", customer.LoginName);

        Console.WriteLine("EnrollerID: {0}", customer.EnrollerID);

        Console.WriteLine("SponsorID: {0}", customer.SponsorID);

        Console.WriteLine("RankID: {0}", customer.RankID);

        Console.WriteLine("BirthDate: {0}", customer.BirthDate);

        Console.WriteLine("Date1: {0}", customer.Date1);

        Console.WriteLine("Date2: {0}", customer.Date2);

        Console.WriteLine("Date3: {0}", customer.Date3);

        Console.WriteLine("Date4: {0}", customer.Date4);

        Console.WriteLine("Date5: {0}", customer.Date5);

        Console.WriteLine("CurrencyCode: {0}", customer.CurrencyCode);

        Console.WriteLine("PayableToName: {0}", customer.PayableToName);

        Console.WriteLine("DefaultWarehouseID: {0}", customer.DefaultWarehouseID);

        Console.WriteLine("PayableType: {0}", customer.PayableType);

        Console.WriteLine("CheckThreshold: {0}", customer.CheckThreshold);

        Console.WriteLine("PriceType: {0}", customer.PriceType);

        Console.WriteLine("Gender: {0}", customer.Gender);

        Console.WriteLine("SalesTaxID: {0}", customer.SalesTaxID);

        Console.WriteLine("VatRegistration: {0}", customer.VatRegistration);

        Console.WriteLine("IsSalesTaxExempt: {0}", customer.IsSalesTaxExempt);

        Console.WriteLine("IsSubscribedToBroadcasts: {0}", customer.IsSubscribedToBroadcasts);

        Console.WriteLine("CreatedDate: {0}", customer.CreatedDate);

        Console.WriteLine("ModifiedDate: {0}", customer.ModifiedDate);

        Console.WriteLine("MiddleName: {0}", customer.MiddleName);

        Console.WriteLine("NameSuffix: {0}", customer.NameSuffix);

        Console.WriteLine("MainAddress3: {0}", customer.MainAddress3);

        Console.WriteLine("MailAddress3: {0}", customer.MailAddress3);

        Console.WriteLine("OtherAddress3: {0}", customer.OtherAddress3);

    }

    Console.WriteLine("RecordCount: {0}", res.RecordCount);

}

catch (Exception ex)

{

    Console.WriteLine("Error: " + ex.Message);

}

VB.Net

Try

    'Create Main API Context Object

    Dim api as new ExigoApi()

 

    'Create Authentication Header

    Dim auth as new ApiAuthentication()

    auth.LoginName = "yourLoginName"

    auth.Password = "yourPassword"

    auth.Company = "yourCompany"

    api.ApiAuthenticationValue = auth

 

    'Create Request

    Dim req as new GetCustomersRequest()

 

    req.CustomerID = 1

 

    'Send Request to Server and Get Response

    Dim res As GetCustomersResponse = api.GetCustomers(req)

 

    'Now examine the results:

 

    For Each customer As CustomerResponse In res.Customers

        Console.WriteLine("CustomerID: {0}", customer.CustomerID)

        Console.WriteLine("FirstName: {0}", customer.FirstName)

        Console.WriteLine("LastName: {0}", customer.LastName)

        Console.WriteLine("Company: {0}", customer.Company)

        Console.WriteLine("CustomerType: {0}", customer.CustomerType)

        Console.WriteLine("CustomerStatus: {0}", customer.CustomerStatus)

        Console.WriteLine("Email: {0}", customer.Email)

        Console.WriteLine("Phone: {0}", customer.Phone)

        Console.WriteLine("Phone2: {0}", customer.Phone2)

        Console.WriteLine("MobilePhone: {0}", customer.MobilePhone)

        Console.WriteLine("Fax: {0}", customer.Fax)

        Console.WriteLine("MainAddress1: {0}", customer.MainAddress1)

        Console.WriteLine("MainAddress2: {0}", customer.MainAddress2)

        Console.WriteLine("MainCity: {0}", customer.MainCity)

        Console.WriteLine("MainState: {0}", customer.MainState)

        Console.WriteLine("MainZip: {0}", customer.MainZip)

        Console.WriteLine("MainCountry: {0}", customer.MainCountry)

        Console.WriteLine("MainCounty: {0}", customer.MainCounty)

        Console.WriteLine("MailAddress1: {0}", customer.MailAddress1)

        Console.WriteLine("MailAddress2: {0}", customer.MailAddress2)

        Console.WriteLine("MailCity: {0}", customer.MailCity)

        Console.WriteLine("MailZip: {0}", customer.MailZip)

        Console.WriteLine("MailCounty: {0}", customer.MailCounty)

        Console.WriteLine("OtherAddress1: {0}", customer.OtherAddress1)

        Console.WriteLine("OtherAddress2: {0}", customer.OtherAddress2)

        Console.WriteLine("OtherCity: {0}", customer.OtherCity)

        Console.WriteLine("OtherZip: {0}", customer.OtherZip)

        Console.WriteLine("OtherCounty: {0}", customer.OtherCounty)

        Console.WriteLine("LoginName: {0}", customer.LoginName)

        Console.WriteLine("EnrollerID: {0}", customer.EnrollerID)

        Console.WriteLine("SponsorID: {0}", customer.SponsorID)

        Console.WriteLine("RankID: {0}", customer.RankID)

        Console.WriteLine("BirthDate: {0}", customer.BirthDate)

        Console.WriteLine("Date1: {0}", customer.Date1)

        Console.WriteLine("Date2: {0}", customer.Date2)

        Console.WriteLine("Date3: {0}", customer.Date3)

        Console.WriteLine("Date4: {0}", customer.Date4)

        Console.WriteLine("Date5: {0}", customer.Date5)

        Console.WriteLine("CurrencyCode: {0}", customer.CurrencyCode)

        Console.WriteLine("PayableToName: {0}", customer.PayableToName)

        Console.WriteLine("DefaultWarehouseID: {0}", customer.DefaultWarehouseID)

        Console.WriteLine("PayableType: {0}", customer.PayableType)

        Console.WriteLine("CheckThreshold: {0}", customer.CheckThreshold)

        Console.WriteLine("PriceType: {0}", customer.PriceType)

        Console.WriteLine("Gender: {0}", customer.Gender)

        Console.WriteLine("SalesTaxID: {0}", customer.SalesTaxID)

        Console.WriteLine("VatRegistration: {0}", customer.VatRegistration)

        Console.WriteLine("IsSalesTaxExempt: {0}", customer.IsSalesTaxExempt)

        Console.WriteLine("IsSubscribedToBroadcasts: {0}", customer.IsSubscribedToBroadcasts)

        Console.WriteLine("CreatedDate: {0}", customer.CreatedDate)

        Console.WriteLine("ModifiedDate: {0}", customer.ModifiedDate)

        Console.WriteLine("MiddleName: {0}", customer.MiddleName)

        Console.WriteLine("NameSuffix: {0}", customer.NameSuffix)

        Console.WriteLine("MainAddress3: {0}", customer.MainAddress3)

        Console.WriteLine("MailAddress3: {0}", customer.MailAddress3)

        Console.WriteLine("OtherAddress3: {0}", customer.OtherAddress3)

    Next

    Console.WriteLine("RecordCount: {0}", res.RecordCount)

Catch ex As Exception

    Console.WriteLine("Error: " & ex.Message)

End Try

PHP

Note: PHP is not officially supported.

<?php

try

{

    //Setup the SoapClient and Authentication

    $api = new SoapClient("http://api.exigo.com/3.0/ExigoApi.asmx?WSDL");

    $ns = "http://api.exigo.com/";

    $auth = array()

    $auth["LoginName"] = new SoapVar("yourLoginName",XSD_STRING,null,null,null,$ns);

    $auth["Password"] = new SoapVar("yourPassword",XSD_STRING,null,null,null,$ns);

    $auth["Company"] = new SoapVar("yourCompany",XSD_STRING,null,null,null,$ns);

    $headerBody = new SoapVar($auth, SOAP_ENC_OBJECT);

    $header = new SoapHeader($ns, 'ApiAuthentication', $headerBody);

    $api->__setSoapHeaders(array($header));

 

    //Create Request

 

    $req->CustomerID = 1;

 

    //Send Request to Server and Get Response

    $res = $api.GetCustomers($req);

 

    //Now examine the results:

}

catch (SoapFault $ex)

{

    echo "Error: ", $ex->getMessage();

}

?>

Java

Note: Java is not officially supported.

try

{

    //Create Main API Context Object

    ExigoApi api = new ExigoApi();

 

    //Create Authentication Header

    ApiAuthentication auth = new ApiAuthentication();

    auth.setLoginName("yourLoginName");

    auth.setPassword("yourPassword");

    auth.setCompany("yourCompany");

    api.setApiAuthenticationValue(auth);

 

    //Create Request

    GetCustomersRequest req = new GetCustomersRequest();

 

    req.setCustomerID(1);

 

    //Send Request to Server and Get Response

    GetCustomersResponse res = api.getExigoApiSoap().getCustomers(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

    System.out.println("Error: " + ex.getMessage());

}

CSV

This method supports CSV output.

HTTP Get Request:
http://api.exigo.com/3.0/csv/?method=GetCustomers
&ApiLoginName=String
&ApiPassword=String
&ApiCompany=String
&CustomerID=Nullable`1
&LoginName=String
&FirstName=String
&LastName=String
&Company=String
&Email=String
&Phone=String
&Phone2=String
&MobilePhone=String
&Fax=String
&MainAddress1=String
&MainAddress2=String
&MainAddress3=String
&MainCity=String
&MainState=String
&MainZip=String
&MainCountry=String
&TaxID=String
&CustomerTypes=Int32[]
&CustomerStatuses=Int32[]
&EnrollerID=Nullable`1
&SponsorID=Nullable`1
&Field1=String
&Field2=String
&Field3=String
&Field4=String
&Field5=String
&Field6=String
&Field7=String
&Field8=String
&Field9=String
&Field10=String
&Field11=String
&Field12=String
&Field13=String
&Field14=String
&Field15=String
&CreatedDateStart=Nullable`1
&CreatedDateEnd=Nullable`1
&GreaterThanCustomerID=Nullable`1
&GreaterThanModifiedDate=Nullable`1
&BatchSize=Nullable`1

Response Fields
CustomerID,FirstName,LastName,Company,CustomerType,CustomerStatus,Email,Phone,Phone2,MobilePhone,Fax,MainAddress1,MainAddress2,MainCity,MainState,MainZip,MainCountry,MainCounty,MailAddress1,MailAddress2,MailCity,MailState,MailZip,MailCountry,MailCounty,OtherAddress1,OtherAddress2,OtherCity,OtherState,OtherZip,OtherCountry,OtherCounty,LoginName,EnrollerID,SponsorID,RankID,BirthDate,Field1,Field2,Field3,Field4,Field5,Field6,Field7,Field8,Field9,Field10,Field11,Field12,Field13,Field14,Field15,Date1,Date2,Date3,Date4,Date5,CurrencyCode,PayableToName,DefaultWarehouseID,PayableType,CheckThreshold,PriceType,LanguageID,Gender,SalesTaxID,VatRegistration,IsSalesTaxExempt,IsSubscribedToBroadcasts,CreatedDate,ModifiedDate,MiddleName,NameSuffix,MainAddress3,MailAddress3,OtherAddress3,RecordCount
Int32,String,String,String,Int32,Int32,String,String,String,String,String,String,String,String,String,String,String,String,String,String,String,String,String,String,String,String,String,String,String,String,String,String,String,Int32,Int32,Int32,DateTime,String,String,String,String,String,String,String,String,String,String,String,String,String,String,String,Nullable`1,Nullable`1,Nullable`1,Nullable`1,Nullable`1,String,String,Int32,PayableType,Decimal,Int32,Int32,Gender,String,String,Boolean,Boolean,DateTime,DateTime,String,String,String,String,String,Int32