ServiceStack Home (Live)

<back to all web services

ViewOrder

Requires Authentication
The following routes are available for this service:
All Verbs/account/orders/{Id}
GET/ViewOrder
GET/ViewOrder/{Id}
"use strict";
export class ViewOrder {
    /** @param {{id?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    id;
}
/** @typedef {'Product'|'PerDev'|'PerCore'|'Site'|'Support'|'Training'|'Register'|'Payment'} */
export var SkuType;
(function (SkuType) {
    SkuType["Product"] = "Product"
    SkuType["PerDev"] = "PerDev"
    SkuType["PerCore"] = "PerCore"
    SkuType["Site"] = "Site"
    SkuType["Support"] = "Support"
    SkuType["Training"] = "Training"
    SkuType["Register"] = "Register"
    SkuType["Payment"] = "Payment"
})(SkuType || (SkuType = {}));
export class OrderDetail {
    /** @param {{id?:number,orderId?:number,skuId?:number,skuType?:SkuType,price?:number,description?:string,quantity?:number,total?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    id;
    /** @type {number} */
    orderId;
    /** @type {number} */
    skuId;
    /** @type {SkuType} */
    skuType;
    /** @type {number} */
    price;
    /** @type {string} */
    description;
    /** @type {number} */
    quantity;
    /** @type {number} */
    total;
}
export class Order {
    /** @param {{id?:number,customerId?:number,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?:boolean,notes?:string,last4?:string,subTotal?:number,couponId?:string,discount?:number,tax?:number,total?:number,itemQuantity?:number,authorizedQuantity?:number,subscriptionId?:number,licenseRef?:string,paymentId?:number,emailId?:number,paid?:boolean,createdDate?:string,modifiedDate?:string,modifiedBy?:string,cancelledDate?:string,cancelledReason?:string,ipAddress?:string,orderDetails?:OrderDetail[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    id;
    /** @type {number} */
    customerId;
    /** @type {string} */
    productName;
    /** @type {string} */
    firstName;
    /** @type {string} */
    lastName;
    /** @type {string} */
    email;
    /** @type {string} */
    company;
    /** @type {string} */
    phoneNumber;
    /** @type {string} */
    addressLine1;
    /** @type {string} */
    addressLine2;
    /** @type {string} */
    addressCity;
    /** @type {string} */
    addressZip;
    /** @type {string} */
    addressState;
    /** @type {string} */
    addressCountry;
    /** @type {boolean} */
    agreeTerms;
    /** @type {string} */
    notes;
    /** @type {string} */
    last4;
    /** @type {number} */
    subTotal;
    /** @type {string} */
    couponId;
    /** @type {number} */
    discount;
    /** @type {number} */
    tax;
    /** @type {number} */
    total;
    /** @type {number} */
    itemQuantity;
    /** @type {?number} */
    authorizedQuantity;
    /** @type {?number} */
    subscriptionId;
    /** @type {string} */
    licenseRef;
    /** @type {?number} */
    paymentId;
    /** @type {?number} */
    emailId;
    /** @type {boolean} */
    paid;
    /** @type {string} */
    createdDate;
    /** @type {string} */
    modifiedDate;
    /** @type {string} */
    modifiedBy;
    /** @type {?string} */
    cancelledDate;
    /** @type {string} */
    cancelledReason;
    /** @type {string} */
    ipAddress;
    /** @type {OrderDetail[]} */
    orderDetails;
}

JavaScript ViewOrder 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 /account/orders/{Id} HTTP/1.1 
Host: account.servicestack.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ViewOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyApp.ServiceModel">
  <Id>0</Id>
</ViewOrder>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<Order xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyApp.ServiceModel">
  <AddressCity>String</AddressCity>
  <AddressCountry>String</AddressCountry>
  <AddressLine1>String</AddressLine1>
  <AddressLine2>String</AddressLine2>
  <AddressState>String</AddressState>
  <AddressZip>String</AddressZip>
  <AgreeTerms>false</AgreeTerms>
  <AuthorizedQuantity>0</AuthorizedQuantity>
  <CancelledDate>0001-01-01T00:00:00</CancelledDate>
  <CancelledReason>String</CancelledReason>
  <Company>String</Company>
  <CouponId>String</CouponId>
  <CreatedDate>0001-01-01T00:00:00</CreatedDate>
  <CustomerId>0</CustomerId>
  <Discount>0</Discount>
  <Email>String</Email>
  <EmailId>0</EmailId>
  <FirstName>String</FirstName>
  <Id>0</Id>
  <IpAddress>String</IpAddress>
  <ItemQuantity>0</ItemQuantity>
  <Last4>String</Last4>
  <LastName>String</LastName>
  <LicenseRef>String</LicenseRef>
  <ModifiedBy>String</ModifiedBy>
  <ModifiedDate>0001-01-01T00:00:00</ModifiedDate>
  <Notes>String</Notes>
  <OrderDetails>
    <OrderDetail>
      <Description>String</Description>
      <Id>0</Id>
      <OrderId>0</OrderId>
      <Price>0</Price>
      <Quantity>0</Quantity>
      <SkuId>0</SkuId>
      <SkuType>Product</SkuType>
      <Total>0</Total>
    </OrderDetail>
  </OrderDetails>
  <Paid>false</Paid>
  <PaymentId>0</PaymentId>
  <PhoneNumber>String</PhoneNumber>
  <ProductName>String</ProductName>
  <SubTotal>0</SubTotal>
  <SubscriptionId>0</SubscriptionId>
  <Tax>0</Tax>
  <Total>0</Total>
</Order>