Exigo Web Services API v3.4.244

GetOrders

Returns one or more orders. You can submit several optional filter fields to control the results.

Input Properties

GetOrdersRequest
PropertyData TypeNotes
CustomerIDInt32Optional.
OrderIDInt32Optional.
OrderIDsInt32[]Optionally supply a list to return off of.
OrderDateStartDateTimeOptional. If supplied only orders greater than or equal to will be returned.
OrderDateEndDateTimeOptional.
OrderStatus OrderStatusTypeOptional.
WarehouseID Int32Optional. Unique location for orders.
CurrencyCode StringOptional.
ReturnCustomerBooleanOptional. Optionally return full customer info with every order.
ReturnKitDetailsBooleanOptional. Optionally return bill of material for kits.
GreaterThanOrderIDInt32Optional.
GreaterThanModifiedDateDateTimeOptional.
BatchSizeInt32Optional. Defaults to 100 orders at a time.
Other11StringOptional.
Other12StringOptional.
Other13StringOptional.
Other14StringOptional.
Other15StringOptional.
Other16StringOptional.
Other17StringOptional.
Other18StringOptional.
Other19StringOptional.
Other20StringOptional.
PartyIDInt32Optional.

Output Properties

GetOrdersResponse
PropertyData TypeNotes
OrdersOrderResponse[]
RecordCountInt32
OrderResponse
PropertyData TypeNotes
OrderIDInt32
CustomerIDInt32
OrderStatus OrderStatusType
OrderDateDateTime
CurrencyCode String
WarehouseID Int32Unique location for orders.
ShipMethodID Int32
PriceType Int32Controls which price band to use.
FirstNameString
LastNameString
CompanyString
Address1String
Address2String
Address3String
CityString
StateString
ZipString
CountryString
CountyString
EmailString
PhoneString
NotesString
TotalDecimal
SubTotalDecimal
TaxTotalDecimal
ShippingTotalDecimal
DiscountTotalDecimal
DiscountPercentDecimal
WeightTotalDecimal
BusinessVolumeTotalDecimal
CommissionableVolumeTotalDecimal
TrackingNumber1String
TrackingNumber2String
TrackingNumber3String
TrackingNumber4String
TrackingNumber5String
Other1TotalDecimal
Other2TotalDecimal
Other3TotalDecimal
Other4TotalDecimal
Other5TotalDecimal
Other6TotalDecimal
Other7TotalDecimal
Other8TotalDecimal
Other9TotalDecimal
Other10TotalDecimal
ShippingTaxDecimal
OrderTaxDecimal
FedTaxTotalDecimal
StateTaxTotalDecimal
FedShippingTaxDecimal
StateShippingTaxDecimal
CityShippingTaxDecimal
CityLocalShippingTaxDecimal
CountyShippingTaxDecimal
CountyLocalShippingTaxDecimal
Other11String
Other12String
Other13String
Other14String
Other15String
Other16String
Other17String
Other18String
Other19String
Other20String
ModifiedDateDateTime
OrderType OrderType
ShippedDateDateTime
CreatedDateDateTime
CreatedByString
ModifiedByString
TaxFedRateDecimal
TaxStateRateDecimal
TaxCityRateDecimal
TaxCityLocalRateDecimal
TaxCountyRateDecimal
TaxCountyLocalRateDecimal
TaxManualRateDecimal
TaxCityString
TaxCountyString
TaxStateString
TaxZipString
TaxCountryString
TaxIsExemptBoolean
TaxIsOverRideBoolean
DetailsOrderDetailResponse[]
PaymentsPaymentResponse[]
ExpectedPaymentsExpectedPaymentResponse[]
CustomerCustomerResponseOptional customer record.
MiddleNameString
NameSuffixString
AutoOrderIDInt32AutoOrderID from which this order was generated, if applicable.
PartyIDInt32PartyID, if applicable.
Reference1StringReference1.
IsRMABoolean
OrderDetailResponse
PropertyData TypeNotes
ItemCode String
DescriptionString
QuantityDecimal
PriceEachDecimal
PriceTotalDecimal
TaxDecimal
WeightEachDecimal
WeightDecimal
BusinessVolumeEachDecimal
BusinesVolumeDecimal
CommissionableVolumeEachDecimal
CommissionableVolumeDecimal
Other1EachDecimal
Other1 Decimal
Other2EachDecimal
Other2 Decimal
Other3EachDecimal
Other3 Decimal
Other4EachDecimal
Other4 Decimal
Other5EachDecimal
Other5 Decimal
Other6EachDecimal
Other6 Decimal
Other7EachDecimal
Other7 Decimal
Other8EachDecimal
Other8 Decimal
Other9EachDecimal
Other9 Decimal
Other10EachDecimal
Other10 Decimal
ParentItemCodeString
TaxableDecimal
FedTaxDecimal
StateTaxDecimal
CityTaxDecimal
CityLocalTaxDecimal
CountyTaxDecimal
CountyLocalTaxDecimal
ManualTaxDecimal
IsStateTaxOverrideBoolean
OrderLineInt32
Reference1String
PaymentResponse
PropertyData TypeNotes
PaymentIDInt32
CustomerIDInt32
PaymentType PaymentType
PaymentDateDateTime
AmountDecimal
OrderIDInt32
CurrencyCodeString
BillingNameString
BillingAddress1String
BillingAddress2String
BillingCityString
BillingState String
BillingZipString
BillingCountry String
BankNameString
MemoString
CreditCardNumberDisplayString
AuthorizationCodeString
CreditCardType Int32Optionally pass in Visa, Master Card, etc.
CreditCardTypeDescriptionString
ExpectedPaymentResponse
PropertyData TypeNotes
ExpectedPaymentIDInt32
CustomerIDInt32
PaymentType PaymentType
PaymentDateDateTime
AmountDecimal
OrderIDInt32
CurrencyCodeString
BillingNameString
AuthorizationCodeString

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: "http://api.exigo.com/GetOrders"

