Search Products
Request Parameters:
Retrieve the list of search product.
URL : ../Api/Client/SearchProduct
Header:
Content-Type:application/json
Required Parameters :
Case-1. Exception parameters :
Parameter:
{
"ApiSecretKey":"i99b98d117m116a112o98k115c111",
"CustomerGUID":"496DBB2A-F9EB-4522-A804-B108693B69CE",
"StoreId": "1",
"LanguageId": "",
"CurrencyId": "",
"SearchListResponse":
{
"Q":""
},
"CatalogPagingResponse":
{
"PageSize": "8",
"PageNumber": "1",
"OrderBy": "0"
}
}
Response :
{
"Status": 0,
"Message": "Request cannot be empty",
"Data": null,
"ValidationMessage": [],
"ErrorMessage": null
}
Case-2. Incorrect Parameters :
Parameter:
{
"ApiSecretKey":"i99b98d117m116a112o98k115c111",
"CustomerGUID":"496DBB2A-F9EB-4522-A804-B108693B69CE",
"StoreId": "1",
"LanguageId": "1",
"CurrencyId": "1",
"SearchListResponse":
{
"Q":"ab"
},
"CatalogPagingResponse":
{
"PageSize": "8",
"PageNumber": "1",
"OrderBy": "0"
}
}
Response :
{
"Status": 1,
"Message": "Success.",
"Data": {
"Warning": "Search term minimum length is 3 characters",
"NoResults": false,
"Q": "ab",
"Products": []
},
"ValidationMessage": [],
"ErrorMessage": null
}
Case-3. Success Response :
Parameter:
{
"ApiSecretKey":"i99b98d117m116a112o98k115c111",
"CustomerGUID":"496DBB2A-F9EB-4522-A804-B108693B69CE",
"StoreId": "1",
"LanguageId": "1",
"CurrencyId": "1",
"SearchListResponse":
{
"Q":"computer"
},
"CatalogPagingResponse":
{
"PageSize": "8",
"PageNumber": "1",
"OrderBy": "0"
}
}
Response :
{
"Status": 1,
"Message": "Success.",
"Data": {
"Warning": null,
"NoResults": false,
"Q": "computer",
"PagingFilteringContext": {
"AllowProductSorting": true,
"AvailableSortOptions": [
{
"Disabled": false,
"Group": null,
"Selected": true,
"Text": "Position",
"Value": "0"
},
{
"Disabled": false,
"Group": null,
"Selected": false,
"Text": "Name: A to Z",
"Value": "5"
},
{
"Disabled": false,
"Group": null,
"Selected": false,
"Text": "Name: Z to A",
"Value": "6"
},
{
"Disabled": false,
"Group": null,
"Selected": false,
"Text": "Price: Low to High",
"Value": "10"
},
{
"Disabled": false,
"Group": null,
"Selected": false,
"Text": "Price: High to Low",
"Value": "11"
},
{
"Disabled": false,
"Group": null,
"Selected": false,
"Text": "Created on",
"Value": "15"
}
],
"AllowProductViewModeChanging": false,
"AvailableViewModes": null,
"AllowCustomersToSelectPageSize": false,
"PageSizeOptions": null,
"OrderBy": 0,
"ViewMode": null,
"FirstItem": 1,
"HasNextPage": false,
"HasPreviousPage": false,
"LastItem": 1,
"PageIndex": 0,
"PageNumber": 1,
"PageSize": 8,
"TotalItems": 1,
"TotalPages": 1
},
"Products": [
{
"Id": 1,
"ProductType": "SimpleProduct",
"Name": "Build your own computer",
"ShortDescription": "Build it",
"FullDescription": "<p>Fight back against cluttered workspaces with the stylish IBM zBC12 All-in-One desktop PC, featuring powerful computing resources and a stunning 20.1-inch widescreen display with stunning XBRITE-HiColor LCD technology. The black IBM zBC12 has a built-in microphone and MOTION EYE camera with face-tracking technology that allows for easy communication with friends and family. And it has a built-in DVD burner and Sony's Movie Store software so you can create a digital entertainment library for personal viewing at your convenience. Easy to setup and even easier to use, this JS-series All-in-One includes an elegantly designed keyboard and a USB mouse.</p>",
"SeName": "build-your-own-computer",
"ProductPrice": {
"OldPrice": null,
"Price": "$1,200.00",
"DisableBuyButton": false,
"DisableWishlistButton": false,
"AvailableForPreOrder": false,
"PreOrderAvailabilityStartDateTimeUtc": null,
"IsRental": false,
"ForceRedirectionAfterAddingToCart": false,
"DisplayTaxShippingInfo": false,
"CustomProperties": {}
},
"DefaultPictureModel": {
"ImageUrl": "https://localhost:44369/images/thumbs/0000020_build-your-own-computer_415.jpeg",
"ThumbImageUrl": "https://localhost:44369/images/thumbs/0000020_build-your-own-computer_100.jpeg",
"FullSizeImageUrl": "https://localhost:44369/images/thumbs/0000020_build-your-own-computer.jpeg",
"Title": "Show details for Build your own computer",
"AlternateText": "Picture of Build your own computer",
"CustomProperties": {}
},
"ReviewOverviewModel": {
"ProductId": 1,
"RatingSum": 12,
"TotalReviews": 3,
"AllowCustomerReviews": true,
"CanAddNewReview": false,
"CustomProperties": {}
},
"CustomerGuid": "beacd49b-ae96-4ca5-b54b-55f0f9386282",
"Message": null
}
]
},
"ValidationMessage": [],
"ErrorMessage": null
}