CreateItem
Adds an Item (and optional warehouse/price info)Note: This request can participate in a transaction. Learn more about transactions.
Input Properties
CreateItemRequest
Output Properties
CreateItemResponse
Http Request
POST https://yourcompany-api.exigo.com/3.0/item HTTP/1.1 Content-Type: application/json Authorization: Basic base64Encoded(yourlogin@yourcompany:yourpassword){ "itemCode": "1", "description": "", "weight": null, "notes": "", "availableInAllCountryRegions": true, "taxedInAllCountryRegions": true, "availableInAllWarehouses": true, "isVirtual": true, "itemTypeID": 1, "isSubscriptionUpdate": true, "isPointIncrement": true, "otherCheck1": true, "otherCheck2": true, "otherCheck3": true, "otherCheck4": true, "otherCheck5": true, "field1": "1", "field2": "1", "field3": "1", "field4": "1", "field5": "1", "field6": "1", "field7": "1", "field8": "1", "field9": "1", "field10": "1", "hideFromSearch": true }
Http Response
HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 Content-Length: length{ "itemID": 1, "itemCode": "", "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: totallife-api.exigo.com Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "https://api.exigo.com/CreateItem" <?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> <CreateItemRequest xmlns="http://api.exigo.com/"> <ItemCode>string</ItemCode> <Description>string</Description> <Weight>decimal</Weight> <Notes>string</Notes> <AvailableInAllCountryRegions>boolean</AvailableInAllCountryRegions> <TaxedInAllCountryRegions>boolean</TaxedInAllCountryRegions> <AvailableInAllWarehouses>boolean</AvailableInAllWarehouses> <IsVirtual>boolean</IsVirtual> <ItemTypeID>int</ItemTypeID> <IsSubscriptionUpdate>boolean</IsSubscriptionUpdate> <IsPointIncrement>boolean</IsPointIncrement> <OtherCheck1>boolean</OtherCheck1> <OtherCheck2>boolean</OtherCheck2> <OtherCheck3>boolean</OtherCheck3> <OtherCheck4>boolean</OtherCheck4> <OtherCheck5>boolean</OtherCheck5> <Field1>string</Field1> <Field2>string</Field2> <Field3>string</Field3> <Field4>string</Field4> <Field5>string</Field5> <Field6>string</Field6> <Field7>string</Field7> <Field8>string</Field8> <Field9>string</Field9> <Field10>string</Field10> <HideFromSearch>boolean</HideFromSearch> </CreateItemRequest> </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> <CreateItemResult xmlns="http://api.exigo.com/"> <ItemID>int</ItemID> <ItemCode>string</ItemCode> </CreateItemResult> </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 CreateItemRequest();
req.ItemCode = "1";
req.Description = "1";
req.Weight = 1;
req.Notes = "1";
req.AvailableInAllCountryRegions = true;
req.TaxedInAllCountryRegions = true;
req.AvailableInAllWarehouses = true;
req.IsVirtual = true;
req.ItemTypeID = 1;
req.IsSubscriptionUpdate = true;
req.IsPointIncrement = true;
req.OtherCheck1 = true;
req.OtherCheck2 = true;
req.OtherCheck3 = true;
req.OtherCheck4 = true;
req.OtherCheck5 = true;
req.Field1 = "1";
req.Field2 = "1";
req.Field3 = "1";
req.Field4 = "1";
req.Field5 = "1";
req.Field6 = "1";
req.Field7 = "1";
req.Field8 = "1";
req.Field9 = "1";
req.Field10 = "1";
req.HideFromSearch = true;
//Send Request to Server and Get Response
var res = await api.CreateItemAsync(req);
//Now examine the results:
Console.WriteLine("ItemID: {0}", res.ItemID);
Console.WriteLine("ItemCode: {0}", res.ItemCode);
}
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
CreateItemRequest req = new CreateItemRequest();
req.ItemCode = "1";
req.Description = "1";
req.Weight = 1;
req.Notes = "1";
req.AvailableInAllCountryRegions = true;
req.TaxedInAllCountryRegions = true;
req.AvailableInAllWarehouses = true;
req.IsVirtual = true;
req.ItemTypeID = 1;
req.IsSubscriptionUpdate = true;
req.IsPointIncrement = true;
req.OtherCheck1 = true;
req.OtherCheck2 = true;
req.OtherCheck3 = true;
req.OtherCheck4 = true;
req.OtherCheck5 = true;
req.Field1 = "1";
req.Field2 = "1";
req.Field3 = "1";
req.Field4 = "1";
req.Field5 = "1";
req.Field6 = "1";
req.Field7 = "1";
req.Field8 = "1";
req.Field9 = "1";
req.Field10 = "1";
req.HideFromSearch = true;
//Send Request to Server and Get Response
CreateItemResponse res = api.CreateItem(req);
//Now examine the results:
Console.WriteLine("ItemID: {0}", res.ItemID);
Console.WriteLine("ItemCode: {0}", res.ItemCode);
}
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 CreateItemRequest()
req.ItemCode = "1"
req.Description = "1"
req.Weight = 1
req.Notes = "1"
req.AvailableInAllCountryRegions = true
req.TaxedInAllCountryRegions = true
req.AvailableInAllWarehouses = true
req.IsVirtual = true
req.ItemTypeID = 1
req.IsSubscriptionUpdate = true
req.IsPointIncrement = true
req.OtherCheck1 = true
req.OtherCheck2 = true
req.OtherCheck3 = true
req.OtherCheck4 = true
req.OtherCheck5 = true
req.Field1 = "1"
req.Field2 = "1"
req.Field3 = "1"
req.Field4 = "1"
req.Field5 = "1"
req.Field6 = "1"
req.Field7 = "1"
req.Field8 = "1"
req.Field9 = "1"
req.Field10 = "1"
req.HideFromSearch = true
'Send Request to Server and Get Response
Dim res As CreateItemResponse = api.CreateItem(req)
'Now examine the results:
Console.WriteLine("ItemID: {0}", res.ItemID)
Console.WriteLine("ItemCode: {0}", res.ItemCode)
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->ItemCode = "1";
$req->Description = "1";
$req->Weight = 1;
$req->Notes = "1";
$req->AvailableInAllCountryRegions = 1;
$req->TaxedInAllCountryRegions = 1;
$req->AvailableInAllWarehouses = 1;
$req->IsVirtual = 1;
$req->ItemTypeID = 1;
$req->IsSubscriptionUpdate = 1;
$req->IsPointIncrement = 1;
$req->OtherCheck1 = 1;
$req->OtherCheck2 = 1;
$req->OtherCheck3 = 1;
$req->OtherCheck4 = 1;
$req->OtherCheck5 = 1;
$req->Field1 = "1";
$req->Field2 = "1";
$req->Field3 = "1";
$req->Field4 = "1";
$req->Field5 = "1";
$req->Field6 = "1";
$req->Field7 = "1";
$req->Field8 = "1";
$req->Field9 = "1";
$req->Field10 = "1";
$req->HideFromSearch = 1;
//Send Request to Server and Get Response
$res = $api.CreateItem($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
CreateItemRequest req = new CreateItemRequest();
req.setItemCode("1");
req.setDescription("1");
req.setWeight(1);
req.setNotes("1");
req.setAvailableInAllCountryRegions(1);
req.setTaxedInAllCountryRegions(1);
req.setAvailableInAllWarehouses(1);
req.setIsVirtual(1);
req.setItemTypeID(1);
req.setIsSubscriptionUpdate(1);
req.setIsPointIncrement(1);
req.setOtherCheck1(1);
req.setOtherCheck2(1);
req.setOtherCheck3(1);
req.setOtherCheck4(1);
req.setOtherCheck5(1);
req.setField1("1");
req.setField2("1");
req.setField3("1");
req.setField4("1");
req.setField5("1");
req.setField6("1");
req.setField7("1");
req.setField8("1");
req.setField9("1");
req.setField10("1");
req.setHideFromSearch(1);
//Send Request to Server and Get Response
CreateItemResponse res = api.getExigoApiSoap().createItem(req, auth);
//Now examine the results:
}
catch (Exception ex)
{
System.out.println("Error: " + ex.getMessage());
}