<?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> <GetOrdersRequest xmlns="http://api.exigo.com/"> <CustomerID>int</CustomerID> <OrderID>int</OrderID> <OrderIDs> <int>int</int> </OrderIDs> <OrderDateStart>dateTime</OrderDateStart> <OrderDateEnd>dateTime</OrderDateEnd> <OrderStatus>Incomplete or Pending or CCDeclined or ACHDeclined or Canceled or CCPending or ACHPending or Accepted or Printed or Shipped or PendingInventory</OrderStatus> <WarehouseID>int</WarehouseID> <CurrencyCode>string</CurrencyCode> <ReturnCustomer>boolean</ReturnCustomer> <ReturnKitDetails>boolean</ReturnKitDetails> <GreaterThanOrderID>int</GreaterThanOrderID> <GreaterThanModifiedDate>dateTime</GreaterThanModifiedDate> <BatchSize>int</BatchSize> <Other11>string</Other11> <Other12>string</Other12> <Other13>string</Other13> <Other14>string</Other14> <Other15>string</Other15> <Other16>string</Other16> <Other17>string</Other17> <Other18>string</Other18> <Other19>string</Other19> <Other20>string</Other20> <PartyID>int</PartyID> </GetOrdersRequest> </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> <GetOrdersResult xmlns="http://api.exigo.com/"> <Orders> <OrderResponse> <OrderID>int</OrderID> <CustomerID>int</CustomerID> <OrderStatus>Incomplete or Pending or CCDeclined or ACHDeclined or Canceled or CCPending or ACHPending or Accepted or Printed or Shipped or PendingInventory</OrderStatus> <OrderDate>dateTime</OrderDate> <CurrencyCode>string</CurrencyCode> <WarehouseID>int</WarehouseID> <ShipMethodID>int</ShipMethodID> <PriceType>int</PriceType> <FirstName>string</FirstName> <LastName>string</LastName> <Company>string</Company> <Address1>string</Address1> <Address2>string</Address2> <Address3>string</Address3> <City>string</City> <State>string</State> <Zip>string</Zip> <Country>string</Country> <County>string</County> <Email>string</Email> <Phone>string</Phone> <Notes>string</Notes> <Total>decimal</Total> <SubTotal>decimal</SubTotal> <TaxTotal>decimal</TaxTotal> <ShippingTotal>decimal</ShippingTotal> <DiscountTotal>decimal</DiscountTotal> <DiscountPercent>decimal</DiscountPercent> <WeightTotal>decimal</WeightTotal> <BusinessVolumeTotal>decimal</BusinessVolumeTotal> <CommissionableVolumeTotal>decimal</CommissionableVolumeTotal> <TrackingNumber1>string</TrackingNumber1> <TrackingNumber2>string</TrackingNumber2> <TrackingNumber3>string</TrackingNumber3> <TrackingNumber4>string</TrackingNumber4> <TrackingNumber5>string</TrackingNumber5> <Other1Total>decimal</Other1Total> <Other2Total>decimal</Other2Total> <Other3Total>decimal</Other3Total> <Other4Total>decimal</Other4Total> <Other5Total>decimal</Other5Total> <Other6Total>decimal</Other6Total> <Other7Total>decimal</Other7Total> <Other8Total>decimal</Other8Total> <Other9Total>decimal</Other9Total> <Other10Total>decimal</Other10Total> <ShippingTax>decimal</ShippingTax> <OrderTax>decimal</OrderTax> <FedTaxTotal>decimal</FedTaxTotal> <StateTaxTotal>decimal</StateTaxTotal> <FedShippingTax>decimal</FedShippingTax> <StateShippingTax>decimal</StateShippingTax> <CityShippingTax>decimal</CityShippingTax> <CityLocalShippingTax>decimal</CityLocalShippingTax> <CountyShippingTax>decimal</CountyShippingTax> <CountyLocalShippingTax>decimal</CountyLocalShippingTax> <Other11>string</Other11> <Other12>string</Other12> <Other13>string</Other13> <Other14>string</Other14> <Other15>string</Other15> <Other16>string</Other16> <Other17>string</Other17> <Other18>string</Other18> <Other19>string</Other19> <Other20>string</Other20> <ModifiedDate>dateTime</ModifiedDate> <OrderType>Default or CustomerService or ShoppingCart or WebWizard or AutoOrder or Import or BackOrder or ReplacementOrder or ReturnOrder or WebAutoOrder or TicketSystem or APIOrder or BackOrderParent or ChildOrder or Other1 or Other2 or Other3 or Other4</OrderType> <ShippedDate>dateTime</ShippedDate> <CreatedDate>dateTime</CreatedDate> <CreatedBy>string</CreatedBy> <ModifiedBy>string</ModifiedBy> <TaxFedRate>decimal</TaxFedRate> <TaxStateRate>decimal</TaxStateRate> <TaxCityRate>decimal</TaxCityRate> <TaxCityLocalRate>decimal</TaxCityLocalRate> <TaxCountyRate>decimal</TaxCountyRate> <TaxCountyLocalRate>decimal</TaxCountyLocalRate> <TaxManualRate>decimal</TaxManualRate> <TaxCity>string</TaxCity> <TaxCounty>string</TaxCounty> <TaxState>string</TaxState> <TaxZip>string</TaxZip> <TaxCountry>string</TaxCountry> <TaxIsExempt>boolean</TaxIsExempt> <TaxIsOverRide>boolean</TaxIsOverRide> <Details> <OrderDetailResponse> <ItemCode>string</ItemCode> <Description>string</Description> <Quantity>decimal</Quantity> <PriceEach>decimal</PriceEach> <PriceTotal>decimal</PriceTotal> <Tax>decimal</Tax> <WeightEach>decimal</WeightEach> <Weight>decimal</Weight> <BusinessVolumeEach>decimal</BusinessVolumeEach> <BusinesVolume>decimal</BusinesVolume> <CommissionableVolumeEach>decimal</CommissionableVolumeEach> <CommissionableVolume>decimal</CommissionableVolume> <Other1Each>decimal</Other1Each> <Other1>decimal</Other1> <Other2Each>decimal</Other2Each> <Other2>decimal</Other2> <Other3Each>decimal</Other3Each> <Other3>decimal</Other3> <Other4Each>decimal</Other4Each> <Other4>decimal</Other4> <Other5Each>decimal</Other5Each> <Other5>decimal</Other5> <Other6Each>decimal</Other6Each> <Other6>decimal</Other6> <Other7Each>decimal</Other7Each> <Other7>decimal</Other7> <Other8Each>decimal</Other8Each> <Other8>decimal</Other8> <Other9Each>decimal</Other9Each> <Other9>decimal</Other9> <Other10Each>decimal</Other10Each> <Other10>decimal</Other10> <ParentItemCode>string</ParentItemCode> <Taxable>decimal</Taxable> <FedTax>decimal</FedTax> <StateTax>decimal</StateTax> <CityTax>decimal</CityTax> <CityLocalTax>decimal</CityLocalTax> <CountyTax>decimal</CountyTax> <CountyLocalTax>decimal</CountyLocalTax> <ManualTax>decimal</ManualTax> <IsStateTaxOverride>boolean</IsStateTaxOverride> <OrderLine>int</OrderLine> <Reference1>string</Reference1> </OrderDetailResponse> </Details> <Payments> <PaymentResponse> <PaymentID>int</PaymentID> <CustomerID>int</CustomerID> <PaymentType>Cash or CreditCard or Check or CreditVoucher or Net30 or Net60 or ACHDebit or UseCredit or BankDraft or BankWire or PointRedemtion or COD or MoneyOrder or BankDeposit or Other1 or Other2 or Other3 or Wallet</PaymentType> <PaymentDate>dateTime</PaymentDate> <Amount>decimal</Amount> <OrderID>int</OrderID> <CurrencyCode>string</CurrencyCode> <BillingName>string</BillingName> <BillingAddress1>string</BillingAddress1> <BillingAddress2>string</BillingAddress2> <BillingCity>string</BillingCity> <BillingState>string</BillingState> <BillingZip>string</BillingZip> <BillingCountry>string</BillingCountry> <BankName>string</BankName> <Memo>string</Memo> <CreditCardNumberDisplay>string</CreditCardNumberDisplay> <AuthorizationCode>string</AuthorizationCode> <CreditCardType>int</CreditCardType> <CreditCardTypeDescription>string</CreditCardTypeDescription> </PaymentResponse> </Payments> <ExpectedPayments> <ExpectedPaymentResponse> <ExpectedPaymentID>int</ExpectedPaymentID> <CustomerID>int</CustomerID> <PaymentType>Cash or CreditCard or Check or CreditVoucher or Net30 or Net60 or ACHDebit or UseCredit or BankDraft or BankWire or PointRedemtion or COD or MoneyOrder or BankDeposit or Other1 or Other2 or Other3 or Wallet</PaymentType> <PaymentDate>dateTime</PaymentDate> <Amount>decimal</Amount> <OrderID>int</OrderID> <CurrencyCode>string</CurrencyCode> <BillingName>string</BillingName> <AuthorizationCode>string</AuthorizationCode> </ExpectedPaymentResponse> </ExpectedPayments> <Customer> <CustomerID>int</CustomerID> <FirstName>string</FirstName> <LastName>string</LastName> <Company>string</Company> <CustomerType>int</CustomerType> <CustomerStatus>int</CustomerStatus> <Email>string</Email> <Phone>string</Phone> <Phone2>string</Phone2> <MobilePhone>string</MobilePhone> <Fax>string</Fax> <MainAddress1>string</MainAddress1> <MainAddress2>string</MainAddress2> <MainCity>string</MainCity> <MainState>string</MainState> <MainZip>string</MainZip> <MainCountry>string</MainCountry> <MainCounty>string</MainCounty> <MailAddress1>string</MailAddress1> <MailAddress2>string</MailAddress2> <MailCity>string</MailCity> <MailState>string</MailState> <MailZip>string</MailZip> <MailCountry>string</MailCountry> <MailCounty>string</MailCounty> <OtherAddress1>string</OtherAddress1> <OtherAddress2>string</OtherAddress2> <OtherCity>string</OtherCity> <OtherState>string</OtherState> <OtherZip>string</OtherZip> <OtherCountry>string</OtherCountry> <OtherCounty>string</OtherCounty> <LoginName>string</LoginName> <EnrollerID>int</EnrollerID> <SponsorID>int</SponsorID> <RankID>int</RankID> <BirthDate>dateTime</BirthDate> <Field1>string</Field1> <Field2>string</Field2> <Field3>string</Field3> <Field4>string</Field4> <Field5>string</Field5> <Field6>string</Field6> <Field7>string</Field7> <Field8>string</Field8> <Field9>string</Field9> <Field10>string</Field10> <Field11>string</Field11> <Field12>string</Field12> <Field13>string</Field13> <Field14>string</Field14> <Field15>string</Field15> <Date1>dateTime</Date1> <Date2>dateTime</Date2> <Date3>dateTime</Date3> <Date4>dateTime</Date4> <Date5>dateTime</Date5> <CurrencyCode>string</CurrencyCode> <PayableToName>string</PayableToName> <DefaultWarehouseID>int</DefaultWarehouseID> <PayableType>Check or WireTransfer or PaymentCard or DirectDeposit or OnHold or BankWire or DebitCardHold or Other100</PayableType> <CheckThreshold>decimal</CheckThreshold> <PriceType>int</PriceType> <LanguageID>int</LanguageID> <Gender>Unknown or Male or Female</Gender> <SalesTaxID>string</SalesTaxID> <VatRegistration>string</VatRegistration> <IsSalesTaxExempt>boolean</IsSalesTaxExempt> <IsSubscribedToBroadcasts>boolean</IsSubscribedToBroadcasts> <CreatedDate>dateTime</CreatedDate> <ModifiedDate>dateTime</ModifiedDate> <MiddleName>string</MiddleName> <NameSuffix>string</NameSuffix> <MainAddress3>string</MainAddress3> <MailAddress3>string</MailAddress3> <OtherAddress3>string</OtherAddress3> </Customer> <MiddleName>string</MiddleName> <NameSuffix>string</NameSuffix> <AutoOrderID>int</AutoOrderID> <PartyID>int</PartyID> <Reference1>string</Reference1> <IsRMA>boolean</IsRMA> </OrderResponse> </Orders> <RecordCount>int</RecordCount> </GetOrdersResult> </soap:Body> </soap:Envelope>

