Exigo API Web Service

CreateOrderDetail

Create a new Order Detail for an existing order without recalculating. Can participate in a transaction.

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

Input Properties

CreateOrderDetailRequest

PropertyData TypeNotes

OrderIDInt32Unique numeric identifier for new order record.

OrderLineInt32

ItemCode StringOptional.

DescriptionStringOptional.

QtyDecimal

PriceEachDecimalOptional.

PriceExtDecimalOptional.

BVEachDecimalOptional.

BusinessVolumeDecimalOptional. Price amount.

CVEachDecimalOptional.

CommissionableVolumeDecimalOptional. Price amount.

ShippingPriceEachDecimalOptional.

ChargeShippingOnDecimalOptional.

IsTaxedInRegionBooleanOptional.

IsTaxedInRegionFedBooleanOptional.

IsTaxedInRegionStateBooleanOptional.

TaxablePriceEachDecimalOptional.

TaxableDecimalOptional.

CombinedTaxDecimalOptional.

FedTaxDecimalOptional.

StateTaxDecimalOptional.

CityTaxDecimalOptional.

CityLocalTaxDecimalOptional.

CountyTaxDecimalOptional.

CountyLocalTaxDecimalOptional.

ManualTaxDecimalOptional.

IsBackOrderBooleanOptional.

WeightEachDecimalOptional.

Other1EachDecimalOptional.

Other1 DecimalOptional.

Other2EachDecimalOptional.

Other2 DecimalOptional.

Other3EachDecimalOptional.

Other3 DecimalOptional.

Other4EachDecimalOptional.

Other4 DecimalOptional.

Other5EachDecimalOptional.

Other5 DecimalOptional.

Other6EachDecimalOptional.

Other6 DecimalOptional.

Other7EachDecimalOptional.

Other7 DecimalOptional.

Other8EachDecimalOptional.

Other8 DecimalOptional.

Other9EachDecimalOptional.

Other9 DecimalOptional.

Other10EachDecimalOptional.

Other10 DecimalOptional.

DiscountExtDecimalOptional.

OriginalTaxableEachDecimalOptional.

OriginalBVEachDecimalOptional.

OriginalCVEachDecimalOptional.

StateTaxableDecimalOptional.

IsStateTaxOverrideBooleanOptional.

DynamicKitItemIDInt32Optional.

HandlingFeeDecimalOptional.

Reference1StringOptional.

OrderKeyStringOptional. Unique alpha numeric identifier for order record. Exeption will occur if OrderID & OrderKey are provided.

Output Properties

CreateOrderDetailResponse

PropertyData TypeNotes

OrderIDInt32Unique numeric identifier for order record.

OrderLineInt32

OrderKeyStringUnique alpha numeric identifier for order record.

Http Request

Rest call not available for this method yet.

Http Response

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: "https://api.exigo.com/CreateOrderDetail"

<?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>
    <CreateOrderDetailRequest xmlns="http://api.exigo.com/">
      <OrderID>int</OrderID>
      <OrderLine>int</OrderLine>
      <ItemCode>string</ItemCode>
      <Description>string</Description>
      <Qty>decimal</Qty>
      <PriceEach>decimal</PriceEach>
      <PriceExt>decimal</PriceExt>
      <BVEach>decimal</BVEach>
      <BusinessVolume>decimal</BusinessVolume>
      <CVEach>decimal</CVEach>
      <CommissionableVolume>decimal</CommissionableVolume>
      <ShippingPriceEach>decimal</ShippingPriceEach>
      <ChargeShippingOn>decimal</ChargeShippingOn>
      <IsTaxedInRegion>boolean</IsTaxedInRegion>
      <IsTaxedInRegionFed>boolean</IsTaxedInRegionFed>
      <IsTaxedInRegionState>boolean</IsTaxedInRegionState>
      <TaxablePriceEach>decimal</TaxablePriceEach>
      <Taxable>decimal</Taxable>
      <CombinedTax>decimal</CombinedTax>
      <FedTax>decimal</FedTax>
      <StateTax>decimal</StateTax>
      <CityTax>decimal</CityTax>
      <CityLocalTax>decimal</CityLocalTax>
      <CountyTax>decimal</CountyTax>
      <CountyLocalTax>decimal</CountyLocalTax>
      <ManualTax>decimal</ManualTax>
      <IsBackOrder>boolean</IsBackOrder>
      <WeightEach>decimal</WeightEach>
      <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>
      <DiscountExt>decimal</DiscountExt>
      <OriginalTaxableEach>decimal</OriginalTaxableEach>
      <OriginalBVEach>decimal</OriginalBVEach>
      <OriginalCVEach>decimal</OriginalCVEach>
      <StateTaxable>decimal</StateTaxable>
      <IsStateTaxOverride>boolean</IsStateTaxOverride>
      <DynamicKitItemID>int</DynamicKitItemID>
      <HandlingFee>decimal</HandlingFee>
      <Reference1>string</Reference1>
      <OrderKey>string</OrderKey>
    </CreateOrderDetailRequest>
  </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>
    <CreateOrderDetailResult xmlns="http://api.exigo.com/">
      <OrderID>int</OrderID>
      <OrderLine>int</OrderLine>
      <OrderKey>string</OrderKey>
    </CreateOrderDetailResult>
  </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 CreateOrderDetailRequest();

