SearchProductsInCategory

This method can be used to find products within a list of specific categories. It is also possible to define whether all subcategories should be searched or only the one specified. It can also be stated whether the specified category is an affilinet® category. The data available within the context of this offer include the fields "Price" and "DisplayPrice". To display the price on the screen, use only the "DisplayPrice" field because this is the type of display requested by the program operator for his product(s). The partner is solely liable for correctly displaying the price(s) on his website. The same is also true for the Shipping Price.

To access live data, please use this WSDL file:
https://api.affili.net/V2.0/ProductServices.svc?wsdl
To access demo data, please use this WSDL file:
https://developer-api.affili.net/V2.0/ProductServices.svc?wsdl

Web service description

Test data document

Operation test

With this form, you can try out this web service. We already filled it out with a sample request which will return data. Feel free to fill in different parameter values - our test data reference gives you an overview of our sample data.

Field	Type	Values
PublisherId *	int
ShopId	int
CategoryId *	int
IncludeChildNodes	bool
UseAffilinetCategories *	bool
Query *	string
WithImageOnly *	bool
Details *	bool
ImageSize *	enum
CurrentPage *	int
PageSize *	int
MinimumPrice	decimal
MaximumPrice	decimal
SortBy	enum
SortOrder *	enum

XML response

Short paramter definitions

PublisherId (int):: Id of the publisher whose account is being used.
ShopId (int):: Id of the shop whose category has been specified in ‘CategoryId’.
CategoryId (int):: Id of the category to be searched.
IncludeChildNodes (bool):: If this is set to 'true', then the search is also performed on the child nodes of the given category.
UseAffilinetCategories (bool):: States whether the specified category is an affilinet® category.
Query (string):: List of search terms.
WithImageOnly (bool):: States whether only results with product images should be displayed.
Details (bool):: States whether the detailed view of product results is required.
ImageSize (enum):: The 'ImageSize' parameter can be used to select which images (product image and shop logo) should be included in the results. The number behind “Image” resp. “Logo” represents the width in pixels. Possible values are:no image, Product image: Image30 & Logo: Logo50, Product image: Image60 & Logo: Logo90, Product image: Image90 & Logo: Logo120, Product image: Image120 & Logo: Logo150, Product image: Image180 & Logo: Logo468, All images
CurrentPage (int):: States which page should be displayed.
PageSize (int):: States the size of a result page.
MinimumPrice (decimal):: Minimum price in the search results.
MaximumPrice (decimal):: Maximum price in the search results.
SortBy (enum):: States by which field the results should be ordered. If omitted, results are sorted by rank. Possible values are: Price, Title, Rank
SortOrder (enum):: States the required order direction of the results. Possible values are: unsorted, ascending, descending, random

Complete code examples

<?php

/* <LIVE DATA> 
define ("WSDL_LOGON", "https://api.affili.net/V2.0/Logon.svc?wsdl");
define ("WSDL_PROD",  "https://api.affili.net/V2.0/ProductServices.svc?wsdl");

$Username   = ''; // your publisher ID
$Password   = ''; // your product data web services password

$SOAP_LOGON = new SoapClient(WSDL_LOGON);
$Token      = $SOAP_LOGON->Logon(array(
             'Username'  => $Username,
             'Password'  => $Password,
             'WebServiceType' => 'Product'
             ));
$params = array(
          'ShopId' => '200',
          'CategoryId' => '30783873',
          'IncludeChildNodes' => true,
          'UseAffilinetCategories' => false,
          'Query' => 'schwarm',
          'WithImageOnly' => false,
          'Details' => true,
          'ImageSize' => NoImage,
          'CurrentPage' => '1',
          'PageSize' => '10',
          'MinimumPrice' => '0',
          'MaximumPrice' => '99999',
          'SortBy' => 'Rank',
          'SortOrder' => 'Descending'
          );
</LIVE DATA> */

/* <DEMO DATA> */
define ("WSDL_LOGON", "https://developer-api.affili.net/V2.0/Logon.svc?wsdl");
define ("WSDL_PROD",  "https://developer-api.affili.net/V2.0/ProductServices.svc?wsdl");

$Username   = '';     // your developer ID
$Password   = '';     // your developer portal password
$DemoPublisherId   = 403233;  // one of the publisher IDs of our demo database
$DeveloperSettings = array('SandboxPublisherID' => $DemoPublisherId);

$SOAP_LOGON = new SoapClient(WSDL_LOGON);
$Token      = $SOAP_LOGON->Logon(array(
                     'Username'  => $Username,
                     'Password'  => $Password,
                     'WebServiceType' => 'Product',
                     'DeveloperSettings' => $DeveloperSettings
                     ));

