Exigo Web Services API v2021.6.7.1

UpdateAutoOrder

Update a Recurring Order template in or out of a transaction. Client provides schedule, item codes, quantity, and shipping info. Server calculates and commits data, then pricing, tax, shipping and volume info.

Note: This request can participate in a transaction. Learn more about transactions.

Input Properties

UpdateAutoOrderRequest
PropertyData TypeNotes
AutoOrderIDInt32
Frequency FrequencyTypeOptional. Leave null to ignore. If set to SpecificDays, SpecificDayInterval must be filled.
StartDateDateTimeOptional. Leave null to ignore.
StopDateDateTimeOptional. Leave null to ignore. Pass in DateTime minimum to set field empty.
SpecificDayIntervalInt32Optional. Leave null to ignore. To fill, Frequency must be filled with SpecificDays, even if previously set to SpecificDays.
CurrencyCodeStringOptional. Leave null to ignore, fill with empty string to set field empty.
WarehouseIDInt32Optional. Leave null to ignore.
ShipMethodIDInt32Optional. Leave null to ignore.
PaymentType AutoOrderPaymentTypeOptional. Leave null to ignore.
ProcessType AutoOrderProcessTypeOptional. Leave null to ignore.
FirstNameStringOptional. Leave null to ignore, fill with empty string to set field empty.
MiddleNameStringOptional. Leave null to ignore, fill with empty string to set field empty.
LastNameStringOptional. Leave null to ignore, fill with empty string to set field empty.
NameSuffixStringOptional. Leave null to ignore, fill with empty string to set field empty.
CompanyStringOptional. Leave null to ignore, fill with empty string to set field empty.
Address1StringOptional. Leave null to ignore, fill with empty string to set field empty.
Address2StringOptional. Leave null to ignore, fill with empty string to set field empty.
Address3StringOptional. Leave null to ignore, fill with empty string to set field empty.
CityStringOptional. Leave null to ignore, fill with empty string to set field empty.
StateStringOptional. Leave null to ignore, fill with empty string to set field empty.
ZipStringOptional. Leave null to ignore, fill with empty string to set field empty.
CountryStringOptional. Leave null to ignore, fill with empty string to set field empty.
CountyStringOptional. Leave null to ignore, fill with empty string to set field empty.
EmailStringOptional. Leave null to ignore, fill with empty string to set field empty.
PhoneStringOptional. Leave null to ignore, fill with empty string to set field empty.
NotesStringOptional. Leave null to ignore, fill with empty string to set field empty.
Other11StringOptional. Leave null to ignore, fill with empty string to set field empty.
Other12StringOptional. Leave null to ignore, fill with empty string to set field empty.
Other13StringOptional. Leave null to ignore, fill with empty string to set field empty.
Other14StringOptional. Leave null to ignore, fill with empty string to set field empty.
Other15StringOptional. Leave null to ignore, fill with empty string to set field empty.
Other16StringOptional. Leave null to ignore, fill with empty string to set field empty.
Other17StringOptional. Leave null to ignore, fill with empty string to set field empty.
Other18StringOptional. Leave null to ignore, fill with empty string to set field empty.
Other19StringOptional. Leave null to ignore, fill with empty string to set field empty.
Other20StringOptional. Leave null to ignore, fill with empty string to set field empty.
DescriptionStringOptional. Leave null to ignore, fill with empty string to set field empty.
CustomFrequencyTyInt32Optional. To be used with Frequency Type Custom.

Output Properties

UpdateAutoOrderResponse
PropertyData TypeNotes

Http Request

PUT https://yourcompany-api.exigo.com/3.0/autoorder HTTP/1.1
Content-Type: application/json
Authorization: Basic base64Encoded(yourlogin@yourcompany:yourpassword)

{ "customFrequencyTy": 1 }

Http Response

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

{ "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: sandboxapi4.exigo.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.exigo.com/UpdateAutoOrder"

<?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> <UpdateAutoOrderRequest xmlns="http://api.exigo.com/"> <AutoOrderID>int</AutoOrderID> <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> <SpecificDayInterval>int</SpecificDayInterval> <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> <MiddleName>string</MiddleName> <LastName>string</LastName> <NameSuffix>string</NameSuffix> <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> <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> <Description>string</Description> <CustomFrequencyTy>int</CustomFrequencyTy> </UpdateAutoOrderRequest> </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> <UpdateAutoOrderResult xmlns="http://api.exigo.com/" /> </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 UpdateAutoOrderRequest();

 

    req.CustomFrequencyTy = 1;      //To be used with Frequency Type Custom

 

    //Send Request to Server and Get Response

    var res = await api.UpdateAutoOrderAsync(req);

 

    //Now examine the results:

}

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

    UpdateAutoOrderRequest req = new UpdateAutoOrderRequest();

 

    req.CustomFrequencyTy = 1;      //To be used with Frequency Type Custom

 

    //Send Request to Server and Get Response

    UpdateAutoOrderResponse res = api.UpdateAutoOrder(req);

 

    //Now examine the results:

}

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

 

    req.CustomFrequencyTy = 1

 

    'Send Request to Server and Get Response

    Dim res As UpdateAutoOrderResponse = api.UpdateAutoOrder(req)

 

    'Now examine the results:

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

 

    //Send Request to Server and Get Response

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

    UpdateAutoOrderRequest req = new UpdateAutoOrderRequest();

 

    req.setCustomFrequencyTy(1);

 

    //Send Request to Server and Get Response

    UpdateAutoOrderResponse res = api.getExigoApiSoap().updateAutoOrder(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

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

}

CSV

This method does not support csv output.