Guides
Guides
  1. Items:Products

AddItem

Description

The AddItem method is used to create a new ItemDetails object in the EBizCharge platform.

Syntax

ItemDetailsResponse AddItem(SecurityToken securityToken, ItemDetails itemDetails)

Arguments

Type

Name

Req.

Description

SecurityToken

securityToken

R

A unique token that is used to identify a merchant and authenticate the API request.

ItemDetails

itemDetails

R

Details of the new item.

Required Fields
  • ItemId
  • UnitPrice
  • UnitCost
  • Active
  • QtyOnHand
  • Taxable
  • TaxRate

Return Value

TypeDescription
ItemDetailsResponseIndicates whether the operation was successful. If successful, returns the assigned ItemInternalId. Otherwise, returns error information.

Example Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ebiz="http://eBizCharge.ServiceModel.SOAP">
   <soapenv:Header/>
   <soapenv:Body>
      <ebiz:AddItem>  
         <ebiz:securityToken>
            <ebiz:SecurityId>*************-4621-b899-************</ebiz:SecurityId>
            <ebiz:UserId/>
            <ebiz:Password/>
         </ebiz:securityToken>
         <ebiz:itemDetails>                    
            <ebiz:ItemId>P-0200</ebiz:ItemId>            
            <ebiz:Name/>        
            <ebiz:SKU/>            
            <ebiz:UPC/>            
            <ebiz:Description/>
            <ebiz:UnitPrice>2000</ebiz:UnitPrice>
            <ebiz:UnitCost>800</ebiz:UnitCost>            
            <ebiz:UnitOfMeasure/>
            <ebiz:Active>true</ebiz:Active>            
            <ebiz:ItemType/>
            <ebiz:QtyOnHand>20</ebiz:QtyOnHand>
            <ebiz:Taxable>true</ebiz:Taxable>
            <ebiz:TaxRate>10</ebiz:TaxRate>            
            <ebiz:SoftwareId/>            
            <ebiz:ItemCategoryId/>          
            <ebiz:ItemNotes/>            
            <ebiz:DateTimeCreated/>            
            <ebiz:DateTimeModified/>           
            <ebiz:ItemUniqueId/>            
            <ebiz:ImageUrl/>            
            <ebiz:TaxCategoryID/>          
            <ebiz:ItemCustomFields>
               <!--Zero or more repetitions:-->
               <ebiz:EbizCustomField>                  
                  <ebiz:FieldId/>                  
                  <ebiz:FieldCaption/>                  
                  <ebiz:FieldName/>                  
                  <ebiz:FieldValue/>                  
                  <ebiz:FieldType/>                  
                  <ebiz:FieldDataType/>                  
                  <ebiz:FieldDescription/>
               </ebiz:EbizCustomField>
            </ebiz:ItemCustomFields>            
            <ebiz:ItemLastSyncDateTime/>            
            <ebiz:DivisionId/>           
            <ebiz:LocationId/>
         </ebiz:itemDetails>
      </ebiz:AddItem>
   </soapenv:Body>
</soapenv:Envelope>
private static void AddItem()
{
  IeBizService apiClient = new IeBizServiceClient();
  SecurityToken securityToken = new SecurityToken
  {
    SecurityId = "*******-c870-41b8-aa5c-********", // Replace with your actual token
    UserId = "",
    Password = ""
    };
  ItemDetails itemDetails = new ItemDetails();
  itemDetails.ItemInternalId = "";
  itemDetails.ItemId = "ITEM1001";
  itemDetails.Name = "Sample Item";
  itemDetails.SKU = "";
  itemDetails.UPC = "";
  itemDetails.Description = "";
  itemDetails.UnitPrice = 10;
  itemDetails.UnitCost = 10;
  itemDetails.UnitOfMeasure = "m";
  itemDetails.Active = true;
  itemDetails.ItemType = "Inventory";
  itemDetails.QtyOnHand = 100;
  itemDetails.Taxable = true;
  itemDetails.TaxRate = 0;
  itemDetails.SoftwareId = "";
  itemDetails.ItemCategoryId = "";
  itemDetails.ItemNotes = "";
  itemDetails.DateTimeCreated = DateTime.Now.ToString();
  itemDetails.DateTimeModified = "";
  itemDetails.ItemUniqueId = "";
  itemDetails.ImageUrl = "";
  itemDetails.ItemLastSyncDateTime = "";
  itemDetails.DivisionId = "";
  itemDetails.LocationId = "";
  ItemDetailsResponse response = apiClient.AddItem(securityToken, itemDetails);
  //Display results
  Console.WriteLine($"Status: {response.Status}");
  Console.WriteLine($"Status Code: {response.StatusCode}");
  Console.WriteLine($"Error: {response.Error}");
  Console.WriteLine($"Error Code: {response.ErrorCode}");
  Console.ReadLine();
}
function addItem(){
  $client = new SoapClient('End point URL');
  $securityToken = array(
    'SecurityId' => '******-454757-4567457-777',
    'UserId' => 'merchant1',
    'Password' => 'merchant1'
  );
  $itemDetails = array(
    'ItemId' => 1,
    'Name' => 'AC',
    'SKU' => 'Tets-123',
    'Description' => 'Test',
    'UnitPrice' => 12,
    'UnitCost' => '0',
    'UnitOfMeasure' => '',
    'Active' => 1,
    'ItemType' => 1,
    'QtyOnHand' => 12,
    'UPC' => '',
    'Taxable' => '0',
    'TaxRate' => '0',
    'ItemCategoryId' => '',
    'TaxCategoryID' => '',
    'ImageUrl' => '',
    'ItemNotes' => '',
    'GrossPrice' => 0,
    'WarrantyDiscount' => 0,
    'SalesDiscount' => 0
  );
  $addItem = array(
    'securityToken' => $securityToken,
    'itemDetails' => $itemDetails
  )
    $addItemResponse = $client->AddItem($addItem);
  $addItemResponseResult = $addItemResponse->AddItemResult;
}

Example Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
      <AddItemResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
         <AddItemResult>
            <ItemInternalId>*************-4794-8bdc-************</ItemInternalId>
            <Status>Success</Status>
            <StatusCode>1</StatusCode>
            <Error/>
            <ErrorCode>0</ErrorCode>
         </AddItemResult>
      </AddItemResponse>
   </s:Body>
</s:Envelope>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
      <AddItemResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
         <AddItemResult>
            <ItemInternalId/>
            <Status>Error</Status>
            <StatusCode>0</StatusCode>
            <Error>Record already exists</Error>
            <ErrorCode>2</ErrorCode>
         </AddItemResult>
      </AddItemResponse>
   </s:Body>
</s:Envelope>

Updated 5 months ago