$params = array(
          'ShopId' => '0',
          'CategoryId' => '14',
          'IncludeChildNodes' => true,
          'UseAffilinetCategories' => true,
          'Query' => 'jeans',
          'WithImageOnly' => false,
          'Details' => true,
          'ImageSize' => NoImage,
          'CurrentPage' => '1',
          'PageSize' => '10',
          'MinimumPrice' => '0',
          'MaximumPrice' => '99999',
          'SortBy' => 'Rank',
          'SortOrder' => 'Descending'
          );
 /*</DEMO DATA> */		  

$SOAP_REQUEST = new SoapClient(WSDL_PROD);
$req = $SOAP_REQUEST->SearchProductsInCategory(array(
            'CredentialToken' => $Token,
            'SearchProductsInCategoryRequestMessage' => $params
            ));

print_r($req);

?>

protected void LoadWebService()
{            
    // first create the Web References
    // LIVE DATA
    // using Affilinet.LogonWebservice; ("https://api.affili.net/V2.0/Logon.svc?wsdl")
    // using Affilinet.ProductWebservice; ("https://api.affili.net/V2.0/ProductServices.svc?wsdl")    

    // or DEMO DATA
    // using Affilinet.LogonWebservice; ("https://developer-api.affili.net/V2.0/Logon.svc?wsdl")
    // using Affilinet.PublisherProgramWebservice; ("https://developer-api.affili.net/V2.0/ProductServices.svc?wsdl")    

    #region Parameters for the authentification token
    // Insert the publisher ID for access the live data or insert your DeveloperId for access the demo data 
    string Username   = "";
    // Insert the publisher web services password for access the live data or insert your developer portal password for access the demo data 
    string Password   = "";
    // only required for access the demo data. Insert one of the publisher IDs of our demo database. e.g.: 403233
    int SandboxPublisherID = 0;
    #endregion

    string myToken = GetAuthentificationToken(Username, Password, SandboxPublisherID, WebServiceTypes.Product);
    
    // insert the parameters to get the products
    int[] shopIds = { 228 };
    int categoryId = 29611709;
    string query = "house";
    ProductSearchResult myProducts = SearchProductsInCategory(myToken, shopIds, categoryId, false, false, query, false, false, ImageSize.NoImage, 1, 10, 1, 999, SortBy.Rank, SortOrder.Descending);
}

public static string GetAuthentificationToken(string username, string password, int sandboxPublisherID, WebServiceTypes WSType)
{
    Logon logonRequest = new Logon();
    logonRequest.Username = username;
    logonRequest.Password = password;
    logonRequest.WebServiceType = WSType;
    
    // *** only required for sandbox requests *** 
    // logonRequest.DeveloperSettings = new TokenDeveloperDetails();
    // logonRequest.DeveloperSettings.SandboxPublisherID = sandboxPublisherID;
    // logonRequest.DeveloperSettings.SandboxPublisherIDSpecified = true;             

    Authentication logonService = new Authentication();
    return logonService.Logon(logonRequest);
}

public static ProductSearchResult SearchProductsInCategory(string token, int[] shopIDs, int category, bool includeChildNodes, bool useAffilinetCategories, string query,bool withImageOnly, bool details,ImageSize imageSize, int currentPage, int pageSize, decimal minimumPrice, decimal maximumPrice, SortBy sortBy, SortOrder sortOrder)
        {
            ProductServices prodService = new ProductServices();
            SearchProductsInCategoryRequestMessage spicrmess = new SearchProductsInCategoryRequestMessage();    
            spicrmess.CategoryId = category;
            spicrmess.ShopIds = shopIDs;
            spicrmess.IncludeChildNodes = includeChildNodes;
            spicrmess.UseAffilinetCategories  = useAffilinetCategories;
            spicrmess.Query = query;
            spicrmess.WithImageOnly = withImageOnly;
            spicrmess.Details  = details;
            spicrmess.ImageSize  =imageSize;
            spicrmess.CurrentPage = currentPage;
            spicrmess.PageSize = pageSize;
            spicrmess.MinimumPrice= minimumPrice;
            spicrmess.MaximumPrice = maximumPrice;
            spicrmess.SortBy = sortBy;
            spicrmess.SortOrder = sortOrder;
            return prodService.SearchProductsInCategory(token, spicrmess);
        }

SearchProductsInCategory

SearchProductsInCategory

Web service description

Test data document

More questions?

Operation test

XML response

Complete code examples

PHP

.NET