Overview

Namespaces

  • Affilinet
    • ProductData
      • Exceptions
      • HttpClient
      • Requests
        • Helper
        • Traits
      • Responses
        • ResponseElements

Classes

  • AbstractRequest
  • CategoriesRequest
  • ProductsRequest
  • ShopPropertiesRequest
  • ShopsRequest

Interfaces

  • CategoriesRequestInterface
  • ProductsRequestInterface
  • RequestInterface
  • ShopPropertiesRequestInterface
  • ShopsRequestInterface
  • Overview
  • Namespace
  • Class

Interface ProductsRequestInterface

Interface ProductsRequestInterface

Affilinet\ProductData\Requests\ProductsRequestInterface implements Serializable, Affilinet\ProductData\Requests\RequestInterface

Direct known implementers

Affilinet\ProductData\Requests\ProductsRequest
Namespace: Affilinet\ProductData\Requests
Located at Affilinet/ProductData/Requests/ProductsRequestInterface.php
Methods summary
public Affilinet\ProductData\Responses\ResponseElements\Product
# findOne( integer $productId )

Find one Product by Id

Find one Product by Id

Parameters

$productId

Returns

Affilinet\ProductData\Responses\ResponseElements\Product
public Affilinet\ProductData\Responses\ProductsResponseInterface
# find( array $productIds )

Parameters

$productIds

Returns

Affilinet\ProductData\Responses\ProductsResponseInterface
public Affilinet\ProductData\AffilinetClient
# getAffilinetClient( )

Returns

Affilinet\ProductData\AffilinetClient
public Affilinet\ProductData\Requests\ProductsRequest
# excludeShopIds( array $shopIDs )

Exclude ShopIDs from result

Exclude ShopIDs from result

Please note the difference between ShopId and ProgramId: each program (= advertiser) has one ProgramId, but might have more than one ShopId, e.g. if the program supplies its electronics products separately from its clothing products. If one of the specified ShopIds is ‘0’, then the search is performed across all shops with which the requesting publisher has an accepted partners

Parameters

$shopIDs

Returns

Affilinet\ProductData\Requests\ProductsRequest
public Affilinet\ProductData\Requests\ProductsRequest
# onlyFromShopIds( array $shopIDs )

Parameters

$shopIDs

Returns

Affilinet\ProductData\Requests\ProductsRequest
public Affilinet\ProductData\Requests\ProductsRequest
# onlyFromCategories( array $categoryIds, boolean $excludeSubCategories = false, boolean $useAffilinetCategories = true )

Filter results to these categories only

Filter results to these categories only

Parameters

$categoryIds
$excludeSubCategories
$useAffilinetCategories
Set to false if you want to use shop internal category IDs

Returns

Affilinet\ProductData\Requests\ProductsRequest
public
# onlyFromShop( Affilinet\ProductData\Responses\ResponseElements\ShopInterface $shop )

Parameters

$shop

Returns


$this

Throws

Affilinet\ProductData\Exceptions\AffilinetProductWebserviceException
public
# onlyFromShops( array $shops )

Parameters

$shops
array

Returns


$this

Throws

Affilinet\ProductData\Exceptions\AffilinetProductWebserviceException
public
# onlyFromShopCategory( Affilinet\ProductData\Responses\ResponseElements\CategoryInterface $category )

Parameters

$category

Returns


$this
public
# onlyFromShopCategories( array $categories )

Parameters

$categories

Returns


$this
public Affilinet\ProductData\Requests\ProductsRequest
# onlyWithImage( boolean $withImageOnly = true )

Only results with an image

Only results with an image

If param $withImageOnly is set to false, all results are included

Parameters

$withImageOnly
If set to false, all results will be included

Returns

Affilinet\ProductData\Requests\ProductsRequest
public Affilinet\ProductData\Requests\ProductsRequest
# addProductImage( )

Add the product image in OriginalSize

Add the product image in OriginalSize

Returns

Affilinet\ProductData\Requests\ProductsRequest
public Affilinet\ProductData\Requests\ProductsRequest
# addProductImageWithSize30px( )

Include a product ProductImage with 30px width

Include a product ProductImage with 30px width

Returns

Affilinet\ProductData\Requests\ProductsRequest
public Affilinet\ProductData\Requests\ProductsRequest
# addProductImageWithSize60px( )

Include a product ProductImage with 60px width

Include a product ProductImage with 60px width

Returns

Affilinet\ProductData\Requests\ProductsRequest
public Affilinet\ProductData\Requests\ProductsRequest
# addProductImageWithSize90px( )

Include a product ProductImage with 90px width

Include a product ProductImage with 90px width

Returns

Affilinet\ProductData\Requests\ProductsRequest
public Affilinet\ProductData\Requests\ProductsRequest
# addProductImageWithSize120px( )

Include a product ProductImage with 120px width

Include a product ProductImage with 120px width