req.OrderLine = 1;

req.ItemCode = "1";

req.Description = "1";

req.Qty = 1;

req.PriceEach = 1;

req.PriceExt = 1;

req.BVEach = 1;

req.BusinessVolume = 1; //Price amount

req.CVEach = 1;

req.CommissionableVolume = 1; //Price amount

req.ShippingPriceEach = 1;

req.ChargeShippingOn = 1;

req.IsTaxedInRegion = true;

req.IsTaxedInRegionFed = true;

req.IsTaxedInRegionState = true;

req.TaxablePriceEach = 1;

req.Taxable = 1;

req.CombinedTax = 1;

req.FedTax = 1;

req.StateTax = 1;

req.CityTax = 1;

req.CityLocalTax = 1;

req.CountyTax = 1;

req.CountyLocalTax = 1;

req.ManualTax = 1;

req.IsBackOrder = true;

req.WeightEach = 1;

req.Other1Each = 1;

req.Other2Each = 1;

req.Other3Each = 1;

req.Other4Each = 1;

req.Other5Each = 1;

req.Other6Each = 1;

req.Other7Each = 1;

req.Other8Each = 1;

req.Other9Each = 1;

req.Other10Each = 1;

req.DiscountExt = 1;

req.OriginalTaxableEach = 1;

req.OriginalBVEach = 1;

req.OriginalCVEach = 1;

req.StateTaxable = 1;

req.IsStateTaxOverride = true;

req.DynamicKitItemID = 1;

req.HandlingFee = 1;

req.Reference1 = "1";

req.OrderKey = "1"; //Unique alpha numeric identifier for order record. Exeption will occur if OrderID & OrderKey are provided.

//Send Request to Server and Get Response

var res = await api.CreateOrderDetailAsync(req);

//Now examine the results:

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

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

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

}

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

CreateOrderDetailRequest req = new CreateOrderDetailRequest();

req.OrderLine = 1;

req.ItemCode = "1";

req.Description = "1";

req.Qty = 1;

req.PriceEach = 1;

req.PriceExt = 1;

req.BVEach = 1;

req.BusinessVolume = 1; //Price amount

req.CVEach = 1;

req.CommissionableVolume = 1; //Price amount

req.ShippingPriceEach = 1;

req.ChargeShippingOn = 1;

req.IsTaxedInRegion = true;

req.IsTaxedInRegionFed = true;

req.IsTaxedInRegionState = true;

req.TaxablePriceEach = 1;

req.Taxable = 1;

req.CombinedTax = 1;

req.FedTax = 1;

req.StateTax = 1;

req.CityTax = 1;

req.CityLocalTax = 1;

req.CountyTax = 1;

req.CountyLocalTax = 1;

req.ManualTax = 1;

req.IsBackOrder = true;

req.WeightEach = 1;

req.Other1Each = 1;

req.Other2Each = 1;

req.Other3Each = 1;

req.Other4Each = 1;

req.Other5Each = 1;

req.Other6Each = 1;

req.Other7Each = 1;

req.Other8Each = 1;

req.Other9Each = 1;

req.Other10Each = 1;

req.DiscountExt = 1;

req.OriginalTaxableEach = 1;

req.OriginalBVEach = 1;

req.OriginalCVEach = 1;

req.StateTaxable = 1;

req.IsStateTaxOverride = true;

req.DynamicKitItemID = 1;

req.HandlingFee = 1;

req.Reference1 = "1";

req.OrderKey = "1"; //Unique alpha numeric identifier for order record. Exeption will occur if OrderID & OrderKey are provided.

//Send Request to Server and Get Response

CreateOrderDetailResponse res = api.CreateOrderDetail(req);

//Now examine the results:

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

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

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

}

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

req.OrderLine = 1

req.ItemCode = "1"

req.Description = "1"

req.Qty = 1

req.PriceEach = 1

req.PriceExt = 1

req.BVEach = 1

req.BusinessVolume = 1

req.CVEach = 1

req.CommissionableVolume = 1

req.ShippingPriceEach = 1

req.ChargeShippingOn = 1

req.IsTaxedInRegion = true

req.IsTaxedInRegionFed = true

req.IsTaxedInRegionState = true

req.TaxablePriceEach = 1

req.Taxable = 1

req.CombinedTax = 1

