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 | Description | |
|---|---|---|---|
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. |
filters | S | Filters ItemDetails objects based on one or more field names, comparison operators, and field values. See supported search parameters below. | |
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. |
Return Value
| Type | Description |
|---|---|
| ItemDetails[] | Returns an array of ItemDetails objects matching the searched parameters. |
Supported Search/Sort Parameters
| Parameter | Description | Example of Use |
|---|---|---|
| ItemInternalId | Filters by the item's internal ID. | |
| ItemId | Fliters results by the item Id. | |
| Name | Filters by the item name. | |
| SKU | Filters by the item's SKU number. | |
| UPC | Filters by item's UPC number. | |
| Description | Filters by item's description. | |
| UnitPrice | Filters by the unit price of the item. | |
| Unit Cost | Filters by the unit cost of the item. | |
| UnitOfMeasure | Filters by the item's unit of measure. | |
| Active | Filters and displays when the active status is true and then false. | |
| ItemType | Filters by type of the item. | |
| QtyOnHand | Filters items based on the quantity currently available in stock. | |
| Taxable | Filters by the taxable items first and then the ones that are not. | |
| TaxRate | Filters by the tax rate of the item. | |
| SoftwareId | Filters by software ID of the item. | |
| ItemCategoryId | Filters by item's category code. | |
| ItemNotes | Filters by item's notes. | |
| DateTimeCreated | Filters by the date and time the item was created in the EBizCharge platform. | |
| DateTimeModified | Filters by the data and time the item was modified in the EBizCharge platform. | |
| ItemUniqueId | Filters by unique Item ID. | |
| ImageUrl | Filters by item's image url. | |
| TaxCategoryID | Filters by item's tax category ID | |
| ItemLastSyncDateTime | Filters by latest date and time the item was last synced into the EBizCharge Platform. | |
| DivisionId | Filters by item's division ID. | |
| LocationID | Filters by item's location ID. | |
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>Updated 5 months ago
