SearchItems

Description

The SearchItems method retrieves ItemDetails objects from the EBizCharge platform.

Syntax

ItemDetails[] SearchItems(SecurityToken securityToken, string itemInternalId, string itemId, SearchFilter filters, int start, int limit, string sort)

Arguments

Type	Name	Req.	Description
SecurityToken	securityToken	R	A unique token that is used to identify a merchant and authenticate the API request.
string	itemInternalId	O	Returns the ItemDetails object with this internal ID.
string	itemId	O	User-defined item ID.
SearchFilter[]	filters	S	Filters ItemDetails objects based on one or more field names, comparison operators, and field values. See supported search parameters below. Note: If the SearchFilter object is empty, all ItemDetails objects will be returned.
int	start	R	Index of the first object to return in the array. Note: Must be ≥ 0.
int	limit	R	Maximum number of objects to return. Note: Must be > 0.
string	sort	O	Sorts by the field name. See the list of supported sort parameters below. Note: The `ItemCustomFields` parameter cannot be sorted by.

Return Value

Type	Description
ItemDetails[]	Returns an array of ItemDetails objects matching the searched parameters.

Supported Search/Sort Parameters

ItemInternalId Filters by the item's internal ID.

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        `<ebiz:FieldName>`ItemInternalId`</ebiz:FieldName>`
        `<ebiz:ComparisonOperator>`eq`</ebiz:ComparisonOperator>`
        `<ebiz:FieldValue>********-7682-4699-914b-********</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

<tr>
  <td>ItemId</td>
  <td>Fliters results by the item Id.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        `<ebiz:FieldName>`ItemId`</ebiz:FieldName>`
        `<ebiz:ComparisonOperator>`eq`</ebiz:ComparisonOperator>`
        `<ebiz:FieldValue>`Sr-0002`</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

<tr>
  <td>Name</td>
  <td>Filters by the item name.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        `<ebiz:FieldName>`Name`</ebiz:FieldName>`
        `<ebiz:ComparisonOperator>`eq`</ebiz:ComparisonOperator>`
        `<ebiz:FieldValue>`Desk`</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

<tr>
  <td>SKU</td>
  <td>Filters by the item's SKU number.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        `<ebiz:FieldName>`SKU`</ebiz:FieldName>`
        `<ebiz:ComparisonOperator>`eq`</ebiz:ComparisonOperator>`
        `<ebiz:FieldValue>123</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

<tr>
  <td>UPC</td>
  <td>Filters by item's UPC number.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        `<ebiz:FieldName>`UPC`</ebiz:FieldName>`
        `<ebiz:ComparisonOperator>`eq`</ebiz:ComparisonOperator>`
        `<ebiz:FieldValue>`123`</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

<tr>
  <td>Description</td>
  <td>Filters by item's description.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        `<ebiz:FieldName>`Description`</ebiz:FieldName>`
        `<ebiz:ComparisonOperator>`eq`</ebiz:ComparisonOperator>`
        `<ebiz:FieldValue>`Sturdy desk`</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

<tr>
  <td>UnitPrice</td>
  <td>Filters by the unit price of the item.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        `<ebiz:FieldName>`UnitPrice`</ebiz:FieldName>`
        `<ebiz:ComparisonOperator>`eq`</ebiz:ComparisonOperator>`
        `<ebiz:FieldValue>`10.0000`</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

<tr>
  <td>Unit Cost</td>
  <td>Filters by the unit cost of the item.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        `<ebiz:FieldName>`UnitPrice`</ebiz:FieldName>`
        `<ebiz:ComparisonOperator>`eq`</ebiz:ComparisonOperator>`
        `<ebiz:FieldValue>`12.0000`</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

<tr>
  <td>UnitOfMeasure</td>
  <td>Filters by the item's unit of measure.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        `<ebiz:FieldName>`UnitOfMeasure`</ebiz:FieldName>`
        `<ebiz:ComparisonOperator>`eq`</ebiz:ComparisonOperator>`
        `<ebiz:FieldValue>`m`</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

<tr>
  <td>Active</td>
  <td>Filters and displays when the active status is true and then false.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        `<ebiz:FieldName>`Active`</ebiz:FieldName>`
        `<ebiz:ComparisonOperator>`eq`</ebiz:ComparisonOperator>`
        `<ebiz:FieldValue>true</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

<tr>
  <td>ItemType</td>
  <td>Filters by type of the item.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        `<ebiz:FieldName>`ItemType`</ebiz:FieldName>`
        `<ebiz:ComparisonOperator>`eq`</ebiz:ComparisonOperator>`
        `<ebiz:FieldValue>`hard`</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

<tr>
  <td>QtyOnHand</td>
  <td>Filters items based on the quantity currently available in stock.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        `<ebiz:FieldName>`QtyOnHand`</ebiz:FieldName>`
        `<ebiz:ComparisonOperator>`eq`</ebiz:ComparisonOperator>`
        `<ebiz:FieldValue>`1000.0000`</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