Returns

Affilinet\ProductData\Requests\ProductsRequest
public Affilinet\ProductData\Requests\ProductsRequest
# addProductImageWithSize180px( )

Include a product ProductImage with 180px width

Include a product ProductImage with 180px width

Returns

Affilinet\ProductData\Requests\ProductsRequest
public Affilinet\ProductData\Requests\ProductsRequest
# addShopLogoWithSize50px( )

Include the shop logo with 50px width

Include the shop logo with 50px width

Returns

Affilinet\ProductData\Requests\ProductsRequest
public Affilinet\ProductData\Requests\ProductsRequest
# addShopLogoWithSize90px( )

Include the shop logo with 90px width

Include the shop logo with 90px width

Returns

Affilinet\ProductData\Requests\ProductsRequest
public Affilinet\ProductData\Requests\ProductsRequest
# addShopLogoWithSize120px( )

Include the shop logo with 120px width

Include the shop logo with 120px width

Returns

Affilinet\ProductData\Requests\ProductsRequest
public Affilinet\ProductData\Requests\ProductsRequest
# addShopLogoWithSize150px( )

Include the shop logo with 150px width

Include the shop logo with 150px width

Returns

Affilinet\ProductData\Requests\ProductsRequest
public Affilinet\ProductData\Requests\ProductsRequest
# addShopLogoWithSize468px( )

Include the shop logo with 4680px width

Include the shop logo with 4680px width

Returns

Affilinet\ProductData\Requests\ProductsRequest
public Affilinet\ProductData\Requests\ProductsRequest
# page( integer $pageNumber = 1 )

Which page to display - starts counting at 1 - defaults to 1

Which page to display - starts counting at 1 - defaults to 1

If you want to display the first page set $pageNumber to 1

Parameters

$pageNumber

Returns

Affilinet\ProductData\Requests\ProductsRequest
public Affilinet\ProductData\Requests\ProductsRequest
# pageSize( integer $pageNumber = 1 )

Number of products in one page minimum = 1, maximum = 500, default = 10

Number of products in one page minimum = 1, maximum = 500, default = 10

If you want to display the first page set $pageNumber to 1

Parameters

$pageNumber
minimum = 1, maximum = 500, default = 10

Returns

Affilinet\ProductData\Requests\ProductsRequest
public Affilinet\ProductData\Requests\ProductsRequest
# sort( $sortBy = 'Score', boolean $descending = true )

Result sorting. You can only sort by Score (==relevance), price, productName, lastShopUpdate

Result sorting. You can only sort by Score (==relevance), price, productName, lastShopUpdate

Lets you define along which criteria the search results shall be sorted. Possible values are (case insensitive): - Score (a.k.a. rank, relevance) - Price (excl. shipping) - ProductName - LastImported (the date of the last feed update of this product’s shop is considered - not necessarily the last update of this singe product, but any product of this shop)

By default, the results will be sorted by score. Products with the same score will be sorted by LastImported.

Parameters

$sortBy
Price, ProductName, LastShopUpdate)
$descending

Returns

Affilinet\ProductData\Requests\ProductsRequest
public Affilinet\ProductData\Requests\ProductsRequest
# minPrice( $price )

Minimum product price

Minimum product price

Parameters

$price
If string, no thousand separator and use a point (.) for decimal separator

Returns

Affilinet\ProductData\Requests\ProductsRequest
public Affilinet\ProductData\Requests\ProductsRequest
# maxPrice( $price )

Maximum product price

Maximum product price

Parameters

$price
If string, no thousand separator and use a point (.) for decimal separator

Returns

Affilinet\ProductData\Requests\ProductsRequest
public Affilinet\ProductData\Requests\ProductsRequest
# addFacetArticleNumber( integer $facetValueLimit = self::DEFAULT_FACET_VALUE_LIMIT )

Add facet articleNumber A maximum of four facets can be added to the result

Add facet articleNumber A maximum of four facets can be added to the result

Parameters

$facetValueLimit

Returns

Affilinet\ProductData\Requests\ProductsRequest
public Affilinet\ProductData\Requests\ProductsRequest
# addFacetBrand( integer $facetValueLimit = self::DEFAULT_FACET_VALUE_LIMIT )

Add facet brand A maximum of four facets can be added to the result

Add facet brand A maximum of four facets can be added to the result

Parameters

$facetValueLimit

Returns

Affilinet\ProductData\Requests\ProductsRequest
public Affilinet\ProductData\Requests\ProductsRequest
# addFacetDistributor( integer $facetValueLimit = self::DEFAULT_FACET_VALUE_LIMIT )

Add facet distributor A maximum of four facets can be added to the result

Add facet distributor A maximum of four facets can be added to the result

Parameters

$facetValueLimit

Returns

