Order Summary Get Order Summary by passing required parameter.
Key | Value |
---|---|
URL | https://api.ovvihq.com/OrderSummary |
APIKey | Provided by OVVI |
StartDate | MM/dd/yyyy hh:mm tt" (Ex:-12/18/2019 12:00 AM) |
EndDate | MM/dd/yyyy hh:mm tt" (Ex:-12/20/2019 11:59 PM) |
- public string GetOrderSummary()
- {
- get
- {
- string strResult = string.Empty;
- try
- {
- HttpWebRequest request = (HttpWebRequest)WebRequest.Create("https://api.ovvihq.com/OrderSummary");
- request.ContentType = "application/json";
- request.Method = "GET";
- request.Headers.Add("APIKey", "Provided by OVVI");
- request.Headers.Add("StartDate", "01/01/2019 12:00 AM"); // MM/dd/yyyy hh:mm tt
- request.Headers.Add("EndDate", "01/02/2019 11:59 PM"); // MM/dd/yyyy hh:mm tt
- // Set some reasonable limits on resources used by this request
- request.ContentLength = 0;
- // Set credentials to use for this request.
- request.Credentials = CredentialCache.DefaultCredentials;
- HttpWebResponse response = (HttpWebResponse)request.GetResponse();
- // Get the stream associated with the response.
- Stream receiveStream = response.GetResponseStream();
- // Pipes the stream to a higher level stream reader with the required encoding format.
- StreamReader readStream = new StreamReader(receiveStream, Encoding.UTF8);
- strResult = readStream.ReadToEnd().ToString();
- response.Close();
- readStream.Close();
- return strResult;
- }
- catch (Exception ex)
- {
- strResult = Convert.ToString(ex.Message);
- return strResult;
- }
- }
- }
Key | Data Type | Description |
---|---|---|
TransactionNumber | bigint | Transaction/Invoice Number/ID |
TransactionTimeStamp | DateTime | Transaction/Invoice generated date |
Store Code | nvarchar(10) | Store Id/Number. |
Destination | nvarchar(2) | Transaction/Invocie type/destination(ex. Dine In,To Go,Online order etc..). |
RegistredEmployee | nvarchar(10) | Employee Id/Number who process the transaction. |
TransactionStatus | nvarchar(1) | Transaction status(ex. Open,Closed,Void etc..). |
Total | money | Total amount of the transaction without calculate tax amount. |
SalesTax | money | Sales tax amount. |
Tax2 | money | Tax2 amount. |
Tax3 | money | Tax3 amount. |
TotalTax | money | Total tax amount. |
SalesDollars | money | Total payable amount of the transaction including tax amount. |
DiscountDollars | decimal(10,2) | Given discounted amount of Transaction/Invoice. |
TendorAmount | money | Entered amount for the payment. |
Change | money | Change amount. |
Cash | money | Amount paid by cash. |
Credit Card | money | Amount paid by credit card. |
Check | money | Amount paid by check. |
Debit Card | money | Amount paid by debit card. |
Gift Card | money | Amount paid by gift card. |
Tendor | nvarchar(4) | Transaction/Invoice payment type(ex.payment done by cash,credit or debit or other payment type). |
Other | string | Amount paid by Other payment type(ex. ubereat,doordash etc..). |