<tr>
  <td>Taxable</td>
  <td>Filters by the taxable items first and then the ones that are not.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        `<ebiz:FieldName>`Taxable`</ebiz:FieldName>`
        `<ebiz:ComparisonOperator>`eq`</ebiz:ComparisonOperator>`
        `<ebiz:FieldValue>`true`</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

<tr>
  <td>TaxRate</td>
  <td>Filters by the tax rate of the item.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        `<ebiz:FieldName>`TaxRate`</ebiz:FieldName>`
        `<ebiz:ComparisonOperator>`Eq`</ebiz:ComparisonOperator>`
        `<ebiz:FieldValue>`10.0000`</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

<tr>
  <td>SoftwareId</td>
  <td>Filters by software ID of the item.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        `<ebiz:FieldName>`SoftwareId`</ebiz:FieldName>`
        `<ebiz:ComparisonOperator>`eq`</ebiz:ComparisonOperator>`
        `<ebiz:FieldValue>`AX`</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

<tr>
  <td>ItemCategoryId</td>
  <td>Filters by item's category code.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        `<ebiz:FieldName>`ItemCategoryId`</ebiz:FieldName>`
        `<ebiz:ComparisonOperator>`eq`</ebiz:ComparisonOperator>`
        `<ebiz:FieldValue>`123`</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

<tr>
  <td>ItemNotes</td>
  <td>Filters by item's notes.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        `<ebiz:FieldName>`ItemNotes`</ebiz:FieldName>`
        `<ebiz:ComparisonOperator>`eq`</ebiz:ComparisonOperator>`
        `<ebiz:FieldValue>`?`</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

<tr>
  <td>DateTimeCreated</td>
  <td>Filters by the date and time the item was created in the EBizCharge platform.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        `<ebiz:FieldName>`DateTimeCreated`</ebiz:FieldName>`
        `<ebiz:ComparisonOperator>`eq`</ebiz:ComparisonOperator>`
        `<ebiz:FieldValue>`2025-10-15T23:13:12`</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

<tr>
  <td>DateTimeModified</td>
  <td>Filters by the data and time the item was modified in the EBizCharge platform.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        `<ebiz:FieldName>`DateTimeCreated`</ebiz:FieldName>`
        `<ebiz:ComparisonOperator>`eq`</ebiz:ComparisonOperator>`
        `<ebiz:FieldValue>`2025-10-15T23:13:12`</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

<tr>
  <td>ItemUniqueId</td>
  <td>Filters by unique Item ID.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        `<ebiz:FieldName>`ItemUniqueId`</ebiz:FieldName>`
        `<ebiz:ComparisonOperator>`eq`</ebiz:ComparisonOperator>`
        `<ebiz:FieldValue>`123`</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

