home > support > API > Marketplace API > List Product Filters

List Product Filters

Product Filters are used to group tours. Use this API to find out which tours are in which Product Filters.

For use by Tour Operator accounts only, not accessible by Marketplace Agents.

REST info

Endpoint/c/tours/filters
FormatsXML
Example/c/tours/filters.xml
VerbGET

Code samples

PHP examples use the PHP Client Library with SimpleXML

Description

object list_product_filters ( int $channel )


Parameters

$channel
Channel to list Product Filters from

Example

// Query the TourCMS API
$channel = 3930;
$result = $tourcms->list_product_filters($channel);

// Loop through each filter
foreach($result->filters->filter as $filter) {
	// Print out the filter name
	print $filter->filter_name.'<br />';
}
Cycling Tours
Hiking Tours

C# examples use the .Net Client Library

VB examples use the .Net Client Library

NodeJS examples use the NodeJS Wrapper

Looking for sample code in a different language? TourCMS and community provided API libraries

Querystring parameters

There are no querystring parameters supported by this method.

Response fields

Response fields
XML NodeNotes
request Confirmation of the request that you sent
error Any error message returned, if there is no error this will just contain the text OK
filters
XML NodeNotes
filter

There will be one filter node for each Product Filter returned

Each filter node contains the following child nodes.

XML NodeNotes
filter_idThe system ID for the Product Filter
filter_nameThe staff entered free-text name for the Product Filter
tour

There will be one tour node for each Tour in this Filter

Each tour node contains the following child nodes.

XML NodeNotes
tour_idThe system ID for the Tour
tour_nameThe staff entered free-text name for the Tour
tour_codeThe staff entered free-text code for the Tour

More information