Affilinet\ProductData\Requests\ProductsRequest
public Affilinet\ProductData\Requests\ProductsRequest
# addFacetEAN( integer $facetValueLimit = self::DEFAULT_FACET_VALUE_LIMIT )

Add facet EAN (European Article Number) A maximum of four facets can be added to the result

Add facet EAN (European Article Number) A maximum of four facets can be added to the result

Parameters

$facetValueLimit

Returns

Affilinet\ProductData\Requests\ProductsRequest
public Affilinet\ProductData\Requests\ProductsRequest
# addFacetManufacturer( integer $facetValueLimit = self::DEFAULT_FACET_VALUE_LIMIT )

Add facet manufacturer A maximum of four facets can be added to the result

Add facet manufacturer A maximum of four facets can be added to the result

Parameters

$facetValueLimit

Returns

Affilinet\ProductData\Requests\ProductsRequest
public Affilinet\ProductData\Requests\ProductsRequest
# addFacetProgramId( integer $facetValueLimit = self::DEFAULT_FACET_VALUE_LIMIT )

Add facet programId A maximum of four facets can be added to the result

Add facet programId A maximum of four facets can be added to the result

Parameters

$facetValueLimit

Returns

Affilinet\ProductData\Requests\ProductsRequest
public Affilinet\ProductData\Requests\ProductsRequest
# addFacetShopId( integer $facetValueLimit = self::DEFAULT_FACET_VALUE_LIMIT )

Add facet with shop IDs A maximum of four facets can be added to the result

Add facet with shop IDs A maximum of four facets can be added to the result

Parameters

$facetValueLimit

Returns

Affilinet\ProductData\Requests\ProductsRequest
public Affilinet\ProductData\Requests\ProductsRequest
# addFacetShopName( integer $facetValueLimit = self::DEFAULT_FACET_VALUE_LIMIT )

Add facet with Shop Names A maximum of four facets can be added to the result

Add facet with Shop Names A maximum of four facets can be added to the result

Parameters

$facetValueLimit

Returns

Affilinet\ProductData\Requests\ProductsRequest
public Affilinet\ProductData\Requests\ProductsRequest
# addFacetAffilinetCategoryId( integer $facetValueLimit = self::DEFAULT_FACET_VALUE_LIMIT )

Add facet with Affilinet Category IDs A maximum of four facets can be added to the result

Add facet with Affilinet Category IDs A maximum of four facets can be added to the result

Parameters

$facetValueLimit

Returns

Affilinet\ProductData\Requests\ProductsRequest
public Affilinet\ProductData\Requests\ProductsRequest
# addFacetAffilinetCategoryPath( integer $facetValueLimit = self::DEFAULT_FACET_VALUE_LIMIT )

Add facet with Affilinet Category Path A maximum of four facets can be added to the result

Add facet with Affilinet Category Path A maximum of four facets can be added to the result

Parameters

$facetValueLimit

Returns

Affilinet\ProductData\Requests\ProductsRequest
public Affilinet\ProductData\Requests\ProductsRequest
# addFacetShopCategoryId( integer $facetValueLimit = self::DEFAULT_FACET_VALUE_LIMIT )

Add facet with Shop Category IDs A maximum of four facets can be added to the result

Add facet with Shop Category IDs A maximum of four facets can be added to the result

Parameters

$facetValueLimit

Returns

Affilinet\ProductData\Requests\ProductsRequest
public Affilinet\ProductData\Requests\ProductsRequest
# addFacetShopCategoryPath( integer $facetValueLimit = self::DEFAULT_FACET_VALUE_LIMIT )

Add facet with Shop Category Paths A maximum of four facets can be added to the result

Add facet with Shop Category Paths A maximum of four facets can be added to the result

Parameters

$facetValueLimit

Returns

Affilinet\ProductData\Requests\ProductsRequest
public string
# serialize( )

Serialize this request for use as URI query string

Serialize this request for use as URI query string

Returns

string

Implementation of

Serializable::serialize()
public Affilinet\ProductData\Requests\ProductsRequest
# unserialize( $serialized )

Generate ProductsRequest from URI query string

Generate ProductsRequest from URI query string

Parameters

$serialized
string

Returns

Affilinet\ProductData\Requests\ProductsRequest

Implementation of

Serializable::unserialize()
public Affilinet\ProductData\Requests\ProductsRequest
# addRawQuery( $query )

Parameters

$query

Returns

Affilinet\ProductData\Requests\ProductsRequest
public ProductsRequestInterface;
# query( Affilinet\ProductData\Requests\Helper\QueryInterface $query )

Parameters

$query

Returns

ProductsRequestInterface;
public
# addFilterQuery( $name, $value )

Parameters

$name
$value

Returns


$this
Methods inherited from Affilinet\ProductData\Requests\RequestInterface
__construct(), getEndpoint(), getPsr7Request(), send()
Constants summary
integer DEFAULT_FACET_VALUE_LIMIT
# 20
API documentation generated by ApiGen