<tr>
  <td>ImageUrl</td>
  <td>Filters by item's image url.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        `<ebiz:FieldName>`ImageUrl`</ebiz:FieldName>`
        `<ebiz:ComparisonOperator>`eq`</ebiz:ComparisonOperator>`
        `<ebiz:FieldValue>`[www.test.com](http://www.test.com)`</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

<tr>
  <td>TaxCategoryID</td>
  <td>Filters by item's tax category ID</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        `<ebiz:FieldName>`TaxCategoryID`</ebiz:FieldName>`
        `<ebiz:ComparisonOperator>`eq`</ebiz:ComparisonOperator>`
        `<ebiz:FieldValue>`123`</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

<tr>
  <td>ItemLastSyncDateTime</td>
  <td>Filters by latest date and time the item was last synced into the EBizCharge Platform.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        `<ebiz:FieldName>`ItemLastSyncDateTime`</ebiz:FieldName>`
        `<ebiz:ComparisonOperator>`eq`</ebiz:ComparisonOperator>`
        `<ebiz:FieldValue>`2025-10-15T23:13:12`</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

<tr>
  <td>DivisionId</td>
  <td>Filters by item's division ID.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        `<ebiz:FieldName>`DivisionId`</ebiz:FieldName>`
        `<ebiz:ComparisonOperator>`eq`</ebiz:ComparisonOperator>`
        `<ebiz:FieldValue>`123`</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

<tr>
  <td>LocationID</td>
  <td>Filters by item's location ID.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        `<ebiz:FieldName>`LocationID`</ebiz:FieldName>`
        `<ebiz:ComparisonOperator>`eq`</ebiz:ComparisonOperator>`
        `<ebiz:FieldValue>`123`</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

Example Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ebiz="http://eBizCharge.ServiceModel.SOAP">
   <soapenv:Header/>
   <soapenv:Body>
      <ebiz:SearchItems>
         <ebiz:securityToken>
            <ebiz:SecurityId>********-55ee-434c-b126-************</ebiz:SecurityId>
            <ebiz:UserId/>
            <ebiz:Password/>
         </ebiz:securityToken>
         <ebiz:itemInternalId/>
         <ebiz:itemId/>
         <ebiz:filters>
            <!--Zero or more repetitions:-->
            <ebiz:SearchFilter>
               <ebiz:FieldName/>
               <ebiz:ComparisonOperator/>
               <ebiz:FieldValue/>
            </ebiz:SearchFilter>
         </ebiz:filters>
         <ebiz:start>0</ebiz:start>
         <ebiz:limit>2</ebiz:limit>
         <ebiz:sort/>
      </ebiz:SearchItems>
   </soapenv:Body>
</soapenv:Envelope>

private static void SearchItems()
   {
       IeBizService apiClient = new IeBizServiceClient();
       SecurityToken securityToken = new SecurityToken
       {
           SecurityId = "*******-c870-41b8-aa5c-********", // Replace with your actual token
           UserId = "",
           Password = ""
       };
       string itemInternalId = "";
       string itemId = "PCI Compliance Fee 95";
       //Build search filters (each SearchFilter = field + operator + value)
       //You can specify one or more filters as needed
       SearchFilter[] filters = new SearchFilter[2];
       //Example 1: Find all ItemType with FieldValue equal to a value
       filters[0] = new SearchFilter();
       filters[0].FieldName = "ItemType";
       filters[0].ComparisonOperator = "eq";  // equals
       filters[0].FieldValue = "Inventory";
       // Example 2: Find all ItemType with FieldValue equal to "Service"
       filters[1] = new SearchFilter();
       filters[1].FieldName = "ItemType";
       filters[1].ComparisonOperator = "eq";  // equals
       filters[1].FieldValue = "Service";
       //Define pagination and sorting
       int start = 0;      // Start index (0 = first record)
       int limit = 10;     // Maximum number of records to return
       string sort = "true"; // Sort results by field (optional)
       //Call SearchSalesRep API
       ItemDetails[] itemList = apiClient.SearchItems(
                   securityToken,
                   itemInternalId,
                   itemId,
                   filters,
                   start,
                   limit,
                   sort
       );
       //Display results
       foreach (var item in itemList)
       {
           Console.WriteLine($"ItemInternalId:       {item.ItemInternalId}");
           Console.WriteLine($"ItemId:               {item.ItemId}");
           Console.WriteLine($"ItemName:             {item.Name}");
           Console.WriteLine($"ItemDescription:      {item.Description}");
           Console.WriteLine($"UnitPrice:            {item.UnitPrice}");
           Console.WriteLine($"QtyOnHand:            {item.QtyOnHand}");
           Console.WriteLine($"IsActive:             {item.Active}");
           Console.WriteLine($"ItemType:             {item.ItemType}");
           Console.WriteLine($"Taxable:              {item.Taxable}");
           Console.WriteLine($"TaxRate:              {item.TaxRate}");
           Console.WriteLine($"DateTimeCreated:      {item.DateTimeCreated}");
           Console.ReadLine();
       }
   }

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">
      <SearchItemsResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
         <SearchItemsResult>
            <ItemDetails>
               <ItemInternalId>********-55ee-434c-b126-************</ItemInternalId>
               <ItemId>test2</ItemId>
               <Name>Microwave</Name>
               <SKU>123</SKU>
               <UPC>123</UPC>
               <Description/>
               <UnitPrice>100.0000</UnitPrice>
               <UnitCost>80.0000</UnitCost>
               <UnitOfMeasure/>
               <Active>true</Active>
               <ItemType/>
               <QtyOnHand>4.0000</QtyOnHand>
               <Taxable>true</Taxable>
               <TaxRate>10.0000</TaxRate>
               <SoftwareId/>
               <ItemCategoryId/>
               <ItemNotes/>
               <DateTimeCreated>2025-10-16T15:06:32</DateTimeCreated>
               <DateTimeModified/>
               <ItemUniqueId/>
               <ImageUrl/>
               <TaxCategoryID/>
               <ItemCustomFields/>
               <ItemLastSyncDateTime>2025-10-16T15:06:32</ItemLastSyncDateTime>
               <DivisionId/>
               <LocationId/>
            </ItemDetails>
         </SearchItemsResult>
      </SearchItemsResponse>
   </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">
      <SearchItemsResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
         <SearchItemsResult/>
      </SearchItemsResponse>
   </s:Body>
</s:Envelope>