Follow

API Method - Customer Search

This method will search for a customer with a given keyword.
Parameters
appKey
 
string
A key identifying the application making the call
userKey
 
string
A key identifying the user making the call
corpOrgID
 
int
The corp organization ID
buyerTypeID
 
int
 
optional
The buyer type ID used for searching based on member access to restricted buyer type
keyword
 
string
The keyword to use for searching (e.g. email, first name, last name, customer number, member number, member barcode, phone number, and custom fields. Multiple keyword values can be provided and matches must match all values.)
Return Values
A customer result data structure containing the following fields
CustomerID
 
long
The customer ID
FirstName
 
string
The first name of the customer
LastName
 
string
The last name of the customer
EmailAddress
 
string
The email of the customer
Address
 
string
The formatted address of the customer
OrderMemberID
 
long
The member ID
MemberNumber
 
string
The member number
MemberType
 
string
The member type
MemberLevel
 
string
The member level
MemberBarcode
 
string
The member barcode
Errors
ApplicationKeyMissing
 
1000
Required parameter appkey is missing or invalid
UserCredentialsMissing
 
1001
Required user credentials are missing or invalid
SecurityInsufficient
 
1002
User security does not permit access to the requested function
RequiredParameter
 
1028
Required parameter is missing
InvalidParameter
 
1039
Invalid parameter format
Example Request
https://prod1.agileticketing.net/api/sales.svc/json/CustomerSearch?appkey={APPKEY}&userkey={USERKEY}&corporgid={CORPORGID}&buyertypeid={BUYERTYPEID}&keyword={KEYWORD}
Example JSON Response
[{
	"CustomerID":9223372036854775807,
	"FirstName":"String content",
	"LastName":"String content",
	"Address":"String content",
	"EmailAddress":"String content",
	"OrderMemberID":9223372036854775807,
	"MemberNumber":"String content",
	"MemberType":"String content",
	"MemberLevel":"String content",
	"MemberBarcode":"String content"
}]
Example XML Response
<ArrayOfCustomerResult xmlns="http://www.agiletix.com/api">
  <CustomerResult>
    <CustomerID>9223372036854775807</CustomerID>
    <FirstName>String content</FirstName>
    <LastName>String content</LastName>
    <Address>String content</Address>
    <EmailAddress>String content</EmailAddress>
    <OrderMemberID>9223372036854775807</OrderMemberID>
    <MemberNumber>String content</MemberNumber>
    <MemberType>String content</MemberType>
    <MemberLevel>String content</MemberLevel>
    <MemberBarcode>String content</MemberBarcode>
  </CustomerResult>
  <CustomerResult>
    <CustomerID>9223372036854775807</CustomerID>
    <FirstName>String content</FirstName>
    <LastName>String content</LastName>
    <Address>String content</Address>
    <EmailAddress>String content</EmailAddress>
    <OrderMemberID>9223372036854775807</OrderMemberID>
    <MemberNumber>String content</MemberNumber>
    <MemberType>String content</MemberType>
    <MemberLevel>String content</MemberLevel>
    <MemberBarcode>String content</MemberBarcode>
  </CustomerResult>
</ArrayOfCustomerResult>
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments