Exigo Web Services API v2022.12.19.1

CreateWarehouse

Creates a new Warehouse

Input Properties

CreateWarehouseRequest
PropertyData TypeNotes
DescriptionStringOptional.
Address1StringOptional.
Address2StringOptional.
CityStringOptional.
State StringOptional.
ZipStringOptional.
Country StringOptional.
CurrenciesString[]

Output Properties

CreateWarehouseResponse
PropertyData TypeNotes
WarehouseWarehouseResponse

Http Request

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

{ "description": "", "address1": "", "address2": "", "city": "", "zip": "", "currencies": null }

Http Response

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

{ "warehouse": null, "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/CreateWarehouse"

<?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> <CreateWarehouseRequest xmlns="http://api.exigo.com/"> <Description>string</Description> <Address1>string</Address1> <Address2>string</Address2> <City>string</City> <State>string</State> <Zip>string</Zip> <Country>string</Country> <Currencies> <string>string</string> </Currencies> </CreateWarehouseRequest> </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> <CreateWarehouseResult xmlns="http://api.exigo.com/"> <Warehouse> <WarehouseID>int</WarehouseID> <Description>string</Description> <Address1>string</Address1> <Address2>string</Address2> <City>string</City> <State>string</State> <Zip>string</Zip> <Country>string</Country> </Warehouse> </CreateWarehouseResult> </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 CreateWarehouseRequest();

 

    req.Description = "1";

    req.Address1 = "1";

    req.Address2 = "1";

    req.City = "1";

    req.Zip = "1";

 

    //Add Currencies

    var currencies = new List<String>();

    currencies.Add("1");

    currencies.Add("2");

 

    //Now attach the list to the request

    req.Currencies = currencies.ToArray();

 

    //Send Request to Server and Get Response

    var res = await api.CreateWarehouseAsync(req);

 

    //Now examine the results:

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

}

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

    CreateWarehouseRequest req = new CreateWarehouseRequest();

 

    req.Description = "1";

    req.Address1 = "1";

    req.Address2 = "1";

    req.City = "1";

    req.Zip = "1";

 

    //Add Currencies

    List<String> currencies = new List<String>();

    currencies.Add("1");

    currencies.Add("2");

 

    //Now attach the list to the request

    req.Currencies = currencies.ToArray();

 

    //Send Request to Server and Get Response

    CreateWarehouseResponse res = api.CreateWarehouse(req);

 

    //Now examine the results:

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

}

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

 

    req.Description = "1"

    req.Address1 = "1"

    req.Address2 = "1"

    req.City = "1"

    req.Zip = "1"

 

    'Add Currencies

    Dim currencies As New List(Of String)()

    currencies.Add("1")

    currencies.Add("2")

 

    'Now attach the list to the request

    req.Currencies = currencies.ToArray()

 

    'Send Request to Server and Get Response

    Dim res As CreateWarehouseResponse = api.CreateWarehouse(req)

 

    'Now examine the results:

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

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->Description = "1";

    $req->Address1 = "1";

    $req->Address2 = "1";

    $req->City = "1";

    $req->Zip = "1";

 

    //Add Currencies

 

    $currencie1->Chars = 1;

    $currencie1->Length = 1;

 

    $currencie2->Chars = 2;

    $currencie2->Length = 2;

 

    //Now attach the list to the request

    req.Currencies = array(currencie1,currencie2);

 

    //Send Request to Server and Get Response

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

    CreateWarehouseRequest req = new CreateWarehouseRequest();

 

    req.setDescription("1");

    req.setAddress1("1");

    req.setAddress2("1");

    req.setCity("1");

    req.setZip("1");

 

    //Add Currencies

    ArrayOfSystem.String currencies = new ArrayOfSystem.String();

 

    String currencie1 = new String();

    currencie1.setChars(1);

    currencie1.setLength(1);

    currencies.Add(currencie1);

 

    String currencie2 = new String();

    currencie2.setChars(2);

    currencie2.setLength(2);

    currencies.Add(currencie2);

 

    //Now attach the list to the request

    req.setCurrencies(currencies);

 

    //Send Request to Server and Get Response

    CreateWarehouseResponse res = api.getExigoApiSoap().createWarehouse(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

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

}

CSV

This method does not support csv output.