GetProductList

From Wiki

Jump to: navigation, search

getProductList

This ProductServe function will return the products belonging to the specified search criteria.

Parameters

Required Name Type Description Min Occurs Max Occurs
No sQuery string The search query 0 1
No iAdult int Allow adult content 0 1
No bHotPick bool Include only the merchants top products 0 1
No bIncludeTree bool Whether to also search within the descendants of the specified category 0 1
No sSort ProductListSortOption The order in which to return the product 0 1
No iOffset int From which point onwards in the list to return products from 0 1
No iLimit int The maximum number of products to return 1000 1
No oActiveRefineByGroup RefineByGroup Objects containing any active refine bys 0 Unlimited
No iLimitRefineBy int Maximum number of refine bys to return 0 1
No sMode SearchProductModeOption The mode to perform server-side searches in 0 1
No iEnabledRefineBy int The refine bys to return with our searches 0 Unlimited
No sColumnToReturn string Columns to return with each product. By default only required columns are returned. Add as many columns as you require from the Product_PSAPI data type to your API call to get more data. 0 Unlimited


Response Parameters

Required Name Type Description Min Occurs Max Occurs
N/A oProduct Product Objects of any returned product 0 Unlimited
N/A iTotalCount int Total count of products found 0 1
N/A oActiveRefineByGroup RefineByGroup Objects containing any active refine bys 0 Unlimited
N/A oRefineByGroup RefineByGroup Objects containing any remaining available refine bys 0 Unlimited