Search Products

Search for all products or specific deals without needing any header information. This call returns comprehensive product details.

Headers

Property	Value
Request Type	POST
Content Type	application-json
URL	{{EnvironmentURL}}/api/services/app/Products/SearchProducts

Please see Environments under Getting Started for test and production environment URLs.

Request Parameters

Property	Type	Description	Required
searchText	string	Filter products by string.
pageIndex	int	Page index of paged result.	✓
maxResultCount	int	Number of products per page.	✓
market	enum	Return products for a specific market. See Constants (Enums) for available markets.	✓
filters	Object	See below filters schema.
viewId	int	ID of the outlet store to apply. Default 0.
sortOptions	Object	See Below sortOptions Schema.
callTaken	string	Call identifier. Unique string sent and received to match calls when making multiple.

Filters

Property	Type	Description
Availability	Array Int	1 for In stock products and 0 for all products.
Brands	Array of string	Array of Brand Names.
Tags	Array of Tag Object (See below)	All the tags that should apply.
hasRichDataFilter	bool	Should be true.
skipCaching	bool	Skip the Cached Products - Default false.
useFuzzySearch	bool	Skip Fast Search - Should be false.
shouldApplyGlobalSettingsFilter	bool	Should be true.

Tag

Property	Type	Description
name	string	Name of tag to be applied.
editable	bool	Should be true.
action	int	Should be 2.
AdditionalData	Object	Should be .

sortOptions

Property	Type	Description
sortColumn	string	Should be null.
sortOrder	int	Should be 1.

Sample Request

{
    "pageIndex": 0,
    "maxResultCount": 1,
    "market": "14",
    "filters": {
        "availability": [],
        "brands": [],
        "categories": [],
        "tags": [],
        "hasRichDataFilter": true,
        "skipCaching": false,
        "useFuzzySearch": true,
        "shouldApplyGlobalSettingsFilter": true
    },
    "viewId": "0",
    "sortOptions": {
        "sortOrder": 1
    }
}

Response Parameters

Property	Type	Description
token	string	Unique identifier of call instance.
totalCount	int	Total number of products returned.
items	Array of Objects	List of products.

Items

Property	Type	Description
imageUrl	string	Link to product image.
brandInfo	Object	Object of BrandId and BrandName.
category	string	Category of the product.
availableToSell	int	Number of products in stock.
estimatedTimeOfArrival	dateTime	ETA if available.
discount	int	Discount applied.
discountPercentage	int	Percentage of discount applied.
price	decimal	Product Price.
currencyCode	string	Currency of product price.
promotions	Array of String	List of all promotions applied.
tags	Array of keyValue Pairs	List of tags applied to products returned.
productIdentifier	string	The unique product identifier.
name	string	Product name.
description	string	Description applied to product.
brand	enum	The product brand.
market	enum	Market of the brand.
itemType	enum	Return products for a specific item type. See Constants (Enums) for available item types.
additionalInfo	Dictionary of 2 strings	Key - Value pairs of additional info.
dealType	enum	Return products for a specific deal type. See Constants (Enums) for available deal types.
Billing	string	Microsoft market specific product billing information.
BillingFrequencyType	string	Microsoft market specific product billing frequency.
Term	string	Microsoft market specific product term information.
TermUnitOfMeasure	string	Microsoft market specific unit of measure (UoM).
OfferId	string	Microsoft market specific offer id (if applicable).
ParentOfferId	string	Microsoft market specific parent offer id (if applicable).

Sample Response (1 product)

{
    "result": {
        "token": null,
        "totalCount": 35014,
        "items": [
            {
                "imageUrl": "http://cdn.cs.1worldsync.com/20/f8/20f8e722-6485-46c1-a893-e9f1494cba5b.jpg",
                "brandInfo": {
                    "brandId": 3,
                    "brandName": "HPE"
                },
                "category": null,
                "availableToSell": 0,
                "estimatedTimeOfArrival": null,
                "discount": null,
                "discountPercentage": 0.0,
                "price": 16448.58,
                "currencyCode": null,
                "promotions": [
                    {
                        "promotionText": "Flex Offer",
                        "promotionColor": "#00B188"
                    }
                ],
                "tags": [
                    {
                        "key": "FO Hot Pick #2",
                        "value": "secondary"
                    }
                ],
                "isDeal": false,
                "productIdentifier": "H93P0E",
                "name": "HPE 5Y TC Bas DL320 Gen11 HW SVC",
                "description": null,
                "brand": 3,
                "market": 14,
                "itemType": 0,
                "additionalInfo": {
                    "UpliftType": "Service",
                    "ProductDescription": "HPE 5Y TC Bas DL320 Gen11 HW SVC",
                    "PurchaseOptions": "0",
                    "SellPriceCurrencyCode": "ZAR",
                    "LongDescription": "HPE Pointnext Tech Care (HPE Tech Care) is the operational support experience for HPE hardware and software products (HPE products). HPE Tech Care helps IT teams focus on moving the business forward by proactively searching for better ways to do things, as opposed to just focusing on reactive issues. HPE Tech Care goes beyond traditional support by enabling direct access to product-specific specialists and providing general technical guidance to help customers not only reduce risk but also continually search for ways to do things more efficiently. HPE Tech Care customers can get help through multiple channels that include telephone, HPE moderated forums with defined response times, automated incident logging, and a real-time chat facility. The service provides access to expert technical resources with specialized knowledge in the hardware and or software within the context of the specific workload.",
                    "IncSellPrice": "18915.87"
                },
                "vendorId": "H93P0E",
                "dealType": null
            },
        ]
    },
    "targetUrl": null,
    "success": true,
    "error": null,
    "unAuthorizedRequest": false,
    "__abp": true
}