Exigo Web Services API v2022.12.19.1

UpdateOrder

Updates one or more fields on an existing order. Can participate in a transaction.

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

Input Properties

UpdateOrderRequest
PropertyData TypeNotes
OrderIDInt32Unique numeric identifier for order record.
OrderDateDateTimeOptional.
DeclineCountInt32Optional.
OrderTyInt32Optional.
OrderStatusInt32Optional.
PriceTy Int32Optional. Controls which price band to use.
TotalDecimalOptional.
SubTotalDecimalOptional.
ShippingDecimalOptional.
OrderTaxDecimalOptional.
ShippingTaxDecimalOptional.
FedShippingTaxDecimalOptional.
StateShippingTaxDecimalOptional.
CityShippingTaxDecimalOptional.
CityLocalShippingTaxDecimalOptional.
CountyShippingTaxDecimalOptional.
CountyLocalShippingTaxDecimalOptional.
ManualTaxRateDecimalOptional.
TotalTaxDecimalOptional.
CurrencyCode StringOptional.
PaymentMethodInt32Optional.
WarehouseID Int32Optional. Unique location for orders.
BatchIDInt32Optional.
PreviousBalanceDecimalOptional.
OverrideShippingBooleanOptional.
OverrideTaxBooleanOptional.
BusinessVolumeDecimalOptional. Price amount.
CommissionableVolumeDecimalOptional. Price amount.
Other1 DecimalOptional.
Other2 DecimalOptional.
Other3 DecimalOptional.
Other4 DecimalOptional.
Other5 DecimalOptional.
DiscountDecimalOptional.
DiscountPercentDecimalOptional.
WeightDecimalOptional.
SourcetyInt32Optional.
NotesStringOptional.
UsrStringOptional.
FirstNameStringOptional.
LastNameStringOptional.
CompanyStringOptional.
Address1StringOptional.
Address2StringOptional.
CityStringOptional.
State StringOptional.
ZipStringOptional.
Country StringOptional.
EmailStringOptional.
PhoneStringOptional.
SuppressPackSlipPriceBooleanOptional.
ShipMethodID Int32Optional.
AutoOrderIDInt32Optional.
CreatedByStringOptional.
ReturnOrderIDInt32Optional. Unique numeric identifier for transfer to order record.
OrderRankIDInt32Optional.
OrderPayRankIDInt32Optional.
AddressIsVerifiedBooleanOptional.
CountyStringOptional.
IsRMABooleanOptional.
BackOrderFromIDInt32Optional. Unique numeric identifier for transfer to order record.
CreditsEarnedDecimalOptional.
TotalFedTaxDecimalOptional.
TotalStateTaxDecimalOptional.
ManualShippingTaxDecimalOptional.
ReplacementOrderIDInt32Optional. Unique numeric identifier for transfer to order record.
LockedDateDateTimeOptional.
CommissionedDateDateTimeOptional.
Flag1BooleanOptional.
Flag2BooleanOptional.
Flag3BooleanOptional.
Other6 DecimalOptional.
Other7 DecimalOptional.
Other8 DecimalOptional.
Other9 DecimalOptional.
Other10 DecimalOptional.
OriginalWarehouseIDInt32Optional.
PickupNameStringOptional.
TransferToIDInt32Optional. Unique numeric identifier for transfer to order record.
IsCommissionableBooleanOptional.
FulfilledByStringOptional.
CreditAppliedDecimalOptional.
ShippedDateDateTimeOptional.
TaxLockDateDateTimeOptional.
TotalTaxableDecimalOptional.
ReturnCategoryIDInt32Optional.
ReplacementCategoryIDInt32Optional.
CalculatedShippingDecimalOptional.
HandlingFeeDecimalOptional.
OrderProcessTyInt32Optional.
ActualCarrierInt32Optional.
ParentOrderIDInt32Optional. Unique numeric identifier for transfer to order record.
CustomerTy Int32Optional. Classification of a customer as defined by the company.
ReferenceStringOptional.
MiddleNameStringOptional.
NameSuffixStringOptional.
Address3StringOptional.
PartyIDInt32Optional.
TrackingNumber1StringOptional.
TrackingNumber2StringOptional.
TrackingNumber3StringOptional.
TrackingNumber4StringOptional.
TrackingNumber5StringOptional.
WebCarrierID OrderShipCarrierOptional.
WebCarrierID2 OrderShipCarrierOptional.
WebCarrierID3 OrderShipCarrierOptional.
WebCarrierID4 OrderShipCarrierOptional.
WebCarrierID5 OrderShipCarrierOptional.
Other11StringOptional.
Other12StringOptional.
Other13StringOptional.
Other14StringOptional.
Other15StringOptional.
Other16StringOptional.
Other17StringOptional.
Other18StringOptional.
Other19StringOptional.
Other20StringOptional.
TransferToKeyStringOptional. Unique alpha numeric identifier for transfer to order record. Exeption will occur if TransferToID & TransferToKey are provided.
OrderKeyStringOptional. Unique alpha numeric identifier for order record. Exeption will occur if OrderID & OrderKey are provided.
ReturnOrderKeyStringOptional. Unique alpha numeric identifier for transfer to order record. Exeption will occur if ReturnOrderID & ReturnOrderKey are provided.
ReplacementOrderKeyStringOptional. Unique alpha numeric identifier for transfer to order record. Exeption will occur if ReplacementOrderID & ReplacementOrderKey are provided.
ParentOrderKeyStringOptional. Unique alpha numeric identifier for transfer to order record. Exeption will occur if ParentOrderID & ParentOrderKey are provided.
BackOrderFromKeyStringOptional. Unique alpha numeric identifier for transfer to order record. Exeption will occur if BackOrderFromID & BackOrderFromKey are provided.
OrderSubStatusTy Int32Optional. Optional Order Sub-Status Type (Set 0 to remove it from the Order.

Output Properties

UpdateOrderResponse
PropertyData TypeNotes

Http Request

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

{ "orderID": 1, "orderDate": "2024-03-19T00:00:00-05:00", "declineCount": 1, "orderTy": 1, "orderStatus": 1, "priceTy": 1, "total": null, "subTotal": null, "shipping": null, "orderTax": null, "shippingTax": null, "fedShippingTax": null, "stateShippingTax": null, "cityShippingTax": null, "cityLocalShippingTax": null, "countyShippingTax": null, "countyLocalShippingTax": null, "manualTaxRate": null, "totalTax": null, "currencyCode": null, "paymentMethod": 1, "warehouseID": 1, "batchID": 1, "previousBalance": null, "overrideShipping": true, "overrideTax": true, "businessVolume": null, "commissionableVolume": null, "discount": null, "discountPercent": null, "weight": null, "sourcety": 1, "notes": null, "usr": null, "firstName": null, "lastName": null, "company": null, "address1": null, "address2": null, "city": null, "zip": null, "email": null, "phone": null, "suppressPackSlipPrice": true, "shipMethodID": 1, "autoOrderID": 1, "createdBy": null, "returnOrderID": 1, "orderRankID": 1, "orderPayRankID": 1, "addressIsVerified": true, "county": null, "isRMA": true, "backOrderFromID": 1, "creditsEarned": null, "totalFedTax": null, "totalStateTax": null, "manualShippingTax": null, "replacementOrderID": 1, "lockedDate": "2024-03-19T00:00:00-05:00", "commissionedDate": "2024-03-19T00:00:00-05:00", "flag1": true, "flag2": true, "flag3": true, "originalWarehouseID": 1, "pickupName": null, "transferToID": 1, "isCommissionable": true, "fulfilledBy": null, "creditApplied": null, "shippedDate": "2024-03-19T00:00:00-05:00", "taxLockDate": "2024-03-19T00:00:00-05:00", "totalTaxable": null, "returnCategoryID": 1, "replacementCategoryID": 1, "calculatedShipping": null, "handlingFee": null, "orderProcessTy": 1, "actualCarrier": 1, "parentOrderID": 1, "customerTy": 1, "reference": null, "middleName": null, "nameSuffix": null, "address3": null, "partyID": 1, "trackingNumber1": null, "trackingNumber2": null, "trackingNumber3": null, "trackingNumber4": null, "trackingNumber5": null, "webCarrierID": null, "webCarrierID2": null, "webCarrierID3": null, "webCarrierID4": null, "webCarrierID5": null, "other11": null, "other12": null, "other13": null, "other14": null, "other15": null, "other16": null, "other17": null, "other18": null, "other19": null, "other20": null, "transferToKey": "1", "orderKey": "DDks8235txcid", "returnOrderKey": "1", "replacementOrderKey": "1", "parentOrderKey": "1", "backOrderFromKey": "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: api.exigo.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://api.exigo.com/UpdateOrder"

<?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> <UpdateOrderRequest xmlns="http://api.exigo.com/"> <OrderID>int</OrderID> <OrderDate>dateTime</OrderDate> <DeclineCount>int</DeclineCount> <OrderTy>int</OrderTy> <OrderStatus>int</OrderStatus> <PriceTy>int</PriceTy> <Total>decimal</Total> <SubTotal>decimal</SubTotal> <Shipping>decimal</Shipping> <OrderTax>decimal</OrderTax> <ShippingTax>decimal</ShippingTax> <FedShippingTax>decimal</FedShippingTax> <StateShippingTax>decimal</StateShippingTax> <CityShippingTax>decimal</CityShippingTax> <CityLocalShippingTax>decimal</CityLocalShippingTax> <CountyShippingTax>decimal</CountyShippingTax> <CountyLocalShippingTax>decimal</CountyLocalShippingTax> <ManualTaxRate>decimal</ManualTaxRate> <TotalTax>decimal</TotalTax> <CurrencyCode>string</CurrencyCode> <PaymentMethod>int</PaymentMethod> <WarehouseID>int</WarehouseID> <BatchID>int</BatchID> <PreviousBalance>decimal</PreviousBalance> <OverrideShipping>boolean</OverrideShipping> <OverrideTax>boolean</OverrideTax> <BusinessVolume>decimal</BusinessVolume> <CommissionableVolume>decimal</CommissionableVolume> <Other1>decimal</Other1> <Other2>decimal</Other2> <Other3>decimal</Other3> <Other4>decimal</Other4> <Other5>decimal</Other5> <Discount>decimal</Discount> <DiscountPercent>decimal</DiscountPercent> <Weight>decimal</Weight> <Sourcety>int</Sourcety> <Notes>string</Notes> <Usr>string</Usr> <FirstName>string</FirstName> <LastName>string</LastName> <Company>string</Company> <Address1>string</Address1> <Address2>string</Address2> <City>string</City> <State>string</State> <Zip>string</Zip> <Country>string</Country> <Email>string</Email> <Phone>string</Phone> <SuppressPackSlipPrice>boolean</SuppressPackSlipPrice> <ShipMethodID>int</ShipMethodID> <AutoOrderID>int</AutoOrderID> <CreatedBy>string</CreatedBy> <ReturnOrderID>int</ReturnOrderID> <OrderRankID>int</OrderRankID> <OrderPayRankID>int</OrderPayRankID> <AddressIsVerified>boolean</AddressIsVerified> <County>string</County> <IsRMA>boolean</IsRMA> <BackOrderFromID>int</BackOrderFromID> <CreditsEarned>decimal</CreditsEarned> <TotalFedTax>decimal</TotalFedTax> <TotalStateTax>decimal</TotalStateTax> <ManualShippingTax>decimal</ManualShippingTax> <ReplacementOrderID>int</ReplacementOrderID> <LockedDate>dateTime</LockedDate> <CommissionedDate>dateTime</CommissionedDate> <Flag1>boolean</Flag1> <Flag2>boolean</Flag2> <Flag3>boolean</Flag3> <Other6>decimal</Other6> <Other7>decimal</Other7> <Other8>decimal</Other8> <Other9>decimal</Other9> <Other10>decimal</Other10> <OriginalWarehouseID>int</OriginalWarehouseID> <PickupName>string</PickupName> <TransferToID>int</TransferToID> <IsCommissionable>boolean</IsCommissionable> <FulfilledBy>string</FulfilledBy> <CreditApplied>decimal</CreditApplied> <ShippedDate>dateTime</ShippedDate> <TaxLockDate>dateTime</TaxLockDate> <TotalTaxable>decimal</TotalTaxable> <ReturnCategoryID>int</ReturnCategoryID> <ReplacementCategoryID>int</ReplacementCategoryID> <CalculatedShipping>decimal</CalculatedShipping> <HandlingFee>decimal</HandlingFee> <OrderProcessTy>int</OrderProcessTy> <ActualCarrier>int</ActualCarrier> <ParentOrderID>int</ParentOrderID> <CustomerTy>int</CustomerTy> <Reference>string</Reference> <MiddleName>string</MiddleName> <NameSuffix>string</NameSuffix> <Address3>string</Address3> <PartyID>int</PartyID> <TrackingNumber1>string</TrackingNumber1> <TrackingNumber2>string</TrackingNumber2> <TrackingNumber3>string</TrackingNumber3> <TrackingNumber4>string</TrackingNumber4> <TrackingNumber5>string</TrackingNumber5> <WebCarrierID>FedEx or UPS or Purolator or CanadaPostRegular or CanadaPostExpress or DHL or USPS or Estafeta or RoyalMail or GLSHungary or PostenNorway or LandMarkGlobal or GDEX</WebCarrierID> <WebCarrierID2>FedEx or UPS or Purolator or CanadaPostRegular or CanadaPostExpress or DHL or USPS or Estafeta or RoyalMail or GLSHungary or PostenNorway or LandMarkGlobal or GDEX</WebCarrierID2> <WebCarrierID3>FedEx or UPS or Purolator or CanadaPostRegular or CanadaPostExpress or DHL or USPS or Estafeta or RoyalMail or GLSHungary or PostenNorway or LandMarkGlobal or GDEX</WebCarrierID3> <WebCarrierID4>FedEx or UPS or Purolator or CanadaPostRegular or CanadaPostExpress or DHL or USPS or Estafeta or RoyalMail or GLSHungary or PostenNorway or LandMarkGlobal or GDEX</WebCarrierID4> <WebCarrierID5>FedEx or UPS or Purolator or CanadaPostRegular or CanadaPostExpress or DHL or USPS or Estafeta or RoyalMail or GLSHungary or PostenNorway or LandMarkGlobal or GDEX</WebCarrierID5> <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> <TransferToKey>string</TransferToKey> <OrderKey>string</OrderKey> <ReturnOrderKey>string</ReturnOrderKey> <ReplacementOrderKey>string</ReplacementOrderKey> <ParentOrderKey>string</ParentOrderKey> <BackOrderFromKey>string</BackOrderFromKey> <OrderSubStatusTy>int</OrderSubStatusTy> </UpdateOrderRequest> </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> <UpdateOrderResult 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 UpdateOrderRequest();

 

    req.OrderID = 1;                //Unique numeric identifier for order record.

    req.OrderDate = DateTime.Today;

    req.DeclineCount = 1;

    req.OrderTy = 1;

    req.OrderStatus = 1;

    req.PriceTy = 1;                //Controls which price band to use

    req.Total = 1;

    req.SubTotal = 1;

    req.Shipping = 1;

    req.OrderTax = 1;

    req.ShippingTax = 1;

    req.FedShippingTax = 1;

    req.StateShippingTax = 1;

    req.CityShippingTax = 1;

    req.CityLocalShippingTax = 1;

    req.CountyShippingTax = 1;

    req.CountyLocalShippingTax = 1;

    req.ManualTaxRate = 1;

    req.TotalTax = 1;

    req.CurrencyCode = usd;

    req.PaymentMethod = 1;

    req.WarehouseID = 1;            //Unique location for orders

    req.BatchID = 1;

    req.PreviousBalance = 1;

    req.OverrideShipping = true;

    req.OverrideTax = true;

    req.BusinessVolume = 1;         //Price amount

    req.CommissionableVolume = 1;   //Price amount

    req.Discount = 1;

    req.DiscountPercent = 1;

    req.Weight = 1;

    req.Sourcety = 1;

    req.Notes = 1;

    req.Usr = 1;

    req.FirstName = 1;

    req.LastName = 1;

    req.Company = 1;

    req.Address1 = 1;

    req.Address2 = 1;

    req.City = 1;

    req.Zip = 1;

    req.Email = 1;

    req.Phone = 1;

    req.SuppressPackSlipPrice = true;

    req.ShipMethodID = 1;

    req.AutoOrderID = 1;

    req.CreatedBy = 1;

    req.ReturnOrderID = 1;          //Unique numeric identifier for transfer to order record.

    req.OrderRankID = 1;

    req.OrderPayRankID = 1;

    req.AddressIsVerified = true;

    req.County = 1;

    req.IsRMA = true;

    req.BackOrderFromID = 1;        //Unique numeric identifier for transfer to order record.

    req.CreditsEarned = 1;

    req.TotalFedTax = 1;

    req.TotalStateTax = 1;

    req.ManualShippingTax = 1;

    req.ReplacementOrderID = 1;     //Unique numeric identifier for transfer to order record.

    req.LockedDate = DateTime.Today;

    req.CommissionedDate = DateTime.Today;

    req.Flag1 = true;

    req.Flag2 = true;

    req.Flag3 = true;

    req.OriginalWarehouseID = 1;

    req.PickupName = 1;

    req.TransferToID = 1;           //Unique numeric identifier for transfer to order record.

    req.IsCommissionable = true;

    req.FulfilledBy = 1;

    req.CreditApplied = 1;

    req.ShippedDate = DateTime.Today;

    req.TaxLockDate = DateTime.Today;

    req.TotalTaxable = 1;

    req.ReturnCategoryID = 1;

    req.ReplacementCategoryID = 1;

    req.CalculatedShipping = 1;

    req.HandlingFee = 1;

    req.OrderProcessTy = 1;

    req.ActualCarrier = 1;

    req.ParentOrderID = 1;          //Unique numeric identifier for transfer to order record.

    req.CustomerTy = 1;             //Classification of a customer as defined by the company

    req.Reference = 1;

    req.MiddleName = 1;

    req.NameSuffix = 1;

    req.Address3 = 1;

    req.PartyID = 1;

    req.TrackingNumber1 = 1;

    req.TrackingNumber2 = 1;

    req.TrackingNumber3 = 1;

    req.TrackingNumber4 = 1;

    req.TrackingNumber5 = 1;

    req.WebCarrierID = OrderShipCarrier.FedEx;

    req.WebCarrierID2 = OrderShipCarrier.FedEx;

    req.WebCarrierID3 = OrderShipCarrier.FedEx;

    req.WebCarrierID4 = OrderShipCarrier.FedEx;

    req.WebCarrierID5 = OrderShipCarrier.FedEx;

    req.Other11 = 1;

    req.Other12 = 1;

    req.Other13 = 1;

    req.Other14 = 1;

    req.Other15 = 1;

    req.Other16 = 1;

    req.Other17 = 1;

    req.Other18 = 1;

    req.Other19 = 1;

    req.Other20 = 1;

    req.TransferToKey = "1";        //Unique alpha numeric identifier for transfer to order record. Exeption will occur if TransferToID & TransferToKey are provided.

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

    req.ReturnOrderKey = "1";       //Unique alpha numeric identifier for transfer to order record. Exeption will occur if ReturnOrderID & ReturnOrderKey are provided.

    req.ReplacementOrderKey = "1";  //Unique alpha numeric identifier for transfer to order record. Exeption will occur if ReplacementOrderID & ReplacementOrderKey are provided.

    req.ParentOrderKey = "1";       //Unique alpha numeric identifier for transfer to order record. Exeption will occur if ParentOrderID & ParentOrderKey are provided.

    req.BackOrderFromKey = "1";     //Unique alpha numeric identifier for transfer to order record. Exeption will occur if BackOrderFromID & BackOrderFromKey are provided.

 

    //Send Request to Server and Get Response

    var res = await api.UpdateOrderAsync(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

    UpdateOrderRequest req = new UpdateOrderRequest();

 

    req.OrderID = 1;                //Unique numeric identifier for order record.

    req.OrderDate = DateTime.Today;

    req.DeclineCount = 1;

    req.OrderTy = 1;

    req.OrderStatus = 1;

    req.PriceTy = 1;                //Controls which price band to use

    req.Total = 1;

    req.SubTotal = 1;

    req.Shipping = 1;

    req.OrderTax = 1;

    req.ShippingTax = 1;

    req.FedShippingTax = 1;

    req.StateShippingTax = 1;

    req.CityShippingTax = 1;

    req.CityLocalShippingTax = 1;

    req.CountyShippingTax = 1;

    req.CountyLocalShippingTax = 1;

    req.ManualTaxRate = 1;

    req.TotalTax = 1;

    req.CurrencyCode = usd;

    req.PaymentMethod = 1;

    req.WarehouseID = 1;            //Unique location for orders

    req.BatchID = 1;

    req.PreviousBalance = 1;

    req.OverrideShipping = true;

    req.OverrideTax = true;

    req.BusinessVolume = 1;         //Price amount

    req.CommissionableVolume = 1;   //Price amount

    req.Discount = 1;

    req.DiscountPercent = 1;

    req.Weight = 1;

    req.Sourcety = 1;

    req.Notes = 1;

    req.Usr = 1;

    req.FirstName = 1;

    req.LastName = 1;

    req.Company = 1;

    req.Address1 = 1;

    req.Address2 = 1;

    req.City = 1;

    req.Zip = 1;

    req.Email = 1;

    req.Phone = 1;

    req.SuppressPackSlipPrice = true;

    req.ShipMethodID = 1;

    req.AutoOrderID = 1;

    req.CreatedBy = 1;

    req.ReturnOrderID = 1;          //Unique numeric identifier for transfer to order record.

    req.OrderRankID = 1;

    req.OrderPayRankID = 1;

    req.AddressIsVerified = true;

    req.County = 1;

    req.IsRMA = true;

    req.BackOrderFromID = 1;        //Unique numeric identifier for transfer to order record.

    req.CreditsEarned = 1;

    req.TotalFedTax = 1;

    req.TotalStateTax = 1;

    req.ManualShippingTax = 1;

    req.ReplacementOrderID = 1;     //Unique numeric identifier for transfer to order record.

    req.LockedDate = DateTime.Today;

    req.CommissionedDate = DateTime.Today;

    req.Flag1 = true;

    req.Flag2 = true;

    req.Flag3 = true;

    req.OriginalWarehouseID = 1;

    req.PickupName = 1;

    req.TransferToID = 1;           //Unique numeric identifier for transfer to order record.

    req.IsCommissionable = true;

    req.FulfilledBy = 1;

    req.CreditApplied = 1;

    req.ShippedDate = DateTime.Today;

    req.TaxLockDate = DateTime.Today;

    req.TotalTaxable = 1;

    req.ReturnCategoryID = 1;

    req.ReplacementCategoryID = 1;

    req.CalculatedShipping = 1;

    req.HandlingFee = 1;

    req.OrderProcessTy = 1;

    req.ActualCarrier = 1;

    req.ParentOrderID = 1;          //Unique numeric identifier for transfer to order record.

    req.CustomerTy = 1;             //Classification of a customer as defined by the company

    req.Reference = 1;

    req.MiddleName = 1;

    req.NameSuffix = 1;

    req.Address3 = 1;

    req.PartyID = 1;

    req.TrackingNumber1 = 1;

    req.TrackingNumber2 = 1;

    req.TrackingNumber3 = 1;

    req.TrackingNumber4 = 1;

    req.TrackingNumber5 = 1;

    req.WebCarrierID = OrderShipCarrier.FedEx;

    req.WebCarrierID2 = OrderShipCarrier.FedEx;

    req.WebCarrierID3 = OrderShipCarrier.FedEx;

    req.WebCarrierID4 = OrderShipCarrier.FedEx;

    req.WebCarrierID5 = OrderShipCarrier.FedEx;

    req.Other11 = 1;

    req.Other12 = 1;

    req.Other13 = 1;

    req.Other14 = 1;

    req.Other15 = 1;

    req.Other16 = 1;

    req.Other17 = 1;

    req.Other18 = 1;

    req.Other19 = 1;

    req.Other20 = 1;

    req.TransferToKey = "1";        //Unique alpha numeric identifier for transfer to order record. Exeption will occur if TransferToID & TransferToKey are provided.

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

    req.ReturnOrderKey = "1";       //Unique alpha numeric identifier for transfer to order record. Exeption will occur if ReturnOrderID & ReturnOrderKey are provided.

    req.ReplacementOrderKey = "1";  //Unique alpha numeric identifier for transfer to order record. Exeption will occur if ReplacementOrderID & ReplacementOrderKey are provided.

    req.ParentOrderKey = "1";       //Unique alpha numeric identifier for transfer to order record. Exeption will occur if ParentOrderID & ParentOrderKey are provided.

    req.BackOrderFromKey = "1";     //Unique alpha numeric identifier for transfer to order record. Exeption will occur if BackOrderFromID & BackOrderFromKey are provided.

 

    //Send Request to Server and Get Response

    UpdateOrderResponse res = api.UpdateOrder(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 UpdateOrderRequest()

 

    req.OrderID = 1

    req.OrderDate = DateTime.Today

    req.DeclineCount = 1

    req.OrderTy = 1

    req.OrderStatus = 1

    req.PriceTy = 1

    req.Total = 1

    req.SubTotal = 1

    req.Shipping = 1

    req.OrderTax = 1

    req.ShippingTax = 1

    req.FedShippingTax = 1

    req.StateShippingTax = 1

    req.CityShippingTax = 1

    req.CityLocalShippingTax = 1

    req.CountyShippingTax = 1

    req.CountyLocalShippingTax = 1

    req.ManualTaxRate = 1

    req.TotalTax = 1

    req.CurrencyCode = usd

    req.PaymentMethod = 1

    req.WarehouseID = 1

    req.BatchID = 1

    req.PreviousBalance = 1

    req.OverrideShipping = true

    req.OverrideTax = true

    req.BusinessVolume = 1

    req.CommissionableVolume = 1

    req.Discount = 1

    req.DiscountPercent = 1

    req.Weight = 1

    req.Sourcety = 1

    req.Notes = 1

    req.Usr = 1

    req.FirstName = 1

    req.LastName = 1

    req.Company = 1

    req.Address1 = 1

    req.Address2 = 1

    req.City = 1

    req.Zip = 1

    req.Email = 1

    req.Phone = 1

    req.SuppressPackSlipPrice = true

    req.ShipMethodID = 1

    req.AutoOrderID = 1

    req.CreatedBy = 1

    req.ReturnOrderID = 1

    req.OrderRankID = 1

    req.OrderPayRankID = 1

    req.AddressIsVerified = true

    req.County = 1

    req.IsRMA = true

    req.BackOrderFromID = 1

    req.CreditsEarned = 1

    req.TotalFedTax = 1

    req.TotalStateTax = 1

    req.ManualShippingTax = 1

    req.ReplacementOrderID = 1

    req.LockedDate = DateTime.Today

    req.CommissionedDate = DateTime.Today

    req.Flag1 = true

    req.Flag2 = true

    req.Flag3 = true

    req.OriginalWarehouseID = 1

    req.PickupName = 1

    req.TransferToID = 1

    req.IsCommissionable = true

    req.FulfilledBy = 1

    req.CreditApplied = 1

    req.ShippedDate = DateTime.Today

    req.TaxLockDate = DateTime.Today

    req.TotalTaxable = 1

    req.ReturnCategoryID = 1

    req.ReplacementCategoryID = 1

    req.CalculatedShipping = 1

    req.HandlingFee = 1

    req.OrderProcessTy = 1

    req.ActualCarrier = 1

    req.ParentOrderID = 1

    req.CustomerTy = 1

    req.Reference = 1

    req.MiddleName = 1

    req.NameSuffix = 1

    req.Address3 = 1

    req.PartyID = 1

    req.TrackingNumber1 = 1

    req.TrackingNumber2 = 1

    req.TrackingNumber3 = 1

    req.TrackingNumber4 = 1

    req.TrackingNumber5 = 1

    req.WebCarrierID = OrderShipCarrier.FedEx

    req.WebCarrierID2 = OrderShipCarrier.FedEx

    req.WebCarrierID3 = OrderShipCarrier.FedEx

    req.WebCarrierID4 = OrderShipCarrier.FedEx

    req.WebCarrierID5 = OrderShipCarrier.FedEx

    req.Other11 = 1

    req.Other12 = 1

    req.Other13 = 1

    req.Other14 = 1

    req.Other15 = 1

    req.Other16 = 1

    req.Other17 = 1

    req.Other18 = 1

    req.Other19 = 1

    req.Other20 = 1

    req.TransferToKey = "1"

    req.OrderKey = "DDks8235txcid"

    req.ReturnOrderKey = "1"

    req.ReplacementOrderKey = "1"

    req.ParentOrderKey = "1"

    req.BackOrderFromKey = "1"

 

    'Send Request to Server and Get Response

    Dim res As UpdateOrderResponse = api.UpdateOrder(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->OrderID = 1;

    $req->OrderDate = 1;

    $req->DeclineCount = 1;

    $req->OrderTy = 1;

    $req->OrderStatus = 1;

    $req->PriceTy = 1;

    $req->Total = 1;

    $req->SubTotal = 1;

    $req->Shipping = 1;

    $req->OrderTax = 1;

    $req->ShippingTax = 1;

    $req->FedShippingTax = 1;

    $req->StateShippingTax = 1;

    $req->CityShippingTax = 1;

    $req->CityLocalShippingTax = 1;

    $req->CountyShippingTax = 1;

    $req->CountyLocalShippingTax = 1;

    $req->ManualTaxRate = 1;

    $req->TotalTax = 1;

    $req->CurrencyCode = usd;

    $req->PaymentMethod = 1;

    $req->WarehouseID = 1;

    $req->BatchID = 1;

    $req->PreviousBalance = 1;

    $req->OverrideShipping = 1;

    $req->OverrideTax = 1;

    $req->BusinessVolume = 1;

    $req->CommissionableVolume = 1;

    $req->Discount = 1;

    $req->DiscountPercent = 1;

    $req->Weight = 1;

    $req->Sourcety = 1;

    $req->Notes = 1;

    $req->Usr = 1;

    $req->FirstName = 1;

    $req->LastName = 1;

    $req->Company = 1;

    $req->Address1 = 1;

    $req->Address2 = 1;

    $req->City = 1;

    $req->Zip = 1;

    $req->Email = 1;

    $req->Phone = 1;

    $req->SuppressPackSlipPrice = 1;

    $req->ShipMethodID = 1;

    $req->AutoOrderID = 1;

    $req->CreatedBy = 1;

    $req->ReturnOrderID = 1;

    $req->OrderRankID = 1;

    $req->OrderPayRankID = 1;

    $req->AddressIsVerified = 1;

    $req->County = 1;

    $req->IsRMA = 1;

    $req->BackOrderFromID = 1;

    $req->CreditsEarned = 1;

    $req->TotalFedTax = 1;

    $req->TotalStateTax = 1;

    $req->ManualShippingTax = 1;

    $req->ReplacementOrderID = 1;

    $req->LockedDate = 1;

    $req->CommissionedDate = 1;

    $req->Flag1 = 1;

    $req->Flag2 = 1;

    $req->Flag3 = 1;

    $req->OriginalWarehouseID = 1;

    $req->PickupName = 1;

    $req->TransferToID = 1;

    $req->IsCommissionable = 1;

    $req->FulfilledBy = 1;

    $req->CreditApplied = 1;

    $req->ShippedDate = 1;

    $req->TaxLockDate = 1;

    $req->TotalTaxable = 1;

    $req->ReturnCategoryID = 1;

    $req->ReplacementCategoryID = 1;

    $req->CalculatedShipping = 1;

    $req->HandlingFee = 1;

    $req->OrderProcessTy = 1;

    $req->ActualCarrier = 1;

    $req->ParentOrderID = 1;

    $req->CustomerTy = 1;

    $req->Reference = 1;

    $req->MiddleName = 1;

    $req->NameSuffix = 1;

    $req->Address3 = 1;

    $req->PartyID = 1;

    $req->TrackingNumber1 = 1;

    $req->TrackingNumber2 = 1;

    $req->TrackingNumber3 = 1;

    $req->TrackingNumber4 = 1;

    $req->TrackingNumber5 = 1;

    $req->WebCarrierID = 1;

    $req->WebCarrierID2 = 1;

    $req->WebCarrierID3 = 1;

    $req->WebCarrierID4 = 1;

    $req->WebCarrierID5 = 1;

    $req->Other11 = 1;

    $req->Other12 = 1;

    $req->Other13 = 1;

    $req->Other14 = 1;

    $req->Other15 = 1;

    $req->Other16 = 1;

    $req->Other17 = 1;

    $req->Other18 = 1;

    $req->Other19 = 1;

    $req->Other20 = 1;

    $req->TransferToKey = "1";

    $req->OrderKey = "DDks8235txcid";

    $req->ReturnOrderKey = "1";

    $req->ReplacementOrderKey = "1";

    $req->ParentOrderKey = "1";

    $req->BackOrderFromKey = "1";

 

    //Send Request to Server and Get Response

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

    UpdateOrderRequest req = new UpdateOrderRequest();

 

    req.setOrderID(1);

    req.setOrderDate(1);

    req.setDeclineCount(1);

    req.setOrderTy(1);

    req.setOrderStatus(1);

    req.setPriceTy(1);

    req.setTotal(1);

    req.setSubTotal(1);

    req.setShipping(1);

    req.setOrderTax(1);

    req.setShippingTax(1);

    req.setFedShippingTax(1);

    req.setStateShippingTax(1);

    req.setCityShippingTax(1);

    req.setCityLocalShippingTax(1);

    req.setCountyShippingTax(1);

    req.setCountyLocalShippingTax(1);

    req.setManualTaxRate(1);

    req.setTotalTax(1);

    req.setCurrencyCode(usd);

    req.setPaymentMethod(1);

    req.setWarehouseID(1);

    req.setBatchID(1);

    req.setPreviousBalance(1);

    req.setOverrideShipping(1);

    req.setOverrideTax(1);

    req.setBusinessVolume(1);

    req.setCommissionableVolume(1);

    req.setDiscount(1);

    req.setDiscountPercent(1);

    req.setWeight(1);

    req.setSourcety(1);

    req.setNotes(1);

    req.setUsr(1);

    req.setFirstName(1);

    req.setLastName(1);

    req.setCompany(1);

    req.setAddress1(1);

    req.setAddress2(1);

    req.setCity(1);

    req.setZip(1);

    req.setEmail(1);

    req.setPhone(1);

    req.setSuppressPackSlipPrice(1);

    req.setShipMethodID(1);

    req.setAutoOrderID(1);

    req.setCreatedBy(1);

    req.setReturnOrderID(1);

    req.setOrderRankID(1);

    req.setOrderPayRankID(1);

    req.setAddressIsVerified(1);

    req.setCounty(1);

    req.setIsRMA(1);

    req.setBackOrderFromID(1);

    req.setCreditsEarned(1);

    req.setTotalFedTax(1);

    req.setTotalStateTax(1);

    req.setManualShippingTax(1);

    req.setReplacementOrderID(1);

    req.setLockedDate(1);

    req.setCommissionedDate(1);

    req.setFlag1(1);

    req.setFlag2(1);

    req.setFlag3(1);

    req.setOriginalWarehouseID(1);

    req.setPickupName(1);

    req.setTransferToID(1);

    req.setIsCommissionable(1);

    req.setFulfilledBy(1);

    req.setCreditApplied(1);

    req.setShippedDate(1);

    req.setTaxLockDate(1);

    req.setTotalTaxable(1);

    req.setReturnCategoryID(1);

    req.setReplacementCategoryID(1);

    req.setCalculatedShipping(1);

    req.setHandlingFee(1);

    req.setOrderProcessTy(1);

    req.setActualCarrier(1);

    req.setParentOrderID(1);

    req.setCustomerTy(1);

    req.setReference(1);

    req.setMiddleName(1);

    req.setNameSuffix(1);

    req.setAddress3(1);

    req.setPartyID(1);

    req.setTrackingNumber1(1);

    req.setTrackingNumber2(1);

    req.setTrackingNumber3(1);

    req.setTrackingNumber4(1);

    req.setTrackingNumber5(1);

    req.setWebCarrierID(1);

    req.setWebCarrierID2(1);

    req.setWebCarrierID3(1);

    req.setWebCarrierID4(1);

    req.setWebCarrierID5(1);

    req.setOther11(1);

    req.setOther12(1);

    req.setOther13(1);

    req.setOther14(1);

    req.setOther15(1);

    req.setOther16(1);

    req.setOther17(1);

    req.setOther18(1);

    req.setOther19(1);

    req.setOther20(1);

    req.setTransferToKey("1");

    req.setOrderKey("DDks8235txcid");

    req.setReturnOrderKey("1");

    req.setReplacementOrderKey("1");

    req.setParentOrderKey("1");

    req.setBackOrderFromKey("1");

 

    //Send Request to Server and Get Response

    UpdateOrderResponse res = api.getExigoApiSoap().updateOrder(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

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

}

CSV

This method does not support csv output.