SearchItems

Description

This method is used to search the items database.

Syntax

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

Arguments

Type	Name	Description
SecurityToken	securityToken	Merchant security token: used to identify merchant and validate transaction. (required)
string	itemInternalId	Unique item ID assigned by the system. (required)
string	itemId	Item ID. (required)
SearchFilter	filters	To filter returned results. (required)
int	start	Start position, defaults to 0 (first item found). (required)
int	limit	Maximum number of items to return in result. (required)
string	sort	Field name to sort the results by. (optional)

Return Value


ItemDetails []	Returns array of item objects for the matched items.

Examples

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>********-90b4-4a38-ad78-28a795af78e9</ebiz:SecurityId>
            <ebiz:UserId/>
            <ebiz:Password/>
         </ebiz:securityToken>
         <ebiz:itemInternalId/>
         <ebiz:itemId/>
         <ebiz:filters>
            <!--Zero or more repetitions:-->
            <ebiz:SearchFilter>
               <ebiz:FieldName>ItemType</ebiz:FieldName>
               <ebiz:ComparisonOperator>equal</ebiz:ComparisonOperator>
               <ebiz:FieldValue>Service</ebiz:FieldValue>
            </ebiz:SearchFilter>
         </ebiz:filters>
         <ebiz:start>0</ebiz:start>
         <ebiz:limit>300</ebiz:limit>
         <ebiz:sort/>
      </ebiz:SearchItems>
   </soapenv:Body>
</soapenv:Envelope>


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>********-718b-4356-be5d-535d6ec4bae6</ItemInternalId>
               <ItemId>PCI Compliance Fee 95</ItemId>
               <Name>PCI Compliance Fee 95</Name>
               <SKU/>
               <UPC/>
               <Description/>
               <UnitPrice>0.0000</UnitPrice>
               <UnitCost>0.0000</UnitCost>
               <UnitOfMeasure>EA</UnitOfMeasure>
               <Active>true</Active>
               <ItemType>Service</ItemType>
               <QtyOnHand>0.0000</QtyOnHand>
               <Taxable>false</Taxable>
               <TaxRate>0.0000</TaxRate>
               <SoftwareId>QuickBooks</SoftwareId>
               <ItemCategoryId/>
               <ItemNotes/>
               <DateTimeCreated>2016-10-18T01:05:12</DateTimeCreated>
               <DateTimeModified/>
               <ItemUniqueId>80000023-1454635755</ItemUniqueId>
               <ImageUrl/>
               <TaxCategoryID/>
            </ItemDetails>
         </SearchItemsResult>
      </SearchItemsResponse>
   </s:Body>
</s:Envelope>

Updated 21 days ago