req.FedTax = 1

req.StateTax = 1

req.CityTax = 1

req.CityLocalTax = 1

req.CountyTax = 1

req.CountyLocalTax = 1

req.ManualTax = 1

req.IsBackOrder = true

req.WeightEach = 1

req.Other1Each = 1

req.Other2Each = 1

req.Other3Each = 1

req.Other4Each = 1

req.Other5Each = 1

req.Other6Each = 1

req.Other7Each = 1

req.Other8Each = 1

req.Other9Each = 1

req.Other10Each = 1

req.DiscountExt = 1

req.OriginalTaxableEach = 1

req.OriginalBVEach = 1

req.OriginalCVEach = 1

req.StateTaxable = 1

req.IsStateTaxOverride = true

req.DynamicKitItemID = 1

req.HandlingFee = 1

req.Reference1 = "1"

req.OrderKey = "1"

'Send Request to Server and Get Response

Dim res As CreateOrderDetailResponse = api.CreateOrderDetail(req)

'Now examine the results:

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

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

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

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

$req->ItemCode = "1";

$req->Description = "1";

$req->Qty = 1;

$req->PriceEach = 1;

$req->PriceExt = 1;

$req->BVEach = 1;

$req->BusinessVolume = 1;

$req->CVEach = 1;

$req->CommissionableVolume = 1;

$req->ShippingPriceEach = 1;

$req->ChargeShippingOn = 1;

$req->IsTaxedInRegion = 1;

$req->IsTaxedInRegionFed = 1;

$req->IsTaxedInRegionState = 1;

$req->TaxablePriceEach = 1;

$req->Taxable = 1;

$req->CombinedTax = 1;

$req->FedTax = 1;

$req->StateTax = 1;

$req->CityTax = 1;

$req->CityLocalTax = 1;

$req->CountyTax = 1;

$req->CountyLocalTax = 1;

$req->ManualTax = 1;

$req->IsBackOrder = 1;

$req->WeightEach = 1;

$req->Other1Each = 1;

$req->Other2Each = 1;

$req->Other3Each = 1;

$req->Other4Each = 1;

$req->Other5Each = 1;

$req->Other6Each = 1;

$req->Other7Each = 1;

$req->Other8Each = 1;

$req->Other9Each = 1;

$req->Other10Each = 1;

$req->DiscountExt = 1;

$req->OriginalTaxableEach = 1;

$req->OriginalBVEach = 1;

$req->OriginalCVEach = 1;

$req->StateTaxable = 1;

$req->IsStateTaxOverride = 1;

$req->DynamicKitItemID = 1;

$req->HandlingFee = 1;

$req->Reference1 = "1";

$req->OrderKey = "1";

//Send Request to Server and Get Response

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

CreateOrderDetailRequest req = new CreateOrderDetailRequest();

req.setOrderLine(1);

req.setItemCode("1");

req.setDescription("1");

req.setQty(1);

req.setPriceEach(1);

req.setPriceExt(1);

req.setBVEach(1);

req.setBusinessVolume(1);

req.setCVEach(1);

req.setCommissionableVolume(1);

req.setShippingPriceEach(1);

req.setChargeShippingOn(1);

req.setIsTaxedInRegion(1);

req.setIsTaxedInRegionFed(1);

req.setIsTaxedInRegionState(1);

req.setTaxablePriceEach(1);

req.setTaxable(1);

req.setCombinedTax(1);

req.setFedTax(1);

req.setStateTax(1);

req.setCityTax(1);

req.setCityLocalTax(1);

req.setCountyTax(1);

req.setCountyLocalTax(1);

req.setManualTax(1);

req.setIsBackOrder(1);

req.setWeightEach(1);

req.setOther1Each(1);

req.setOther2Each(1);

req.setOther3Each(1);

req.setOther4Each(1);

req.setOther5Each(1);

req.setOther6Each(1);

req.setOther7Each(1);

req.setOther8Each(1);

req.setOther9Each(1);

req.setOther10Each(1);

req.setDiscountExt(1);

req.setOriginalTaxableEach(1);

req.setOriginalBVEach(1);

req.setOriginalCVEach(1);

req.setStateTaxable(1);

req.setIsStateTaxOverride(1);

req.setDynamicKitItemID(1);

req.setHandlingFee(1);

req.setReference1("1");

req.setOrderKey("1");

//Send Request to Server and Get Response

CreateOrderDetailResponse res = api.getExigoApiSoap().createOrderDetail(req, auth);

//Now examine the results:

}

catch (Exception ex)

{

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

}

CSV

This method does not support csv output.

Exigo Web Services API v2022.12.19.1

CreateOrderDetail

Input Properties

CreateOrderDetailRequest

Output Properties

CreateOrderDetailResponse

Soap Response

C# Soap Client

VB.Net

PHP

Java

CSV