Exigo Web Services API v2018.8.27.1

UpdateAutoOrderDetail

Update a Recurring Order template detail in or out of a transaction. Client provides quantity, pricing , volume and extended detail info.

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

Input Properties

UpdateAutoOrderDetailRequest
PropertyData TypeNotes
AutoOrderIDInt32
OrderLineInt32
ItemIDInt32Unique identifier for a item record.
QtyDecimal
ManualPriceEachDecimalOptional.
ManualTaxablePriceEachDecimalOptional.
ManualShippingPriceEachDecimalOptional.
ManualBVEachDecimalOptional.
ManualCVEachDecimalOptional.
DescriptionStringOptional.
PeriodDescriptionTyInt32Optional.
PriceEachDecimalOptional.
PriceExtDecimalOptional.
BVEachDecimalOptional.
BusinessVolumeDecimalOptional. Price amount.
CVEachDecimalOptional.
CommissionableVolumeDecimalOptional. Price amount.
DynamicKitItemIDInt32Optional.
Reference1StringOptional.

Output Properties

UpdateAutoOrderDetailResponse
PropertyData TypeNotes

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

<?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> <UpdateAutoOrderDetailRequest xmlns="http://api.exigo.com/"> <AutoOrderID>int</AutoOrderID> <OrderLine>int</OrderLine> <ItemID>int</ItemID> <Qty>decimal</Qty> <ManualPriceEach>decimal</ManualPriceEach> <ManualTaxablePriceEach>decimal</ManualTaxablePriceEach> <ManualShippingPriceEach>decimal</ManualShippingPriceEach> <ManualBVEach>decimal</ManualBVEach> <ManualCVEach>decimal</ManualCVEach> <Description>string</Description> <PeriodDescriptionTy>int</PeriodDescriptionTy> <PriceEach>decimal</PriceEach> <PriceExt>decimal</PriceExt> <BVEach>decimal</BVEach> <BusinessVolume>decimal</BusinessVolume> <CVEach>decimal</CVEach> <CommissionableVolume>decimal</CommissionableVolume> <DynamicKitItemID>int</DynamicKitItemID> <Reference1>string</Reference1> </UpdateAutoOrderDetailRequest> </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> <UpdateAutoOrderDetailResult xmlns="http://api.exigo.com/" /> </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

    UpdateAutoOrderDetailRequest req = new UpdateAutoOrderDetailRequest();

 

    req.AutoOrderID = 1;

    req.OrderLine = 1;

    req.ItemID = 1;                 //Unique identifier for a item record.

    req.Qty = 1;

    req.ManualPriceEach = 1;

    req.ManualTaxablePriceEach = 1;

    req.ManualShippingPriceEach = 1;

    req.ManualBVEach = 1;

    req.ManualCVEach = 1;

    req.Description = "1";

    req.PeriodDescriptionTy = 1;

    req.PriceEach = 1;

    req.PriceExt = 1;

    req.BVEach = 1;

    req.BusinessVolume = 1;         //Price amount

    req.CVEach = 1;

    req.CommissionableVolume = 1;   //Price amount

    req.DynamicKitItemID = 1;

    req.Reference1 = "1";

 

    //Send Request to Server and Get Response

    UpdateAutoOrderDetailResponse res = api.UpdateAutoOrderDetail(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 UpdateAutoOrderDetailRequest()

 

    req.AutoOrderID = 1

    req.OrderLine = 1

    req.ItemID = 1

    req.Qty = 1

    req.ManualPriceEach = 1

    req.ManualTaxablePriceEach = 1

    req.ManualShippingPriceEach = 1

    req.ManualBVEach = 1

    req.ManualCVEach = 1

    req.Description = "1"

    req.PeriodDescriptionTy = 1

    req.PriceEach = 1

    req.PriceExt = 1

    req.BVEach = 1

    req.BusinessVolume = 1

    req.CVEach = 1

    req.CommissionableVolume = 1

    req.DynamicKitItemID = 1

    req.Reference1 = "1"

 

    'Send Request to Server and Get Response

    Dim res As UpdateAutoOrderDetailResponse = api.UpdateAutoOrderDetail(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->AutoOrderID = 1;

    $req->OrderLine = 1;

    $req->ItemID = 1;

    $req->Qty = 1;

    $req->ManualPriceEach = 1;

    $req->ManualTaxablePriceEach = 1;

    $req->ManualShippingPriceEach = 1;

    $req->ManualBVEach = 1;

    $req->ManualCVEach = 1;

    $req->Description = "1";

    $req->PeriodDescriptionTy = 1;

    $req->PriceEach = 1;

    $req->PriceExt = 1;

    $req->BVEach = 1;

    $req->BusinessVolume = 1;

    $req->CVEach = 1;

    $req->CommissionableVolume = 1;

    $req->DynamicKitItemID = 1;

    $req->Reference1 = "1";

 

    //Send Request to Server and Get Response

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

    UpdateAutoOrderDetailRequest req = new UpdateAutoOrderDetailRequest();

 

    req.setAutoOrderID(1);

    req.setOrderLine(1);

    req.setItemID(1);

    req.setQty(1);

    req.setManualPriceEach(1);

    req.setManualTaxablePriceEach(1);

    req.setManualShippingPriceEach(1);

    req.setManualBVEach(1);

    req.setManualCVEach(1);

    req.setDescription("1");

    req.setPeriodDescriptionTy(1);

    req.setPriceEach(1);

    req.setPriceExt(1);

    req.setBVEach(1);

    req.setBusinessVolume(1);

    req.setCVEach(1);

    req.setCommissionableVolume(1);

    req.setDynamicKitItemID(1);

    req.setReference1("1");

 

    //Send Request to Server and Get Response

    UpdateAutoOrderDetailResponse res = api.getExigoApiSoap().updateAutoOrderDetail(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

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

}

CSV

This method does not support csv output.