ServiceStack Home (Live)

QueryCustomers

Admin

**Requires Authentication**
Required role:	Admin

The following routes are available for this service:
All Verbs	/query/customers

**QueryBase** Parameters:
Name	Parameter	Data Type	Required
Skip	form	int?	No
Take	form	int?	No
OrderBy	form	string	No
OrderByDesc	form	string	No
Include	form	string	No
Fields	form	string	No
Meta	form	Dictionary<string, string>	No

**Customer** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Email	form	string	No
DisplayName	form	string	No
FirstName	form	string	No
LastName	form	string	No
Company	form	string	No
PhoneNumber	form	string	No
AddressLine1	form	string	No
AddressLine2	form	string	No
AddressCity	form	string	No
AddressZip	form	string	No
AddressState	form	string	No
AddressCountry	form	string	No
StripeCustomerId	form	string	No
StripeCouponId	form	string	No
Plan	form	string	No
CreatedDate	form	DateTime	No
IsReferrer	form	bool	No
Orders	form	List<Order>	No
Subscriptions	form	List<Subscription>	No

**Order** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
CustomerId	form	int	No
ProductName	form	string	No
FirstName	form	string	No
LastName	form	string	No
Email	form	string	No
Company	form	string	No
PhoneNumber	form	string	No
AddressLine1	form	string	No
AddressLine2	form	string	No
AddressCity	form	string	No
AddressZip	form	string	No
AddressState	form	string	No
AddressCountry	form	string	No
AgreeTerms	form	bool	No
Notes	form	string	No
Last4	form	string	No
SubTotal	form	int	No
CouponId	form	string	No
Discount	form	int	No
Tax	form	int	No
Total	form	int	No
ItemQuantity	form	int	No
AuthorizedQuantity	form	int?	No
SubscriptionId	form	int?	No
LicenseRef	form	string	No
PaymentId	form	int?	No
EmailId	form	int?	No
Paid	form	bool	No
CreatedDate	form	DateTime	No
ModifiedDate	form	DateTime	No
ModifiedBy	form	string	No
CancelledDate	form	DateTime?	No
CancelledReason	form	string	No
IpAddress	form	string	No
OrderDetails	form	List<OrderDetail>	No

**OrderDetail** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
OrderId	form	int	No
SkuId	form	int	No
SkuType	form	SkuType	No
Price	form	int	No
Description	form	string	No
Quantity	form	int	No
Total	form	int	No

**SkuType** Enum:
Product
PerDev
PerCore
Site
Support
Training
Register
Payment

**Subscription** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
CustomerId	form	int	No
Email	form	string	No
SkuId	form	int	No
SkuName	form	string	No
SkuType	form	SkuType	No
Code	form	string	No
Quantity	form	int	No
SupportQuantity	form	int	No
Total	form	int	No
IsPlan	form	bool	No
IsRenewal	form	bool	No
SubscriptionDurationDays	form	int	No
RenewalDate	form	DateTime?	No
LicenseRef	form	string	No
LicenseName	form	string	No
LicenseAddress	form	string	No
LicenseType	form	LicenseType	No
ExpiryDate	form	DateTime	No
LicenseKey	form	LicenseKey	No
LicenseKeyText	form	string	No
CreatedDate	form	DateTime	No
ModifiedDate	form	DateTime	No
CancelledDate	form	DateTime?	No
StripeSubscriptionId	form	string	No
EmailId	form	int?	No
EmailRenewalId	form	int?	No
EmailExpiredId	form	int?	No
RenewalSubscriptionId	form	int?	No
ExternalRef	form	string	No
Notes	form	string	No
Error	form	string	No

**LicenseType** Enum:
Free
FreeIndividual
FreeOpenSource
Indie
Business
Enterprise
TextIndie
TextBusiness
OrmLiteIndie
OrmLiteBusiness
RedisIndie
RedisBusiness
AwsIndie
AwsBusiness
Trial
Site
TextSite
RedisSite
OrmLiteSite

**LicenseKey** Parameters:
Name	Parameter	Data Type	Required
Ref	form	string	No
Name	form	string	No
Type	form	LicenseType	No
Meta	form	long	No
Hash	form	string	No
Halg	form	string	No
Expiry	form	DateTime	No

