Order Summary Get Order Summary by passing required parameter.

GET /Order Summary
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)
                                
  1. public string GetOrderSummary()
  2. {
  3. get
  4. {
  5. string strResult = string.Empty;
  6. try
  7. {
  8. HttpWebRequest request = (HttpWebRequest)WebRequest.Create("https://api.ovvihq.com/OrderSummary");
  9. request.ContentType = "application/json";
  10. request.Method = "GET";
  11. request.Headers.Add("APIKey", "Provided by OVVI");
  12. request.Headers.Add("StartDate", "01/01/2019 12:00 AM"); // MM/dd/yyyy hh:mm tt
  13. request.Headers.Add("EndDate", "01/02/2019 11:59 PM"); // MM/dd/yyyy hh:mm tt
  14. // Set some reasonable limits on resources used by this request
  15. request.ContentLength = 0;
  16. // Set credentials to use for this request.
  17. request.Credentials = CredentialCache.DefaultCredentials;
  18. HttpWebResponse response = (HttpWebResponse)request.GetResponse();
  19. // Get the stream associated with the response.
  20. Stream receiveStream = response.GetResponseStream();
  21. // Pipes the stream to a higher level stream reader with the required encoding format.
  22. StreamReader readStream = new StreamReader(receiveStream, Encoding.UTF8);
  23. strResult = readStream.ReadToEnd().ToString();
  24. response.Close();
  25. readStream.Close();
  26. return strResult;
  27. }
  28. catch (Exception ex)
  29. {
  30. strResult = Convert.ToString(ex.Message);
  31. return strResult;
  32. }
  33. }
  34. }
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..).