Master
The masterdata contains typical list of items which are used in a combobox or other selection controls. These items change little and are referred in the product information. E.g. a list of countries or nutrients. In the product information the masterdata is alway reffered with an id and a human readable name. If more information is needed or a list possible of possible values is required then the masterdata can be used.
Product
Set of methods to retrieve product information like Specifications (if provided), Commercial info and Logistic info
| API | Description |
|---|---|
| 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. |
| GET api/Product/Get/{id}?returnContentType={returnContentType} |
Get one product based on the given id |
| POST api/Product/Update |
Update the information in the database by sending an complete filled PS-XML. See the PS API website for more details |
| GET api/Product/SpecificationReport/{id}?languageId={languageId}&detailLevel={detailLevel} |
Get the specification PDF by a packagedproduct id |
| GET api/Product/ProductIdList?tokenSeparated={tokenSeparated} |
Get a list of id's where the login have access to |
Conversion
Set of methods which converts external (customer) information to PS identifiers. The result of the PS id's can be used in the productsearch (FilterOnPsIds) to retrieve the specific products .
| API | Description |
|---|---|
| POST api/Conversion/Match |
The match method can receive a list of psmatch elements (see XSD) with information like ean, producer number, ... We try to match this information and link it to an PS id. In the productsearch you can use these id's to get the specific products |
Relation
Set of methods which retrieves relation information as is used in the products.
| API | Description |
|---|---|
| GET api/Relation/GetBrandOwnerIds?returnContentType={returnContentType} |
Returns a list of relations which are brandowners |
| GET api/Relation/GetProducerIds?returnContentType={returnContentType} |
Returns a list of relations which are producers |
| GET api/Relation/GetSuppliers?returnContentType={returnContentType} |
Returns a list of products with their supplier information. Suppliers are added only to a product when they are different to the producer. Only products with a supplier will be shown in this export. |
Brand
Information about brands and the brandowners.
| API | Description |
|---|---|
| GET api/Brand/All?returnContentType={returnContentType} |
A list of brands and brandowners where you have access to, based on your API account. You can see all public brands and non-public brands where the brandowner is equal to your API account. |
| GET api/Brand/MyBrands |
A List of your brands This includes brands you are brandowner of, aswell as brands included in your products which are not your own. |
| POST api/Brand/Update |
No documentation available. |
Group
Product can be grouped together in productgroeps. PS in foodservice has a default productgroup (PublicGroups), but some relation have there own productgroup (PrivateGroups). Depending on the PS-API account these private groups can be accessed
| API | Description |
|---|---|
| GET api/Group/PublicGroupSets?returnContentType={returnContentType} |
List of available public productgroep sets. At the moment there is 1 available |