POST api/Product/Search

Get a list of products based on certian filter conditions. To receive data, at least one set must be selected (multiple set are possible) E.g. "ShowPublicProductSet", "ShowMyProducedProductSet", "ShowMyBrandsProductSet" or "ShowMyCatalogProductSet". The filters are executed on the selected set and some combinations of filters will result in an empty data set. There is a limit of 50 fully specified products at once. With Skip, Take (default 10) and the total row count in the header of the response XML it is possible to get all data in multiple steps If the summaryOnly parameter is set to true then there is no limit and only a small subset of the information is returned.

Request Information

URI Parameters

None.

Body Parameters

ProductSearchInputParameters

Name	Description	Type	Additional information
ShowPublicProductSet	Enables searching within all publicly visible products	boolean	None.
ShowMyProducedProductSet	Enables searching within all products where the API account is producer	boolean	None.
ShowMyBrandsProductSet	Enables searching within all products where API account is brand owner	boolean	None.
ShowMyCatalogProductSet	Enables searching within all products in the API account catalog	boolean	None.
ShowNevoProductSet	Enable this set for retrieving NEVO products. This set cannot be combined with other sets	boolean	None.
ShowAllProductSet	Enables searching within all products in the following sets: Public, Produced, Brand, Catalog	boolean	None.
ShowSubscribedProductSet	Enables searching within all product where API account has special authorization	boolean	None.
FilterOnTargetmarketIds	Filter on one or more targetmarket ids. This is a ; separated list. Default value is 1 (which is NL)	string	None.
IncludeAllTargetmarkets	Include all targetmarkets in the searchresult	boolean	None.
FilterOnPsIds	Searches for products where psid is in the ';' seperated list.Usefull for collecting multiple specific products at once	string	None.
SummaryOnly	Enable this will remove the take restriction and return only the summary of a product.	boolean	None.
IdOnly	Enable this will remove the take (50) restriction and returns only the PSIDs ; separated. The other filters still remain active	boolean	None.
LastModifiedAfter	Get only products that are changed after this data. Expected dateformats: YYYY-MM-DD or MM-DD-YYYY.	date	None.
FilterOnFreeText	Search in the name of the product	string	None.
FilterOnEan	Search for products where EAN number is given value within requested sets	integer	None.
FilterOnGTINs	Searches for products where the gtins are in a ';' seperated list.Usefull for collecting multiple specific products at once	string	None.
FilterOnProducerId	Searches for products where producer Id is given value within requested sets	integer	None.
FilterOnProducerGLN	Searches for products where producer GLN is given value within requested sets	string	None.
FilterOnBrandId	Searches for products where brand id is given value within requested sets	integer	None.
FilterOnBrandOwnerId	Searches for products where brand owner id is given value within requested sets	integer	None.
FilterOnBrandOwnerGLN	Searches for products where brand owner GLN is given value within requested sets	string	None.
FilterOnGroupId	Searches for products where ps productgroup id is given value within requested sets	integer	None.
FilterOnPrivateGroupId	Searches for products where private productgroup id is given value within requested sets	integer	None.
FilterOnPrivateLabelOnly	Searches for products that are private label within requested sets	boolean	None.
FilterOnVisibility	Filter on viibility	ProductVisibility	None.
FilterOnGrosseryId	Filter on the Id of a grossery (groothandel). This parameter is used in combination with the grosserynumber. For matching multiple values at once, please use the conversion/match method	integer	None.
FilterOnGrosseryGLN	Filter on the Gln of a grossery (groothandel). This parameter is used in combination with the grosserynumber.	string	None.
FilterOnGrosseryNumber	Number of the product as is known by the grossery. For matching multiple values at once, please use the conversion/match method	string	None.
FilterOnCatalogIds	Filter on the catalogid. Only works if you have enabled "ShowMyCatalogProductSet". Having set this will allow you to only get matches in a specific (or multple) catalogs. Leave empty to search in all catalog	string	None.
Skip	Determines how many items should be skipped (default=0).	integer	None.
Take	Detemines how many items should be taken (default=10).	integer	None.
FilterOnFoodOrNonfood	Filter on food or nonfood. Default setting will always return both. Selecting this will filter out all products that do not match. E.G.: When selecting "food" you will only get products returns that are not catagorized as nonfood. If no judgement can be made for a product, it's assumed to be a food product.	ProductFoodOrNonFood	None.
ReturnContentType	Could be Unknown or Xml	ContentType	None.