C#

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

    GetOrdersRequest req = new GetOrdersRequest();

 

    req.OrderDateStart = DateTime.Today;         //If supplied only orders greater than or equal to will be returned.

    req.OrderDateEnd = DateTime.Today;

    req.WarehouseID = 1;            //Unique location for orders

    req.CurrencyCode = "usd";

 

    //Send Request to Server and Get Response

    GetOrdersResponse res = api.GetOrders(req);

 

    //Now examine the results:

 

    foreach (OrderResponse order in res.Orders)

    {

        Console.WriteLine("OrderID: {0}", order.OrderID);

        Console.WriteLine("OrderStatus: {0}", order.OrderStatus);

        Console.WriteLine("OrderDate: {0}", order.OrderDate);

        Console.WriteLine("CurrencyCode: {0}", order.CurrencyCode);

        Console.WriteLine("WarehouseID: {0}", order.WarehouseID);

        Console.WriteLine("ShipMethodID: {0}", order.ShipMethodID);

        Console.WriteLine("PriceType: {0}", order.PriceType);

        Console.WriteLine("Total: {0}", order.Total);

 

        foreach (OrderDetailResponse orderDetail in order.Details)

        {

            Console.WriteLine("ItemCode: {0}", orderDetail.ItemCode);

            Console.WriteLine("Description: {0}", orderDetail.Description);

            Console.WriteLine("Quantity: {0}", orderDetail.Quantity);

            Console.WriteLine("OrderLine: {0}", orderDetail.OrderLine);

            Console.WriteLine("Reference1: {0}", orderDetail.Reference1);

        }

 

        foreach (PaymentResponse payment in order.Payments)

        {

            Console.WriteLine("Amount: {0}", payment.Amount);

            Console.WriteLine("BillingName: {0}", payment.BillingName);

            Console.WriteLine("BillingAddress1: {0}", payment.BillingAddress1);

            Console.WriteLine("BillingAddress2: {0}", payment.BillingAddress2);

            Console.WriteLine("BillingCity: {0}", payment.BillingCity);

            Console.WriteLine("BillingZip: {0}", payment.BillingZip);

            Console.WriteLine("BankName: {0}", payment.BankName);

            Console.WriteLine("Memo: {0}", payment.Memo);

            Console.WriteLine("CreditCardNumberDisplay: {0}", payment.CreditCardNumberDisplay);

            Console.WriteLine("AuthorizationCode: {0}", payment.AuthorizationCode);

            Console.WriteLine("CreditCardTypeDescription: {0}", payment.CreditCardTypeDescription);

        }

    }

    Console.WriteLine("RecordCount: {0}", res.RecordCount);

}

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 GetOrdersRequest()

 

    req.OrderDateStart = DateTime.Today

    req.OrderDateEnd = DateTime.Today

    req.WarehouseID = 1

    req.CurrencyCode = "usd"

 

    'Send Request to Server and Get Response

    Dim res As GetOrdersResponse = api.GetOrders(req)

 

    'Now examine the results:

 

    For Each order As OrderResponse In res.Orders

        Console.WriteLine("OrderID: {0}", order.OrderID)

        Console.WriteLine("OrderStatus: {0}", order.OrderStatus)

        Console.WriteLine("OrderDate: {0}", order.OrderDate)

        Console.WriteLine("CurrencyCode: {0}", order.CurrencyCode)

        Console.WriteLine("WarehouseID: {0}", order.WarehouseID)

        Console.WriteLine("ShipMethodID: {0}", order.ShipMethodID)

        Console.WriteLine("PriceType: {0}", order.PriceType)

        Console.WriteLine("Total: {0}", order.Total)

 

        For Each orderDetail As OrderDetailResponse In order.Details

            Console.WriteLine("ItemCode: {0}", orderDetail.ItemCode)

            Console.WriteLine("Description: {0}", orderDetail.Description)

            Console.WriteLine("Quantity: {0}", orderDetail.Quantity)

            Console.WriteLine("OrderLine: {0}", orderDetail.OrderLine)

            Console.WriteLine("Reference1: {0}", orderDetail.Reference1)

        Next

 

        For Each payment As PaymentResponse In order.Payments

            Console.WriteLine("Amount: {0}", payment.Amount)

            Console.WriteLine("BillingName: {0}", payment.BillingName)

            Console.WriteLine("BillingAddress1: {0}", payment.BillingAddress1)

            Console.WriteLine("BillingAddress2: {0}", payment.BillingAddress2)

            Console.WriteLine("BillingCity: {0}", payment.BillingCity)

            Console.WriteLine("BillingZip: {0}", payment.BillingZip)

            Console.WriteLine("BankName: {0}", payment.BankName)

            Console.WriteLine("Memo: {0}", payment.Memo)

            Console.WriteLine("CreditCardNumberDisplay: {0}", payment.CreditCardNumberDisplay)

            Console.WriteLine("AuthorizationCode: {0}", payment.AuthorizationCode)

            Console.WriteLine("CreditCardTypeDescription: {0}", payment.CreditCardTypeDescription)

        Next

    Next

    Console.WriteLine("RecordCount: {0}", res.RecordCount)

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->OrderDateStart = 1;

    $req->OrderDateEnd = 1;

    $req->WarehouseID = 1;

    $req->CurrencyCode = "usd";

 

    //Send Request to Server and Get Response

    $res = $api.GetOrders($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

    GetOrdersRequest req = new GetOrdersRequest();

 

    req.setOrderDateStart(1);

    req.setOrderDateEnd(1);

    req.setWarehouseID(1);

    req.setCurrencyCode("usd");

 

    //Send Request to Server and Get Response

    GetOrdersResponse res = api.getExigoApiSoap().getOrders(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

    System.out.println("Error: " + ex.getMessage());

}

CSV

This method supports CSV output.

HTTP Get Request:
http://api.exigo.com/3.0/csv/?method=GetOrders
&ApiLoginName=String
&ApiPassword=String
&ApiCompany=String
&CustomerID=Nullable`1
&OrderID=Nullable`1
&OrderIDs=Int32[]
&OrderDateStart=Nullable`1
&OrderDateEnd=Nullable`1
&OrderStatus=Nullable`1
&WarehouseID=Nullable`1
&CurrencyCode=String
&ReturnCustomer=Nullable`1
&ReturnKitDetails=Nullable`1
&GreaterThanOrderID=Nullable`1
&GreaterThanModifiedDate=Nullable`1
&BatchSize=Nullable`1
&Other11=String
&Other12=String
&Other13=String
&Other14=String
&Other15=String
&Other16=String
&Other17=String
&Other18=String
&Other19=String
&Other20=String
&PartyID=Nullable`1

Response Fields
OrderID,CustomerID,OrderStatus,OrderDate,CurrencyCode,WarehouseID,ShipMethodID,PriceType,FirstName,LastName,Company,Address1,Address2,Address3,City,State,Zip,Country,County,Email,Phone,Notes,Total,SubTotal,TaxTotal,ShippingTotal,DiscountTotal,DiscountPercent,WeightTotal,BusinessVolumeTotal,CommissionableVolumeTotal,TrackingNumber1,TrackingNumber2,TrackingNumber3,TrackingNumber4,TrackingNumber5,Other1Total,Other2Total,Other3Total,Other4Total,Other5Total,Other6Total,Other7Total,Other8Total,Other9Total,Other10Total,ShippingTax,OrderTax,FedTaxTotal,StateTaxTotal,FedShippingTax,StateShippingTax,CityShippingTax,CityLocalShippingTax,CountyShippingTax,CountyLocalShippingTax,Other11,Other12,Other13,Other14,Other15,Other16,Other17,Other18,Other19,Other20,ModifiedDate,OrderType,ShippedDate,CreatedDate,CreatedBy,ModifiedBy,TaxFedRate,TaxStateRate,TaxCityRate,TaxCityLocalRate,TaxCountyRate,TaxCountyLocalRate,TaxManualRate,TaxCity,TaxCounty,TaxState,TaxZip,TaxCountry,TaxIsExempt,TaxIsOverRide,ItemCode,Description,Quantity,PriceEach,PriceTotal,Tax,WeightEach,Weight,BusinessVolumeEach,BusinesVolume,CommissionableVolumeEach,CommissionableVolume,Other1Each,Other1,Other2Each,Other2,Other3Each,Other3,Other4Each,Other4,Other5Each,Other5,Other6Each,Other6,Other7Each,Other7,Other8Each,Other8,Other9Each,Other9,Other10Each,Other10,ParentItemCode,Taxable,FedTax,StateTax,CityTax,CityLocalTax,CountyTax,CountyLocalTax,ManualTax,IsStateTaxOverride,OrderLine,Reference1,PaymentID,CustomerID,PaymentType,PaymentDate,Amount,OrderID,CurrencyCode,BillingName,BillingAddress1,BillingAddress2,BillingCity,BillingState,BillingZip,BillingCountry,BankName,Memo,CreditCardNumberDisplay,AuthorizationCode,CreditCardType,CreditCardTypeDescription,ExpectedPaymentID,CustomerID,PaymentType,PaymentDate,Amount,OrderID,CurrencyCode,BillingName,AuthorizationCode,Customer,MiddleName,NameSuffix,AutoOrderID,PartyID,Reference1,IsRMA,RecordCount
Int32,Int32,OrderStatusType,DateTime,String,Int32,Int32,Int32,String,String,String,String,String,String,String,String,String,String,String,String,String,String,Decimal,Decimal,Decimal,Decimal,Decimal,Decimal,Decimal,Decimal,Decimal,String,String,String,String,String,Decimal,Decimal,Decimal,Decimal,Decimal,Decimal,Decimal,Decimal,Decimal,Decimal,Decimal,Decimal,Decimal,Decimal,Decimal,Decimal,Decimal,Decimal,Decimal,Decimal,String,String,String,String,String,String,String,String,String,String,DateTime,OrderType,Nullable`1,DateTime,String,String,Decimal,Decimal,Decimal,Decimal,Decimal,Decimal,Decimal,String,String,String,String,String,Boolean,Boolean,String,String,Decimal,Decimal,Decimal,Decimal,Decimal,Decimal,Decimal,Decimal,Decimal,Decimal,Decimal,Decimal,Decimal,Decimal,Decimal,Decimal,Decimal,Decimal,Decimal,Decimal,Decimal,Decimal,Decimal,Decimal,Decimal,Decimal,Decimal,Decimal,Decimal,Decimal,String,Decimal,Decimal,Decimal,Decimal,Decimal,Decimal,Decimal,Decimal,Boolean,Int32,String,Int32,Int32,PaymentType,DateTime,Decimal,Nullable`1,String,String,String,String,String,String,String,String,String,String,String,String,Int32,String,Int32,Int32,PaymentType,DateTime,Decimal,Int32,String,String,String,CustomerResponse,String,String,Nullable`1,Nullable`1,String,Boolean,Int32