Exigo Web Services API v3.4.179

GetAutoOrders

Returns any AutoOrders setup and active for a given customer.

Input Properties

GetAutoOrdersRequest
PropertyData TypeNotes
CustomerIDInt32Unique identifier for a customer entity.
AutoOrderIDInt32Optional. Optional to pull just one AutoOrder.
AutoOrderStatus AutoOrderStatusTypeOptional. Optional. Will assume Active if not supplied.

Output Properties

GetAutoOrdersResponse
PropertyData TypeNotes
AutoOrdersAutoOrderResponse[]
AutoOrderResponse
PropertyData TypeNotes
CustomerIDInt32Unique identifier for a customer entity.
AutoOrderIDInt32
AutoOrderStatus AutoOrderStatusType
Frequency FrequencyType
StartDateDateTime
StopDateDateTime
LastRunDateDateTime
NextRunDateDateTime
CurrencyCode String
WarehouseID Int32Unique location for orders.
ShipMethodID Int32
PaymentType AutoOrderPaymentType
ProcessType AutoOrderProcessType
FirstNameString
LastNameString
CompanyString
Address1String
Address2String
Address3String
CityString
State String
ZipString
Country String
CountyString
EmailString
PhoneString
NotesString
TotalDecimal
SubTotalDecimal
TaxTotalDecimal
ShippingTotalDecimal
DiscountTotalDecimal
BusinessVolumeTotalDecimal
CommissionableVolumeTotalDecimal
DescriptionString
Other11String
Other12String
Other13String
Other14String
Other15String
Other16String
Other17String
Other18String
Other19String
Other20String
DetailsAutoOrderDetailResponse[]
ModifiedDateDateTime
ModifiedByString
MiddleNameString
NameSuffixString
AutoOrderDetailResponse
PropertyData TypeNotes
ItemCode String
DescriptionString
QuantityDecimal
PriceEachDecimal
PriceTotalDecimal
BusinessVolumeEachDecimal
BusinesVolumeDecimal
CommissionableVolumeEachDecimal
CommissionableVolumeDecimalPrice amount.
ParentItemCodeString
PriceEachOverrideDecimal
TaxableEachOverrideDecimal
ShippingPriceEachOverrideDecimal
BusinessVolumeEachOverrideDecimal
CommissionableVolumeEachOverrideDecimal
Reference1String

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/GetAutoOrders"

