ServiceStack Home (Live)

<back to all web services

QueryOrders

Admin
Requires Authentication
Required role:Admin
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
Order Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
CustomerIdformintNo
ProductNameformstringNo
FirstNameformstringNo
LastNameformstringNo
EmailformstringNo
CompanyformstringNo
PhoneNumberformstringNo
AddressLine1formstringNo
AddressLine2formstringNo
AddressCityformstringNo
AddressZipformstringNo
AddressStateformstringNo
AddressCountryformstringNo
AgreeTermsformboolNo
NotesformstringNo
Last4formstringNo
SubTotalformintNo
CouponIdformstringNo
DiscountformintNo
TaxformintNo
TotalformintNo
ItemQuantityformintNo
AuthorizedQuantityformint?No
SubscriptionIdformint?No
LicenseRefformstringNo
PaymentIdformint?No
EmailIdformint?No
PaidformboolNo
CreatedDateformDateTimeNo
ModifiedDateformDateTimeNo
ModifiedByformstringNo
CancelledDateformDateTime?No
CancelledReasonformstringNo
IpAddressformstringNo
OrderDetailsformList<OrderDetail>No
OrderDetail Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
OrderIdformintNo
SkuIdformintNo
SkuTypeformSkuTypeNo
PriceformintNo
DescriptionformstringNo
QuantityformintNo
TotalformintNo
SkuType Enum:
Product
PerDev
PerCore
Site
Support
Training
Register
Payment
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<Customer>Yes
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
Customer Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
EmailformstringNo
DisplayNameformstringNo
FirstNameformstringNo
LastNameformstringNo
CompanyformstringNo
PhoneNumberformstringNo
AddressLine1formstringNo
AddressLine2formstringNo
AddressCityformstringNo
AddressZipformstringNo
AddressStateformstringNo
AddressCountryformstringNo
StripeCustomerIdformstringNo
StripeCouponIdformstringNo
PlanformstringNo
CreatedDateformDateTimeNo
IsReferrerformboolNo
OrdersformList<Order>No
SubscriptionsformList<Subscription>No
Subscription Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
CustomerIdformintNo
EmailformstringNo
SkuIdformintNo
SkuNameformstringNo
SkuTypeformSkuTypeNo
CodeformstringNo
QuantityformintNo
SupportQuantityformintNo
TotalformintNo
IsPlanformboolNo
IsRenewalformboolNo
SubscriptionDurationDaysformintNo
RenewalDateformDateTime?No
LicenseRefformstringNo
LicenseNameformstringNo
LicenseAddressformstringNo
LicenseTypeformLicenseTypeNo
ExpiryDateformDateTimeNo
LicenseKeyformLicenseKeyNo
LicenseKeyTextformstringNo
CreatedDateformDateTimeNo
ModifiedDateformDateTimeNo
CancelledDateformDateTime?No
StripeSubscriptionIdformstringNo
EmailIdformint?No
EmailRenewalIdformint?No
EmailExpiredIdformint?No
RenewalSubscriptionIdformint?No
ExternalRefformstringNo
NotesformstringNo
ErrorformstringNo
LicenseType Enum:
Free
FreeIndividual
FreeOpenSource
Indie
Business
Enterprise
TextIndie
TextBusiness
OrmLiteIndie
OrmLiteBusiness
RedisIndie
RedisBusiness
AwsIndie
AwsBusiness
Trial
Site
TextSite
RedisSite
OrmLiteSite
LicenseKey Parameters:
NameParameterData TypeRequiredDescription
RefformstringNo
NameformstringNo
TypeformLicenseTypeNo
MetaformlongNo
HashformstringNo
HalgformstringNo
ExpiryformDateTimeNo

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

HTTP + OTHER

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

POST /jsonl/reply/QueryOrders HTTP/1.1 
Host: account.servicestack.net 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"skip":0,"take":0,"orderBy":"String","orderByDesc":"String","include":"String","fields":"String","meta":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"offset":0,"total":0,"results":[{"id":0,"customerId":0,"productName":"String","firstName":"String","lastName":"String","email":"String","company":"String","phoneNumber":"String","addressLine1":"String","addressLine2":"String","addressCity":"String","addressZip":"String","addressState":"String","addressCountry":"String","agreeTerms":false,"notes":"String","last4":"String","subTotal":0,"couponId":"String","discount":0,"tax":0,"total":0,"itemQuantity":0,"authorizedQuantity":0,"subscriptionId":0,"licenseRef":"String","paymentId":0,"emailId":0,"paid":false,"createdDate":"\/Date(-62135596800000-0000)\/","modifiedDate":"\/Date(-62135596800000-0000)\/","modifiedBy":"String","cancelledDate":"\/Date(-62135596800000-0000)\/","cancelledReason":"String","ipAddress":"String","orderDetails":[{"id":0,"orderId":0,"skuId":0,"skuType":"Product","price":0,"description":"String","quantity":0,"total":0}]}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}