Exigo API Web Service

GetAutoOrders

Returns any AutoOrders setup and active for a given customer.

Input Properties

GetAutoOrdersRequest

PropertyData TypeNotes

CustomerIDInt32Unique numeric identifier for customer record.

AutoOrderIDInt32Optional. Use to pull just one AutoOrder.

AutoOrderStatus AutoOrderStatusTypeOptional. Will assume Active if not supplied.

CustomerKeyStringOptional. Unique alpha numeric identifier for customer record. Exeption will occur if CustomerID & CustomerKey are provided.

Output Properties

GetAutoOrdersResponse

PropertyData TypeNotes

AutoOrdersAutoOrderResponse[]

AutoOrderResponse

PropertyData TypeNotes

CustomerIDInt32Unique numeric identifier for customer record.

AutoOrderIDInt32

AutoOrderStatus AutoOrderStatusType

Frequency FrequencyType

StartDateDateTime

StopDateDateTime

LastRunDateDateTime

NextRunDateDateTime

CurrencyCode String

WarehouseID Int32Unique location for orders.

ShipMethodID Int32

PaymentType AutoOrderPaymentTypePayment type.

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

SpecificDayIntervalInt32

CreatedDateDateTime

CreatedByString

CustomerKeyStringUnique alpha numeric identifier for customer record .

CustomFrequencyTyInt32To be used with Frequency Type Custom.

AutoOrderDetailResponse

PropertyData TypeNotes

ItemCode String

DescriptionString

QuantityDecimal

PriceEachDecimal

PriceTotalDecimal

BusinessVolumeEachDecimal

BusinesVolumeDecimal

CommissionableVolumeEachDecimal

CommissionableVolumeDecimalPrice amount.

ParentItemCodeString

PriceEachOverrideDecimal

TaxableEachOverrideDecimal

ShippingPriceEachOverrideDecimal

BusinessVolumeEachOverrideDecimal

CommissionableVolumeEachOverrideDecimal

Reference1String

ProcessWhileDateDateTimeObsolete. Use DetailEndDate instead.

SkipUntilDateDateTimeObsolete. Use DetailStartDate instead.

DetailStartDateDateTime

DetailEndDateDateTime

DetailIntervalInt32

OrderLineInt32

Http Request

GET https://yourcompany-api.exigo.com/3.0/autoorder?customerID=1
  &customerKey=1
Authorization: Basic base64Encoded

Http Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length

{
  "autoOrders": null,
  "result": null
}

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: totallife-api.exigo.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://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>
      <RequestTimeUtc>dateTime</RequestTimeUtc>
      <Signature>string</Signature>
    </ApiAuthentication>
  </soap:Header>
  <soap:Body>
    <GetAutoOrdersRequest xmlns="http://api.exigo.com/">
      <CustomerID>int</CustomerID>
      <AutoOrderID>int</AutoOrderID>
      <AutoOrderStatus>Active or Inactive or Deleted</AutoOrderStatus>
      <CustomerKey>string</CustomerKey>
    </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 or SpecificDays or Custom</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 or ThirdWalletAccount or FourthWalletAccount or FifthWalletAccount</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>
              <ProcessWhileDate>dateTime</ProcessWhileDate>
              <SkipUntilDate>dateTime</SkipUntilDate>
              <DetailStartDate>dateTime</DetailStartDate>
              <DetailEndDate>dateTime</DetailEndDate>
              <DetailInterval>int</DetailInterval>
              <OrderLine>int</OrderLine>
            </AutoOrderDetailResponse>
          </Details>
          <ModifiedDate>dateTime</ModifiedDate>
          <ModifiedBy>string</ModifiedBy>
          <MiddleName>string</MiddleName>
          <NameSuffix>string</NameSuffix>
          <SpecificDayInterval>int</SpecificDayInterval>
          <CreatedDate>dateTime</CreatedDate>
          <CreatedBy>string</CreatedBy>
          <CustomerKey>string</CustomerKey>
          <CustomFrequencyTy>int</CustomFrequencyTy>
        </AutoOrderResponse>
      </AutoOrders>
    </GetAutoOrdersResult>
  </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 GetAutoOrdersRequest();

req.CustomerID = 1; //Unique numeric identifier for customer record.

req.CustomerKey = "1"; //Unique alpha numeric identifier for customer record. Exeption will occur if CustomerID & CustomerKey are provided.

//Send Request to Server and Get Response

var res = await api.GetAutoOrdersAsync(req);

//Now examine the results:

foreach (var 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 (var 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("OrderLine: {0}", autoOrderDetail.OrderLine);

}

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

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

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

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

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

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

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

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

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

}

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

GetAutoOrdersRequest req = new GetAutoOrdersRequest();

req.CustomerID = 1; //Unique numeric identifier for customer record.

req.CustomerKey = "1"; //Unique alpha numeric identifier for customer record. Exeption will occur if CustomerID & CustomerKey are provided.

//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)