<?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> </ApiAuthentication> </soap:Header> <soap:Body> <GetAutoOrdersRequest xmlns="http://api.exigo.com/"> <CustomerID>int</CustomerID> <AutoOrderID>int</AutoOrderID> <AutoOrderStatus>Active or Inactive or Deleted</AutoOrderStatus> </GetAutoOrdersRequest> </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> <GetAutoOrdersResult xmlns="http://api.exigo.com/"> <AutoOrders> <AutoOrderResponse> <CustomerID>int</CustomerID> <AutoOrderID>int</AutoOrderID> <AutoOrderStatus>Active or Inactive or Deleted</AutoOrderStatus> <Frequency>Weekly or BiWeekly or Monthly or BiMonthly or Quarterly or SemiYearly or Yearly or EveryFourWeeks or EverySixWeeks or EveryEightWeeks or EveryTwelveWeeks</Frequency> <StartDate>dateTime</StartDate> <StopDate>dateTime</StopDate> <LastRunDate>dateTime</LastRunDate> <NextRunDate>dateTime</NextRunDate> <CurrencyCode>string</CurrencyCode> <WarehouseID>int</WarehouseID> <ShipMethodID>int</ShipMethodID> <PaymentType>PrimaryCreditCard or SecondaryCreditCard or CheckingAccount or WillSendPayment or BankDraft or PrimaryWalletAccount or SecondaryWalletAccount</PaymentType> <ProcessType>AlwaysProcess or Conditional</ProcessType> <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> <BusinessVolumeTotal>decimal</BusinessVolumeTotal> <CommissionableVolumeTotal>decimal</CommissionableVolumeTotal> <Description>string</Description> <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> <Details> <AutoOrderDetailResponse> <ItemCode>string</ItemCode> <Description>string</Description> <Quantity>decimal</Quantity> <PriceEach>decimal</PriceEach> <PriceTotal>decimal</PriceTotal> <BusinessVolumeEach>decimal</BusinessVolumeEach> <BusinesVolume>decimal</BusinesVolume> <CommissionableVolumeEach>decimal</CommissionableVolumeEach> <CommissionableVolume>decimal</CommissionableVolume> <ParentItemCode>string</ParentItemCode> <PriceEachOverride>decimal</PriceEachOverride> <TaxableEachOverride>decimal</TaxableEachOverride> <ShippingPriceEachOverride>decimal</ShippingPriceEachOverride> <BusinessVolumeEachOverride>decimal</BusinessVolumeEachOverride> <CommissionableVolumeEachOverride>decimal</CommissionableVolumeEachOverride> <Reference1>string</Reference1> </AutoOrderDetailResponse> </Details> <ModifiedDate>dateTime</ModifiedDate> <ModifiedBy>string</ModifiedBy> <MiddleName>string</MiddleName> <NameSuffix>string</NameSuffix> </AutoOrderResponse> </AutoOrders> </GetAutoOrdersResult> </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

    GetAutoOrdersRequest req = new GetAutoOrdersRequest();

 

    req.CustomerID = 1;             //Unique identifier for a customer entity.

 

    //Send Request to Server and Get Response

    GetAutoOrdersResponse res = api.GetAutoOrders(req);

 

    //Now examine the results:

 

    foreach (AutoOrderResponse autoOrder in res.AutoOrders)

    {

        Console.WriteLine("CustomerID: {0}", autoOrder.CustomerID);

        Console.WriteLine("AutoOrderID: {0}", autoOrder.AutoOrderID);

        Console.WriteLine("AutoOrderStatus: {0}", autoOrder.AutoOrderStatus);

        Console.WriteLine("Frequency: {0}", autoOrder.Frequency);

        Console.WriteLine("StartDate: {0}", autoOrder.StartDate);

        Console.WriteLine("StopDate: {0}", autoOrder.StopDate);

        Console.WriteLine("LastRunDate: {0}", autoOrder.LastRunDate);

        Console.WriteLine("NextRunDate: {0}", autoOrder.NextRunDate);

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

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

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

        Console.WriteLine("PaymentType: {0}", autoOrder.PaymentType);

        Console.WriteLine("ProcessType: {0}", autoOrder.ProcessType);

        Console.WriteLine("FirstName: {0}", autoOrder.FirstName);

        Console.WriteLine("LastName: {0}", autoOrder.LastName);

        Console.WriteLine("Company: {0}", autoOrder.Company);

        Console.WriteLine("Address1: {0}", autoOrder.Address1);

        Console.WriteLine("Address2: {0}", autoOrder.Address2);

        Console.WriteLine("Address3: {0}", autoOrder.Address3);

        Console.WriteLine("City: {0}", autoOrder.City);

        Console.WriteLine("Zip: {0}", autoOrder.Zip);

        Console.WriteLine("County: {0}", autoOrder.County);

        Console.WriteLine("Email: {0}", autoOrder.Email);

        Console.WriteLine("Phone: {0}", autoOrder.Phone);

        Console.WriteLine("Notes: {0}", autoOrder.Notes);

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

        Console.WriteLine("SubTotal: {0}", autoOrder.SubTotal);

        Console.WriteLine("TaxTotal: {0}", autoOrder.TaxTotal);

        Console.WriteLine("ShippingTotal: {0}", autoOrder.ShippingTotal);

        Console.WriteLine("DiscountTotal: {0}", autoOrder.DiscountTotal);

        Console.WriteLine("BusinessVolumeTotal: {0}", autoOrder.BusinessVolumeTotal);

        Console.WriteLine("CommissionableVolumeTotal: {0}", autoOrder.CommissionableVolumeTotal);

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

        Console.WriteLine("Other11: {0}", autoOrder.Other11);

        Console.WriteLine("Other12: {0}", autoOrder.Other12);

        Console.WriteLine("Other13: {0}", autoOrder.Other13);

        Console.WriteLine("Other14: {0}", autoOrder.Other14);

        Console.WriteLine("Other15: {0}", autoOrder.Other15);

        Console.WriteLine("Other16: {0}", autoOrder.Other16);

        Console.WriteLine("Other17: {0}", autoOrder.Other17);

        Console.WriteLine("Other18: {0}", autoOrder.Other18);

        Console.WriteLine("Other19: {0}", autoOrder.Other19);

        Console.WriteLine("Other20: {0}", autoOrder.Other20);

 

        foreach (AutoOrderDetailResponse autoOrderDetail in autoOrder.Details)

        {

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

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

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

            Console.WriteLine("PriceEach: {0}", autoOrderDetail.PriceEach);

            Console.WriteLine("PriceTotal: {0}", autoOrderDetail.PriceTotal);

            Console.WriteLine("BusinessVolumeEach: {0}", autoOrderDetail.BusinessVolumeEach);

            Console.WriteLine("BusinesVolume: {0}", autoOrderDetail.BusinesVolume);

            Console.WriteLine("CommissionableVolumeEach: {0}", autoOrderDetail.CommissionableVolumeEach);

            Console.WriteLine("CommissionableVolume: {0}", autoOrderDetail.CommissionableVolume);

        }

        Console.WriteLine("ModifiedDate: {0}", autoOrder.ModifiedDate);

        Console.WriteLine("ModifiedBy: {0}", autoOrder.ModifiedBy);

        Console.WriteLine("MiddleName: {0}", autoOrder.MiddleName);

        Console.WriteLine("NameSuffix: {0}", autoOrder.NameSuffix);

    }

}

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

 

    req.CustomerID = 1

 

    'Send Request to Server and Get Response

    Dim res As GetAutoOrdersResponse = api.GetAutoOrders(req)

 

    'Now examine the results:

 

    For Each autoOrder As AutoOrderResponse In res.AutoOrders

        Console.WriteLine("CustomerID: {0}", autoOrder.CustomerID)

        Console.WriteLine("AutoOrderID: {0}", autoOrder.AutoOrderID)

        Console.WriteLine("AutoOrderStatus: {0}", autoOrder.AutoOrderStatus)

        Console.WriteLine("Frequency: {0}", autoOrder.Frequency)

        Console.WriteLine("StartDate: {0}", autoOrder.StartDate)

        Console.WriteLine("StopDate: {0}", autoOrder.StopDate)

        Console.WriteLine("LastRunDate: {0}", autoOrder.LastRunDate)

        Console.WriteLine("NextRunDate: {0}", autoOrder.NextRunDate)

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

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

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

        Console.WriteLine("PaymentType: {0}", autoOrder.PaymentType)

        Console.WriteLine("ProcessType: {0}", autoOrder.ProcessType)

        Console.WriteLine("FirstName: {0}", autoOrder.FirstName)

        Console.WriteLine("LastName: {0}", autoOrder.LastName)

        Console.WriteLine("Company: {0}", autoOrder.Company)

        Console.WriteLine("Address1: {0}", autoOrder.Address1)

        Console.WriteLine("Address2: {0}", autoOrder.Address2)

        Console.WriteLine("Address3: {0}", autoOrder.Address3)

        Console.WriteLine("City: {0}", autoOrder.City)

        Console.WriteLine("Zip: {0}", autoOrder.Zip)

        Console.WriteLine("County: {0}", autoOrder.County)

        Console.WriteLine("Email: {0}", autoOrder.Email)

        Console.WriteLine("Phone: {0}", autoOrder.Phone)

        Console.WriteLine("Notes: {0}", autoOrder.Notes)

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

        Console.WriteLine("SubTotal: {0}", autoOrder.SubTotal)

        Console.WriteLine("TaxTotal: {0}", autoOrder.TaxTotal)

        Console.WriteLine("ShippingTotal: {0}", autoOrder.ShippingTotal)

        Console.WriteLine("DiscountTotal: {0}", autoOrder.DiscountTotal)

        Console.WriteLine("BusinessVolumeTotal: {0}", autoOrder.BusinessVolumeTotal)

        Console.WriteLine("CommissionableVolumeTotal: {0}", autoOrder.CommissionableVolumeTotal)

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

        Console.WriteLine("Other11: {0}", autoOrder.Other11)

        Console.WriteLine("Other12: {0}", autoOrder.Other12)

        Console.WriteLine("Other13: {0}", autoOrder.Other13)

        Console.WriteLine("Other14: {0}", autoOrder.Other14)

        Console.WriteLine("Other15: {0}", autoOrder.Other15)

        Console.WriteLine("Other16: {0}", autoOrder.Other16)

        Console.WriteLine("Other17: {0}", autoOrder.Other17)

        Console.WriteLine("Other18: {0}", autoOrder.Other18)

        Console.WriteLine("Other19: {0}", autoOrder.Other19)

        Console.WriteLine("Other20: {0}", autoOrder.Other20)

 

        For Each autoOrderDetail As AutoOrderDetailResponse In autoOrder.Details

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

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

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

            Console.WriteLine("PriceEach: {0}", autoOrderDetail.PriceEach)

            Console.WriteLine("PriceTotal: {0}", autoOrderDetail.PriceTotal)

            Console.WriteLine("BusinessVolumeEach: {0}", autoOrderDetail.BusinessVolumeEach)

            Console.WriteLine("BusinesVolume: {0}", autoOrderDetail.BusinesVolume)

            Console.WriteLine("CommissionableVolumeEach: {0}", autoOrderDetail.CommissionableVolumeEach)

            Console.WriteLine("CommissionableVolume: {0}", autoOrderDetail.CommissionableVolume)

        Next

        Console.WriteLine("ModifiedDate: {0}", autoOrder.ModifiedDate)

        Console.WriteLine("ModifiedBy: {0}", autoOrder.ModifiedBy)

        Console.WriteLine("MiddleName: {0}", autoOrder.MiddleName)

        Console.WriteLine("NameSuffix: {0}", autoOrder.NameSuffix)

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

 

    //Send Request to Server and Get Response

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

    GetAutoOrdersRequest req = new GetAutoOrdersRequest();

 

    req.setCustomerID(1);

 

    //Send Request to Server and Get Response

    GetAutoOrdersResponse res = api.getExigoApiSoap().getAutoOrders(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

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

}

CSV

This method does not support csv output.