Request Formats

application/json, text/json

Sample:

{
  "ShowPublicProductSet": true,
  "ShowMyProducedProductSet": true,
  "ShowMyBrandsProductSet": true,
  "ShowMyCatalogProductSet": true,
  "ShowNevoProductSet": true,
  "ShowAllProductSet": true,
  "ShowSubscribedProductSet": true,
  "FilterOnTargetmarketIds": "sample string 8",
  "IncludeAllTargetmarkets": true,
  "FilterOnPsIds": "sample string 10",
  "SummaryOnly": true,
  "IdOnly": true,
  "LastModifiedAfter": "2024-12-27T04:15:41.0797354+01:00",
  "FilterOnFreeText": "sample string 13",
  "FilterOnEan": 1,
  "FilterOnGTINs": "sample string 14",
  "FilterOnProducerId": 1,
  "FilterOnProducerGLN": "sample string 15",
  "FilterOnBrandId": 1,
  "FilterOnBrandOwnerId": 1,
  "FilterOnBrandOwnerGLN": "sample string 16",
  "FilterOnGroupId": 1,
  "FilterOnPrivateGroupId": 1,
  "FilterOnPrivateLabelOnly": true,
  "FilterOnVisibility": 0,
  "FilterOnGrosseryId": 1,
  "FilterOnGrosseryGLN": "sample string 18",
  "FilterOnGrosseryNumber": "sample string 19",
  "FilterOnCatalogIds": "sample string 20",
  "Skip": 21,
  "Take": 22,
  "FilterOnFoodOrNonfood": 0,
  "ReturnContentType": 0
}

application/xml, text/xml

Sample:

<ProductSearchInputParameters xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PS.WebApi.Core.Data.InputParameters">
  <ReturnContentType>Unknown</ReturnContentType>
  <FilterOnBrandId>1</FilterOnBrandId>
  <FilterOnBrandOwnerGLN>sample string 16</FilterOnBrandOwnerGLN>
  <FilterOnBrandOwnerId>1</FilterOnBrandOwnerId>
  <FilterOnCatalogIds>sample string 20</FilterOnCatalogIds>
  <FilterOnEan>1</FilterOnEan>
  <FilterOnFoodOrNonfood>Undefined</FilterOnFoodOrNonfood>
  <FilterOnFreeText>sample string 13</FilterOnFreeText>
  <FilterOnGTINs>sample string 14</FilterOnGTINs>
  <FilterOnGrosseryGLN>sample string 18</FilterOnGrosseryGLN>
  <FilterOnGrosseryId>1</FilterOnGrosseryId>
  <FilterOnGrosseryNumber>sample string 19</FilterOnGrosseryNumber>
  <FilterOnGroupId>1</FilterOnGroupId>
  <FilterOnPrivateGroupId>1</FilterOnPrivateGroupId>
  <FilterOnPrivateLabelOnly>true</FilterOnPrivateLabelOnly>
  <FilterOnProducerGLN>sample string 15</FilterOnProducerGLN>
  <FilterOnProducerId>1</FilterOnProducerId>
  <FilterOnPsIds>sample string 10</FilterOnPsIds>
  <FilterOnTargetmarketIds>sample string 8</FilterOnTargetmarketIds>
  <FilterOnVisibility>PrivatelyVisible</FilterOnVisibility>
  <IdOnly>true</IdOnly>
  <IncludeAllTargetmarkets>true</IncludeAllTargetmarkets>
  <LastModifiedAfter>2024-12-27T04:15:41.0797354+01:00</LastModifiedAfter>
  <ShowAllProductSet>true</ShowAllProductSet>
  <ShowMyBrandsProductSet>true</ShowMyBrandsProductSet>
  <ShowMyCatalogProductSet>true</ShowMyCatalogProductSet>
  <ShowMyProducedProductSet>true</ShowMyProducedProductSet>
  <ShowNevoProductSet>true</ShowNevoProductSet>
  <ShowPublicProductSet>true</ShowPublicProductSet>
  <ShowSubscribedProductSet>true</ShowSubscribedProductSet>
  <Skip>21</Skip>
  <SummaryOnly>true</SummaryOnly>
  <Take>22</Take>
</ProductSearchInputParameters>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.