Exigo Web Services API v3.4.244

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
OrderIDInt32
TrackingNumber1StringOptional.
TrackingNumber2StringOptional.
TrackingNumber3StringOptional.
TrackingNumber4StringOptional.
TrackingNumber5StringOptional.
Other11StringOptional.
Other12StringOptional.
Other13StringOptional.
Other14StringOptional.
Other15StringOptional.
Other16StringOptional.
Other17StringOptional.
Other18StringOptional.
Other19StringOptional.
Other20StringOptional.
WebCarrierID1 OrderShipCarrierOptional.
WebCarrierID2 OrderShipCarrierOptional.
WebCarrierID3 OrderShipCarrierOptional.
WebCarrierID4 OrderShipCarrierOptional.
WebCarrierID5 OrderShipCarrierOptional.
LockedDateDateTimeOptional.
OrderDateDateTimeOptional.

Output Properties

UpdateOrderResponse
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/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> <TrackingNumber1>string</TrackingNumber1> <TrackingNumber2>string</TrackingNumber2> <TrackingNumber3>string</TrackingNumber3> <TrackingNumber4>string</TrackingNumber4> <TrackingNumber5>string</TrackingNumber5> <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> <WebCarrierID1>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</WebCarrierID1> <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> <LockedDate>dateTime</LockedDate> <OrderDate>dateTime</OrderDate> </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#

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;

    req.TrackingNumber1 = 1;

    req.TrackingNumber2 = 1;

    req.TrackingNumber3 = 1;

    req.TrackingNumber4 = 1;

    req.TrackingNumber5 = 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.WebCarrierID1 = OrderShipCarrier.FedEx;

    req.WebCarrierID2 = OrderShipCarrier.FedEx;

    req.WebCarrierID3 = OrderShipCarrier.FedEx;

    req.WebCarrierID4 = OrderShipCarrier.FedEx;

    req.WebCarrierID5 = OrderShipCarrier.FedEx;

    req.LockedDate = DateTime.Today;

    req.OrderDate = DateTime.Today;

 

    //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.TrackingNumber1 = 1

    req.TrackingNumber2 = 1

    req.TrackingNumber3 = 1

    req.TrackingNumber4 = 1

    req.TrackingNumber5 = 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.WebCarrierID1 = OrderShipCarrier.FedEx

    req.WebCarrierID2 = OrderShipCarrier.FedEx

    req.WebCarrierID3 = OrderShipCarrier.FedEx

    req.WebCarrierID4 = OrderShipCarrier.FedEx

    req.WebCarrierID5 = OrderShipCarrier.FedEx

    req.LockedDate = DateTime.Today

    req.OrderDate = DateTime.Today

 

    '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->TrackingNumber1 = 1;

    $req->TrackingNumber2 = 1;

    $req->TrackingNumber3 = 1;

    $req->TrackingNumber4 = 1;

    $req->TrackingNumber5 = 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->WebCarrierID1 = 1;

    $req->WebCarrierID2 = 1;

    $req->WebCarrierID3 = 1;

    $req->WebCarrierID4 = 1;

    $req->WebCarrierID5 = 1;

    $req->LockedDate = 1;

    $req->OrderDate = 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.setTrackingNumber1(1);

    req.setTrackingNumber2(1);

    req.setTrackingNumber3(1);

    req.setTrackingNumber4(1);

    req.setTrackingNumber5(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.setWebCarrierID1(1);

    req.setWebCarrierID2(1);

    req.setWebCarrierID3(1);

    req.setWebCarrierID4(1);

    req.setWebCarrierID5(1);

    req.setLockedDate(1);

    req.setOrderDate(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.