Swagger\Client\DefaultApi

All URIs are relative to https://api-v3.findify.io/v3

Method	HTTP request	Description
autocompletePost	POST /autocomplete
feedbackPost	POST /feedback
recommendItemsFeaturedPost	POST /recommend/items/featured
recommendItemsItemIdViewedViewedPost	POST /recommend/items/{item_id}/viewed/viewed
recommendItemsItemIdsBoughtBoughtPost	POST /recommend/items/{item_ids}/bought/bought
recommendItemsNewestPost	POST /recommend/items/newest
recommendItemsTrendingPost	POST /recommend/items/trending
recommendItemsViewedLatestPost	POST /recommend/items/viewed/latest
recommendSlotPost	POST /recommend/{slot}
searchPost	POST /search
smartCollectionSlotPost	POST /smart-collection/{slot}

autocompletePost

\Swagger\Client\Model\AutocompleteResponse autocompletePost($autocomplete)

Autocomplete

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\DefaultApi();
$autocomplete = new \Swagger\Client\Model\AutocompleteRequest(); // \Swagger\Client\Model\AutocompleteRequest | Request parameters for autocomplete

try {
    $result = $api_instance->autocompletePost($autocomplete);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->autocompletePost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
autocomplete	\Swagger\Client\Model\AutocompleteRequest	Request parameters for autocomplete

Return type

\Swagger\Client\Model\AutocompleteResponse

Authorization

key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

feedbackPost

feedbackPost($feedback)

Feedback API

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\DefaultApi();
$feedback = new \Swagger\Client\Model\Feedback(); // \Swagger\Client\Model\Feedback | Feedback query

try {
    $api_instance->feedbackPost($feedback);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->feedbackPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
feedback	\Swagger\Client\Model\Feedback	Feedback query

Return type

void (empty response body)

Authorization

key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

recommendItemsFeaturedPost

\Swagger\Client\Model\GenericRecommendationResponse recommendItemsFeaturedPost($recommendation)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\DefaultApi();
$recommendation = new \Swagger\Client\Model\FeaturedRecommendationRequest(); // \Swagger\Client\Model\FeaturedRecommendationRequest | Recommendation query

try {
    $result = $api_instance->recommendItemsFeaturedPost($recommendation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->recommendItemsFeaturedPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
recommendation	\Swagger\Client\Model\FeaturedRecommendationRequest	Recommendation query

Return type

\Swagger\Client\Model\GenericRecommendationResponse

Authorization

key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

recommendItemsItemIdViewedViewedPost

\Swagger\Client\Model\GenericRecommendationResponse recommendItemsItemIdViewedViewedPost($item_id, $recommendation)

Users who viewed this item also viewed that recommendation

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\DefaultApi();
$item_id = "item_id_example"; // string | 
$recommendation = new \Swagger\Client\Model\RecommendationRequest(); // \Swagger\Client\Model\RecommendationRequest | Recommendation query

try {
    $result = $api_instance->recommendItemsItemIdViewedViewedPost($item_id, $recommendation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->recommendItemsItemIdViewedViewedPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
item_id	string
recommendation	\Swagger\Client\Model\RecommendationRequest	Recommendation query

Return type

\Swagger\Client\Model\GenericRecommendationResponse

Authorization

key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

recommendItemsItemIdsBoughtBoughtPost

\Swagger\Client\Model\GenericRecommendationResponse recommendItemsItemIdsBoughtBoughtPost($item_ids, $recommendation)

Frequently purchased together recommendation

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\DefaultApi();
$item_ids = "item_ids_example"; // string | 
$recommendation = new \Swagger\Client\Model\RecommendationRequest(); // \Swagger\Client\Model\RecommendationRequest | Recommendation query

try {
    $result = $api_instance->recommendItemsItemIdsBoughtBoughtPost($item_ids, $recommendation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->recommendItemsItemIdsBoughtBoughtPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
item_ids	string
recommendation	\Swagger\Client\Model\RecommendationRequest	Recommendation query

Return type

\Swagger\Client\Model\GenericRecommendationResponse

Authorization

key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

recommendItemsNewestPost

\Swagger\Client\Model\GenericRecommendationResponse recommendItemsNewestPost($recommendation)

Newest items recommendation

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\DefaultApi();
$recommendation = new \Swagger\Client\Model\RecommendationRequest(); // \Swagger\Client\Model\RecommendationRequest | Recommendation query

try {
    $result = $api_instance->recommendItemsNewestPost($recommendation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->recommendItemsNewestPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
recommendation	\Swagger\Client\Model\RecommendationRequest	Recommendation query

Return type

\Swagger\Client\Model\GenericRecommendationResponse

Authorization

key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

recommendItemsTrendingPost

\Swagger\Client\Model\GenericRecommendationResponse recommendItemsTrendingPost($recommendation)

Newest items recommendation

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\DefaultApi();
$recommendation = new \Swagger\Client\Model\RecommendationRequest(); // \Swagger\Client\Model\RecommendationRequest | Recommendation query

try {
    $result = $api_instance->recommendItemsTrendingPost($recommendation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->recommendItemsTrendingPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
recommendation	\Swagger\Client\Model\RecommendationRequest	Recommendation query

Return type

\Swagger\Client\Model\GenericRecommendationResponse

Authorization

key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

recommendItemsViewedLatestPost

\Swagger\Client\Model\GenericRecommendationResponse recommendItemsViewedLatestPost($recommendation)

Latest viewed items by the user recommendation

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\DefaultApi();
$recommendation = new \Swagger\Client\Model\RecommendationRequest(); // \Swagger\Client\Model\RecommendationRequest | Recommendation query

try {
    $result = $api_instance->recommendItemsViewedLatestPost($recommendation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->recommendItemsViewedLatestPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
recommendation	\Swagger\Client\Model\RecommendationRequest	Recommendation query

Return type

\Swagger\Client\Model\GenericRecommendationResponse

Authorization

key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

recommendSlotPost

\Swagger\Client\Model\GenericRecommendationResponse recommendSlotPost($slot, $recommendation)

Generic recommendation

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\DefaultApi();
$slot = "slot_example"; // string | 
$recommendation = new \Swagger\Client\Model\GenericRecommendationRequest(); // \Swagger\Client\Model\GenericRecommendationRequest | Recommendation query

try {
    $result = $api_instance->recommendSlotPost($slot, $recommendation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->recommendSlotPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
slot	string
recommendation	\Swagger\Client\Model\GenericRecommendationRequest	Recommendation query

Return type

\Swagger\Client\Model\GenericRecommendationResponse

Authorization

key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

searchPost

\Swagger\Client\Model\SearchResponse searchPost($search)

Search

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\DefaultApi();
$search = new \Swagger\Client\Model\SearchRequest(); // \Swagger\Client\Model\SearchRequest | Search query

try {
    $result = $api_instance->searchPost($search);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->searchPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
search	\Swagger\Client\Model\SearchRequest	Search query

Return type

\Swagger\Client\Model\SearchResponse

Authorization

key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

smartCollectionSlotPost

\Swagger\Client\Model\CollectionResponse smartCollectionSlotPost($slot, $collection)

Smart collection

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\DefaultApi();
$slot = "slot_example"; // string | 
$collection = new \Swagger\Client\Model\CollectionRequest(); // \Swagger\Client\Model\CollectionRequest | Smart collection query

try {
    $result = $api_instance->smartCollectionSlotPost($slot, $collection);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->smartCollectionSlotPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
slot	string
collection	\Swagger\Client\Model\CollectionRequest	Smart collection query

Return type

\Swagger\Client\Model\CollectionResponse

Authorization

key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

DefaultApi.md

Latest commit

History

DefaultApi.md

File metadata and controls

Swagger\Client\DefaultApi

autocompletePost

Example

Parameters

Return type

Authorization

HTTP request headers

feedbackPost

Example

Parameters

Return type

Authorization

HTTP request headers

recommendItemsFeaturedPost

Example

Parameters

Return type

Authorization

HTTP request headers

recommendItemsItemIdViewedViewedPost

Example

Parameters

Return type

Authorization

HTTP request headers

recommendItemsItemIdsBoughtBoughtPost

Example

Parameters

Return type

Authorization

HTTP request headers

recommendItemsNewestPost

Example

Parameters

Return type

Authorization

HTTP request headers

recommendItemsTrendingPost

Example

Parameters

Return type

Authorization

HTTP request headers

recommendItemsViewedLatestPost

Example

Parameters

Return type

Authorization

HTTP request headers

recommendSlotPost

Example

Parameters

Return type

Authorization

HTTP request headers

searchPost

Example

Parameters

Return type

Authorization

HTTP request headers

smartCollectionSlotPost

Example

Parameters

Return type

Authorization

HTTP request headers