GetOrderTotals
Returns the totals of accepted orders within a date rangeInput Properties
GetOrderTotalsRequest
Output Properties
GetOrderTotalsResponse
OrderTotalByCurrency
Http Request
Rest call not available for this method yet.
Http Response
Soap Request
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /3.0/ExigoApi.asmx HTTP/1.1 Host: api.exigo.com Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "https://api.exigo.com/GetOrderTotals" <?xml version="1.0" encoding="utf-8"?> <soap:Envelope
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Header> <ApiAuthentication xmlns="http://api.exigo.com/"> <LoginName>string</LoginName> <Password>string</Password> <Company>string</Company> <Identity>string</Identity> <RequestTimeUtc>dateTime</RequestTimeUtc> <Signature>string</Signature> </ApiAuthentication> </soap:Header> <soap:Body> <GetOrderTotalsRequest xmlns="http://api.exigo.com/"> <StartDate>dateTime</StartDate> <EndDate>dateTime</EndDate> </GetOrderTotalsRequest> </soap:Body> </soap:Envelope>
Soap Response
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap:Envelope
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <GetOrderTotalsResult xmlns="http://api.exigo.com/"> <StartDate>dateTime</StartDate> <EndDate>dateTime</EndDate> <AcceptedByCurrency> <OrderTotalByCurrency> <CurrencyCode>string</CurrencyCode> <Amount>decimal</Amount> <Count>int</Count> </OrderTotalByCurrency> </AcceptedByCurrency> </GetOrderTotalsResult> </soap:Body> </soap:Envelope>
C# Rest Client
Install Nuget package Exigo.Api.Client
try
{
//Create Api Client
var api = new ExigoApiClient("yourcmpany", "yourlogin", "yourpassword");
//Create Request
var req = new GetOrderTotalsRequest();
req.StartDate = DateTime.Today;
req.EndDate = DateTime.Today;
//Send Request to Server and Get Response
var res = await api.GetOrderTotalsAsync(req);
//Now examine the results:
Console.WriteLine("StartDate: {0}", res.StartDate);
Console.WriteLine("EndDate: {0}", res.EndDate);
foreach (var orderTotalByCurrency in res.AcceptedByCurrency)
{
Console.WriteLine("CurrencyCode: {0}", orderTotalByCurrency.CurrencyCode);
Console.WriteLine("Amount: {0}", orderTotalByCurrency.Amount);
Console.WriteLine("Count: {0}", orderTotalByCurrency.Count);
}
}
catch (Exception ex)
{
Console.WriteLine("Error: " + ex.Message);
}
C# Soap Client
try
{
//Create Main API Context Object
ExigoApi api = new ExigoApi();
//Create Authentication Header
ApiAuthentication auth = new ApiAuthentication();
auth.LoginName = "yourLoginName";
auth.Password = "yourPassword";
auth.Company = "yourCompany";
api.ApiAuthenticationValue = auth;
//Create Request
GetOrderTotalsRequest req = new GetOrderTotalsRequest();
req.StartDate = DateTime.Today;
req.EndDate = DateTime.Today;
//Send Request to Server and Get Response
GetOrderTotalsResponse res = api.GetOrderTotals(req);
//Now examine the results:
Console.WriteLine("StartDate: {0}", res.StartDate);
Console.WriteLine("EndDate: {0}", res.EndDate);
foreach (OrderTotalByCurrency orderTotalByCurrency in res.AcceptedByCurrency)
{
Console.WriteLine("CurrencyCode: {0}", orderTotalByCurrency.CurrencyCode);
Console.WriteLine("Amount: {0}", orderTotalByCurrency.Amount);
Console.WriteLine("Count: {0}", orderTotalByCurrency.Count);
}
}
catch (Exception ex)
{
Console.WriteLine("Error: " + ex.Message);
}
VB.Net
Try
'Create Main API Context Object
Dim api as new ExigoApi()
'Create Authentication Header
Dim auth as new ApiAuthentication()
auth.LoginName = "yourLoginName"
auth.Password = "yourPassword"
auth.Company = "yourCompany"
api.ApiAuthenticationValue = auth
'Create Request
Dim req as new GetOrderTotalsRequest()
req.StartDate = DateTime.Today
req.EndDate = DateTime.Today
'Send Request to Server and Get Response
Dim res As GetOrderTotalsResponse = api.GetOrderTotals(req)
'Now examine the results:
Console.WriteLine("StartDate: {0}", res.StartDate)
Console.WriteLine("EndDate: {0}", res.EndDate)
For Each orderTotalByCurrency As OrderTotalByCurrency In res.AcceptedByCurrency
Console.WriteLine("CurrencyCode: {0}", orderTotalByCurrency.CurrencyCode)
Console.WriteLine("Amount: {0}", orderTotalByCurrency.Amount)
Console.WriteLine("Count: {0}", orderTotalByCurrency.Count)
Next
Catch ex As Exception
Console.WriteLine("Error: " & ex.Message)
End Try
PHP
Note: PHP is not officially supported.<?php
try
{
//Setup the SoapClient and Authentication
$api = new SoapClient("http://api.exigo.com/3.0/ExigoApi.asmx?WSDL");
$ns = "http://api.exigo.com/";
$auth = array()
$auth["LoginName"] = new SoapVar("yourLoginName",XSD_STRING,null,null,null,$ns);
$auth["Password"] = new SoapVar("yourPassword",XSD_STRING,null,null,null,$ns);
$auth["Company"] = new SoapVar("yourCompany",XSD_STRING,null,null,null,$ns);
$headerBody = new SoapVar($auth, SOAP_ENC_OBJECT);
$header = new SoapHeader($ns, 'ApiAuthentication', $headerBody);
$api->__setSoapHeaders(array($header));
//Create Request
$req->StartDate = 1;
$req->EndDate = 1;
//Send Request to Server and Get Response
$res = $api.GetOrderTotals($req);
//Now examine the results:
}
catch (SoapFault $ex)
{
echo "Error: ", $ex->getMessage();
}
?>
Java
Note: Java is not officially supported.try
{
//Create Main API Context Object
ExigoApi api = new ExigoApi();
//Create Authentication Header
ApiAuthentication auth = new ApiAuthentication();
auth.setLoginName("yourLoginName");
auth.setPassword("yourPassword");
auth.setCompany("yourCompany");
api.setApiAuthenticationValue(auth);
//Create Request
GetOrderTotalsRequest req = new GetOrderTotalsRequest();
req.setStartDate(1);
req.setEndDate(1);
//Send Request to Server and Get Response
GetOrderTotalsResponse res = api.getExigoApiSoap().getOrderTotals(req, auth);
//Now examine the results:
}
catch (Exception ex)
{
System.out.println("Error: " + ex.getMessage());
}
CSV
HTTP Get Request:
https://api.exigo.com/3.0/csv/?method=GetOrderTotals
&ApiLoginName=String
&ApiPassword=String
&ApiCompany=String
&StartDate=DateTime
&EndDate=DateTime
Response Fields
StartDate,EndDate,CurrencyCode,Amount,Count
DateTime,DateTime,String,Decimal,Int32