**QueryResponse<T>** Parameters:
Name	Parameter	Data Type	Required
Offset	form	int	No
Total	form	int	No
Results	form	List<Customer>	Yes
Meta	form	Dictionary<string, string>	No
ResponseStatus	form	ResponseStatus	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /query/customers HTTP/1.1 
Host: account.servicestack.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<QueryCustomers xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyApp.ServiceInterface">
  <Skip xmlns="http://schemas.servicestack.net/types">0</Skip>
  <Take xmlns="http://schemas.servicestack.net/types">0</Take>
  <OrderBy xmlns="http://schemas.servicestack.net/types">String</OrderBy>
  <OrderByDesc xmlns="http://schemas.servicestack.net/types">String</OrderByDesc>
  <Include xmlns="http://schemas.servicestack.net/types">String</Include>
  <Fields xmlns="http://schemas.servicestack.net/types">String</Fields>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</QueryCustomers>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfCustomertlJ4_P31p xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Offset>0</Offset>
  <Total>0</Total>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/MyApp.ServiceModel">
    <d2p1:Customer>
      <d2p1:AddressCity>String</d2p1:AddressCity>
      <d2p1:AddressCountry>String</d2p1:AddressCountry>
      <d2p1:AddressLine1>String</d2p1:AddressLine1>
      <d2p1:AddressLine2>String</d2p1:AddressLine2>
      <d2p1:AddressState>String</d2p1:AddressState>
      <d2p1:AddressZip>String</d2p1:AddressZip>
      <d2p1:Company>String</d2p1:Company>
      <d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
      <d2p1:DisplayName>String</d2p1:DisplayName>
      <d2p1:Email>String</d2p1:Email>
      <d2p1:FirstName>String</d2p1:FirstName>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:IsReferrer>false</d2p1:IsReferrer>
      <d2p1:LastName>String</d2p1:LastName>
      <d2p1:Orders>
        <d2p1:Order>
          <d2p1:AddressCity>String</d2p1:AddressCity>
          <d2p1:AddressCountry>String</d2p1:AddressCountry>
          <d2p1:AddressLine1>String</d2p1:AddressLine1>
          <d2p1:AddressLine2>String</d2p1:AddressLine2>
          <d2p1:AddressState>String</d2p1:AddressState>
          <d2p1:AddressZip>String</d2p1:AddressZip>
          <d2p1:AgreeTerms>false</d2p1:AgreeTerms>
          <d2p1:AuthorizedQuantity>0</d2p1:AuthorizedQuantity>
          <d2p1:CancelledDate>0001-01-01T00:00:00</d2p1:CancelledDate>
          <d2p1:CancelledReason>String</d2p1:CancelledReason>
          <d2p1:Company>String</d2p1:Company>
          <d2p1:CouponId>String</d2p1:CouponId>
          <d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
          <d2p1:CustomerId>0</d2p1:CustomerId>
          <d2p1:Discount>0</d2p1:Discount>
          <d2p1:Email>String</d2p1:Email>
          <d2p1:EmailId>0</d2p1:EmailId>
          <d2p1:FirstName>String</d2p1:FirstName>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:IpAddress>String</d2p1:IpAddress>
          <d2p1:ItemQuantity>0</d2p1:ItemQuantity>
          <d2p1:Last4>String</d2p1:Last4>
          <d2p1:LastName>String</d2p1:LastName>
          <d2p1:LicenseRef>String</d2p1:LicenseRef>
          <d2p1:ModifiedBy>String</d2p1:ModifiedBy>
          <d2p1:ModifiedDate>0001-01-01T00:00:00</d2p1:ModifiedDate>
          <d2p1:Notes>String</d2p1:Notes>
          <d2p1:OrderDetails>
            <d2p1:OrderDetail>
              <d2p1:Description>String</d2p1:Description>
              <d2p1:Id>0</d2p1:Id>
              <d2p1:OrderId>0</d2p1:OrderId>
              <d2p1:Price>0</d2p1:Price>
              <d2p1:Quantity>0</d2p1:Quantity>
              <d2p1:SkuId>0</d2p1:SkuId>
              <d2p1:SkuType>Product</d2p1:SkuType>
              <d2p1:Total>0</d2p1:Total>
            </d2p1:OrderDetail>
          </d2p1:OrderDetails>
          <d2p1:Paid>false</d2p1:Paid>
          <d2p1:PaymentId>0</d2p1:PaymentId>
          <d2p1:PhoneNumber>String</d2p1:PhoneNumber>
          <d2p1:ProductName>String</d2p1:ProductName>
          <d2p1:SubTotal>0</d2p1:SubTotal>
          <d2p1:SubscriptionId>0</d2p1:SubscriptionId>
          <d2p1:Tax>0</d2p1:Tax>
          <d2p1:Total>0</d2p1:Total>
        </d2p1:Order>
      </d2p1:Orders>
      <d2p1:PhoneNumber>String</d2p1:PhoneNumber>
      <d2p1:Plan>String</d2p1:Plan>
      <d2p1:StripeCouponId>String</d2p1:StripeCouponId>
      <d2p1:StripeCustomerId>String</d2p1:StripeCustomerId>
      <d2p1:Subscriptions>
        <d2p1:Subscription>
          <d2p1:CancelledDate>0001-01-01T00:00:00</d2p1:CancelledDate>
          <d2p1:Code>String</d2p1:Code>
          <d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
          <d2p1:CustomerId>0</d2p1:CustomerId>
          <d2p1:Email>String</d2p1:Email>
          <d2p1:EmailExpiredId>0</d2p1:EmailExpiredId>
          <d2p1:EmailId>0</d2p1:EmailId>
          <d2p1:EmailRenewalId>0</d2p1:EmailRenewalId>
          <d2p1:Error>String</d2p1:Error>
          <d2p1:ExpiryDate>0001-01-01T00:00:00</d2p1:ExpiryDate>
          <d2p1:ExternalRef>String</d2p1:ExternalRef>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:IsPlan>false</d2p1:IsPlan>
          <d2p1:IsRenewal>false</d2p1:IsRenewal>
          <d2p1:LicenseAddress>String</d2p1:LicenseAddress>
          <d2p1:LicenseKey xmlns:d6p1="http://schemas.datacontract.org/2004/07/ServiceStack">
            <d6p1:Expiry>0001-01-01T00:00:00</d6p1:Expiry>
            <d6p1:Halg>String</d6p1:Halg>
            <d6p1:Hash>String</d6p1:Hash>
            <d6p1:Meta>0</d6p1:Meta>
            <d6p1:Name>String</d6p1:Name>
            <d6p1:Ref>String</d6p1:Ref>
            <d6p1:Type>Free</d6p1:Type>
          </d2p1:LicenseKey>
          <d2p1:LicenseKeyText>String</d2p1:LicenseKeyText>
          <d2p1:LicenseName>String</d2p1:LicenseName>
          <d2p1:LicenseRef>String</d2p1:LicenseRef>
          <d2p1:LicenseType>Free</d2p1:LicenseType>
          <d2p1:ModifiedDate>0001-01-01T00:00:00</d2p1:ModifiedDate>
          <d2p1:Notes>String</d2p1:Notes>
          <d2p1:Quantity>0</d2p1:Quantity>
          <d2p1:RenewalDate>0001-01-01T00:00:00</d2p1:RenewalDate>
          <d2p1:RenewalSubscriptionId>0</d2p1:RenewalSubscriptionId>
          <d2p1:SkuId>0</d2p1:SkuId>
          <d2p1:SkuName>String</d2p1:SkuName>
          <d2p1:SkuType>Product</d2p1:SkuType>
          <d2p1:StripeSubscriptionId>String</d2p1:StripeSubscriptionId>
          <d2p1:SubscriptionDurationDays>0</d2p1:SubscriptionDurationDays>
          <d2p1:SupportQuantity>0</d2p1:SupportQuantity>
          <d2p1:Total>0</d2p1:Total>
        </d2p1:Subscription>
      </d2p1:Subscriptions>
    </d2p1:Customer>
  </Results>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
</QueryResponseOfCustomertlJ4_P31p>