GET product/search?customerNumber={customerNumber}&itemNumber={itemNumber}&partNumberType={partNumberType}&manufacturer={manufacturer}&catalogName={catalogName}&categoryPath={categoryPath}&includeObsolete={includeObsolete}&searchText={searchText}&useAndOperator={useAndOperator}®ion={region}&page={page}&pageSize={pageSize}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
customerNumber | string |
Required |
|
itemNumber | string |
None. |
|
partNumberType | PartNumberType |
Default value is Unknown |
|
manufacturer | string |
None. |
|
catalogName | string |
None. |
|
categoryPath | string |
None. |
|
includeObsolete | boolean |
Default value is False |
|
searchText | string |
None. |
|
useAndOperator | boolean |
Default value is False |
|
region | RegionType |
Default value is NA |
|
page | integer |
Default value is 1 |
|
pageSize | integer |
Default value is 25 |
Body Parameters
None.
Response Information
Resource Description
Collection of ProductSearchResultModelName | Description | 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": "2025-07-12T04:13:55.3158077-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": "2025-07-12T04:13:55.3158077-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>2025-07-12T04:13:55.3158077-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>2025-07-12T04:13:55.3158077-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>