ServiceStack Home (Live)

QueryCustomers

Admin

**Requires Authentication**
Required role:	Admin

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

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryBase:
    skip: Optional[int] = None
    take: Optional[int] = None
    order_by: Optional[str] = None
    order_by_desc: Optional[str] = None
    include: Optional[str] = None
    fields: Optional[str] = None
    meta: Optional[Dict[str, str]] = None


T = TypeVar('T')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryDb(Generic[T], QueryBase, IReturn[QueryResponse[T]]):
    @staticmethod
    def response_type(): return QueryResponse[T]


class SkuType(str, Enum):
    PRODUCT = 'Product'
    PER_DEV = 'PerDev'
    PER_CORE = 'PerCore'
    SITE = 'Site'
    SUPPORT = 'Support'
    TRAINING = 'Training'
    REGISTER = 'Register'
    PAYMENT = 'Payment'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OrderDetail:
    id: int = 0
    order_id: int = 0
    sku_id: int = 0
    sku_type: Optional[SkuType] = None
    price: int = 0
    description: Optional[str] = None
    quantity: int = 0
    total: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Order(IAddress):
    id: int = 0
    customer_id: int = 0
    product_name: Optional[str] = None
    first_name: Optional[str] = None
    last_name: Optional[str] = None
    email: Optional[str] = None
    company: Optional[str] = None
    phone_number: Optional[str] = None
    address_line1: Optional[str] = None
    address_line2: Optional[str] = None
    address_city: Optional[str] = None
    address_zip: Optional[str] = None
    address_state: Optional[str] = None
    address_country: Optional[str] = None
    agree_terms: bool = False
    notes: Optional[str] = None
    last4: Optional[str] = None
    sub_total: int = 0
    coupon_id: Optional[str] = None
    discount: int = 0
    tax: int = 0
    total: int = 0
    item_quantity: int = 0
    authorized_quantity: Optional[int] = None
    subscription_id: Optional[int] = None
    license_ref: Optional[str] = None
    payment_id: Optional[int] = None
    email_id: Optional[int] = None
    paid: bool = False
    created_date: datetime.datetime = datetime.datetime(1, 1, 1)
    modified_date: datetime.datetime = datetime.datetime(1, 1, 1)
    modified_by: Optional[str] = None
    cancelled_date: Optional[datetime.datetime] = None
    cancelled_reason: Optional[str] = None
    ip_address: Optional[str] = None
    order_details: Optional[List[OrderDetail]] = None


class LicenseType(str, Enum):
    FREE = 'Free'
    FREE_INDIVIDUAL = 'FreeIndividual'
    FREE_OPEN_SOURCE = 'FreeOpenSource'
    INDIE = 'Indie'
    BUSINESS = 'Business'
    ENTERPRISE = 'Enterprise'
    TEXT_INDIE = 'TextIndie'
    TEXT_BUSINESS = 'TextBusiness'
    ORM_LITE_INDIE = 'OrmLiteIndie'
    ORM_LITE_BUSINESS = 'OrmLiteBusiness'
    REDIS_INDIE = 'RedisIndie'
    REDIS_BUSINESS = 'RedisBusiness'
    AWS_INDIE = 'AwsIndie'
    AWS_BUSINESS = 'AwsBusiness'
    TRIAL = 'Trial'
    SITE = 'Site'
    TEXT_SITE = 'TextSite'
    REDIS_SITE = 'RedisSite'
    ORM_LITE_SITE = 'OrmLiteSite'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LicenseKey:
    ref: Optional[str] = None
    name: Optional[str] = None
    type: Optional[LicenseType] = None
    meta: int = 0
    hash: Optional[str] = None
    halg: Optional[str] = None
    expiry: datetime.datetime = datetime.datetime(1, 1, 1)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Subscription:
    id: int = 0
    customer_id: int = 0
    email: Optional[str] = None
    sku_id: int = 0
    sku_name: Optional[str] = None
    sku_type: Optional[SkuType] = None
    code: Optional[str] = None
    quantity: int = 0
    support_quantity: int = 0
    total: int = 0
    is_plan: bool = False
    is_renewal: bool = False
    subscription_duration_days: int = 0
    renewal_date: Optional[datetime.datetime] = None
    license_ref: Optional[str] = None
    license_name: Optional[str] = None
    license_address: Optional[str] = None
    license_type: Optional[LicenseType] = None
    expiry_date: datetime.datetime = datetime.datetime(1, 1, 1)
    license_key: Optional[LicenseKey] = None
    license_key_text: Optional[str] = None
    created_date: datetime.datetime = datetime.datetime(1, 1, 1)
    modified_date: datetime.datetime = datetime.datetime(1, 1, 1)
    cancelled_date: Optional[datetime.datetime] = None
    stripe_subscription_id: Optional[str] = None
    email_id: Optional[int] = None
    email_renewal_id: Optional[int] = None
    email_expired_id: Optional[int] = None
    renewal_subscription_id: Optional[int] = None
    external_ref: Optional[str] = None
    notes: Optional[str] = None
    error: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Customer(IAddress):
    id: int = 0
    email: Optional[str] = None
    display_name: Optional[str] = None
    first_name: Optional[str] = None
    last_name: Optional[str] = None
    company: Optional[str] = None
    phone_number: Optional[str] = None
    address_line1: Optional[str] = None
    address_line2: Optional[str] = None
    address_city: Optional[str] = None
    address_zip: Optional[str] = None
    address_state: Optional[str] = None
    address_country: Optional[str] = None
    stripe_customer_id: Optional[str] = None
    stripe_coupon_id: Optional[str] = None
    plan: Optional[str] = None
    created_date: datetime.datetime = datetime.datetime(1, 1, 1)
    is_referrer: bool = False
    orders: Optional[List[Order]] = None
    subscriptions: Optional[List[Subscription]] = None


# @ValidateRequest(Validator="IsAdmin")
# @AutoQueryViewer(DefaultFields="Id,Name,Email,DisplayName,FirstName,LastName,Company,CreatedDate,Plan,IsReferrer", DefaultSearchField="Email", DefaultSearchType="Contains", IconUrl="material-icons:person", Title="Customers")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryCustomers(QueryDb[Customer]):
    pass


T = TypeVar('T')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryResponse(Generic[T]):
    offset: int = 0
    total: int = 0
    results: List[Customer] = field(default_factory=list)
    meta: Optional[Dict[str, str]] = None
    response_status: Optional[ResponseStatus] = None

Python QueryCustomers DTOs

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>