GET product/search?customerNumber={customerNumber}&itemNumber={itemNumber}&partNumberType={partNumberType}&manufacturer={manufacturer}&catalogName={catalogName}&categoryPath={categoryPath}&includeObsolete={includeObsolete}&searchText={searchText}&useAndOperator={useAndOperator}&region={region}&page={page}&pageSize={pageSize}

Product search allows for search for products by item number, manufacturer, general search text against descriptions

Request Information

URI Parameters

Name	Description	Type	Additional information
customerNumber	Your customer #	string	Required
itemNumber	Optional item number	string	None.
partNumberType	Part number type Unknown = 0, ScanSource = 1, Manufacturer = 2, Material = 3	PartNumberType	Default value is Unknown
manufacturer	Optional manufacturer name	string	None.
catalogName	Optional catalog name	string	None.
categoryPath	Optional category path	string	None.
includeObsolete	Flag indicating if results should include obsolete items	boolean	Default value is False
searchText	General search against item #s, descriptions	string	None.
useAndOperator	Flag indicating if search should use OR / AND operator	boolean	Default value is False
region	0-NA, 1-EU	RegionType	Default value is NA
page	Page #	integer	Default value is 1
pageSize	Results page size - max 100	integer	Default value is 25

Body Parameters

None.

Response Information

Resource Description

Collection of ProductSearchResultModel

Name	Type	Additional information
ScanSourceItemNumber	string	None.
ManufacturerItemNumber	string	None.
Manufacturer	string	None.
ItemStatus	string	None.
PlantMaterialStatusValidfrom	date	None.
ItemImage	string	None.
ReboxItem	boolean	None.
BStockItem	boolean	None.
CatalogName	string	None.
BusinessUnit	string	None.
CategoryPath	string	None.
ProductFamilyImage	string	None.
ProductFamilyDescription	string	None.
ProductFamilyHeadline	string	None.
Description	string	None.
ProductFamily	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ScanSourceItemNumber": "sample string 1",
    "ManufacturerItemNumber": "sample string 2",
    "Manufacturer": "sample string 3",
    "ItemStatus": "sample string 4",
    "PlantMaterialStatusValidfrom": "2021-05-08T06:34:49.5196706-04:00",
    "ItemImage": "sample string 6",
    "ReboxItem": true,
    "BStockItem": true,
    "CatalogName": "sample string 9",
    "BusinessUnit": "sample string 10",
    "CategoryPath": "sample string 11",
    "ProductFamilyImage": "sample string 12",
    "ProductFamilyDescription": "sample string 13",
    "ProductFamilyHeadline": "sample string 14",
    "Description": "sample string 15",
    "ProductFamily": "sample string 16"
  },
  {
    "ScanSourceItemNumber": "sample string 1",
    "ManufacturerItemNumber": "sample string 2",
    "Manufacturer": "sample string 3",
    "ItemStatus": "sample string 4",
    "PlantMaterialStatusValidfrom": "2021-05-08T06:34:49.5196706-04:00",
    "ItemImage": "sample string 6",
    "ReboxItem": true,
    "BStockItem": true,
    "CatalogName": "sample string 9",
    "BusinessUnit": "sample string 10",
    "CategoryPath": "sample string 11",
    "ProductFamilyImage": "sample string 12",
    "ProductFamilyDescription": "sample string 13",
    "ProductFamilyHeadline": "sample string 14",
    "Description": "sample string 15",
    "ProductFamily": "sample string 16"
  }
]

application/xml, text/xml

Sample:

<ArrayOfProductSearchResultModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ProductSearchResultModel>
    <ScanSourceItemNumber>sample string 1</ScanSourceItemNumber>
    <ManufacturerItemNumber>sample string 2</ManufacturerItemNumber>
    <Manufacturer>sample string 3</Manufacturer>
    <ItemStatus>sample string 4</ItemStatus>
    <PlantMaterialStatusValidfrom>2021-05-08T06:34:49.5196706-04:00</PlantMaterialStatusValidfrom>
    <ItemImage>sample string 6</ItemImage>
    <ReboxItem>true</ReboxItem>
    <BStockItem>true</BStockItem>
    <CatalogName>sample string 9</CatalogName>
    <BusinessUnit>sample string 10</BusinessUnit>
    <CategoryPath>sample string 11</CategoryPath>
    <ProductFamilyImage>sample string 12</ProductFamilyImage>
    <ProductFamilyDescription>sample string 13</ProductFamilyDescription>
    <ProductFamilyHeadline>sample string 14</ProductFamilyHeadline>
    <Description>sample string 15</Description>
    <ProductFamily>sample string 16</ProductFamily>
  </ProductSearchResultModel>
  <ProductSearchResultModel>
    <ScanSourceItemNumber>sample string 1</ScanSourceItemNumber>
    <ManufacturerItemNumber>sample string 2</ManufacturerItemNumber>
    <Manufacturer>sample string 3</Manufacturer>
    <ItemStatus>sample string 4</ItemStatus>
    <PlantMaterialStatusValidfrom>2021-05-08T06:34:49.5196706-04:00</PlantMaterialStatusValidfrom>
    <ItemImage>sample string 6</ItemImage>
    <ReboxItem>true</ReboxItem>
    <BStockItem>true</BStockItem>
    <CatalogName>sample string 9</CatalogName>
    <BusinessUnit>sample string 10</BusinessUnit>
    <CategoryPath>sample string 11</CategoryPath>
    <ProductFamilyImage>sample string 12</ProductFamilyImage>
    <ProductFamilyDescription>sample string 13</ProductFamilyDescription>
    <ProductFamilyHeadline>sample string 14</ProductFamilyHeadline>
    <Description>sample string 15</Description>
    <ProductFamily>sample string 16</ProductFamily>
  </ProductSearchResultModel>
</ArrayOfProductSearchResultModel>