Findify

Findify Developer Hub

Welcome to the Findify developer hub. You'll find comprehensive guides and documentation to help you start working with Findify as quickly as possible, as well as support if you get stuck. Let's jump right in!

Suggest Edits

Introduction

 

Findify provides a set of low- and high-level tools that can help you integrate on any platform using your favorite tools.

For the low-level integration we provide a set of HTTP JSON routes that give you access to all features and tools that we offer.

On a high-level we provide a set of SDK and JS libraries that can ease the integration.

We recommend using high-level tools

We recommend using SDKs and especially JS Feedback library and use low-level API only for building new SDKs

All routes support both HTTP GET and HTTP POST verbs.

For POST requests, the request body must be JSON, with the Content-Type header set to application/json.

The GET requests can be used for JSONP. You can adjust the callback name thanks to the "callback" parameter.

Suggest Edits

Authentication

 

We use API Key authentication mechanism for all routes.

You simply provide a header X-Key with the value of the API key that you have.

curl --request POST \
  --url https://api-v3.findify.io/v3/autocomplete \
  --header "X-Key: 2e963f3e-38bd-4c00-9636-c00e48945eb7" \
  --header "Content-Type: application/json" \
  --data '{"user":{"lang":["en-US","en-GB","no"],"uid":"test1","sid":"ssid","email":"test@test.com","ip":"192.168.0.1","ua":"Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36"},"q":"t","t_client":1484741395471,"suggestion_limit":5,"item_limit":3,"log":false}'

How to get an API key?

To get an API key you need to register with our service and finish the onboarding process (this includes providing a valid feed). If you just want to check out our capabilities, you can use a test API key 2e963f3e-38bd-4c00-9636-c00e48945eb7 that is connected to our demo store: http://findify-demo-store.myshopify.com

Suggest Edits

Required data

 

When using the JSON API directly, or high-level SDKs and JS libraries, there several entities that must be provided.

The user object

It defines the current user, which gives just enough information to enable personalization.

User object has two properties that are required uid and sid

user.uid

string
max length: 32 characters
This is a unique identified of the user across multiple sessions. You can store the uid in the cookie or get it from any other source (like a database). It must uniquly identify the user.

user.sid

string
max length: 32 characters
A unique session identifier, the best is to store the value in a cookie on the client side, with a TTL of 30 minutes or use a session ID that your platform provides.

Other user properties are not required and the API will answer if they are not provided.

Personalization

For the best results, our personalization platform requires user.email, user.ua, user.ip and user.lang properties

user.email

string
The email from the user, if the user is logged in. Providing an email allows us to track the user across devices and give them relevant personalized results.

user.ip

string
By default we get the ip from the request that we receive, but if you are using a direct JSON API integration or for some reason the call is made not from the user's browser, please include the relevant user ip in the request.

user.ua

string
By default we get the user agent from the request that we receive, but if you are using a direct JSON API integration or for some reason the call is made not from the user's browser, please include the relevant user user agent in the request.

user.lang

list of string
By default we get the user languages from the request that we receive, but if you are using a direct JSON API integration or for some reason the call is made not from the user's browser, please include the relevant user user languages in the request. You can use either an ISO 639-1 language format code or include the locale code: en-GB.

t_client

A timestamp from the client side of the user, useful to keep the right ordering of the events that happened

Suggest Edits

Search API

 

Our Search API provides the ability to do autocomplete and full facets search.

Suggest Edits

/autocomplete

Get the predictive results. The answer contains both search suggestions to direct the end user to high-conversion queries, and item matches to help them understand what will be displayed in the complete search results.

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api-v3.findify.io/v3/autocomplete
curl --request POST \
  --url https://api-v3.findify.io/v3/autocomplete \
  --header "X-Key: 2e963f3e-38bd-4c00-9636-c00e48945eb7" \
  --header "Content-Type: application/json" \
  --data '{"user":{"lang":["en-US","en-GB","no"],"uid":"test1","sid":"ssid","email":"test@test.com","ip":"192.168.0.1","ua":"Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36"},"q":"t","t_client":1484741395471,"suggestion_limit":5,"item_limit":3,"log":false}'
//Please, don't forget to include the SDK script
//Which you can find here: https://github.com/findify/javascript-sdk

var client = FindifySDK.init({
    key: '2e963f3e-38bd-4c00-9636-c00e48945eb7',
    user: {
        uid: 'test1',
        sid: 'ssid',
      	email: 'test@test.com'
    },
    log: false
});

var request = {
    q: 't',
    suggestion_limit: 5,
    item_limit: 3
};

client.autocomplete(request).then(function (response) {
  console.log(response);
});
var request = require("request"); 

var options = { 
  method: 'POST',
  url: 'https://api-v3.findify.io/v3/autocomplete',
  headers: {
  	"X-key": "2e963f3e-38bd-4c00-9636-c00e48945eb7"
  },
  body: { 
      user: { 
        lang: [ 'en-US', 'en-GB', 'no' ],
        uid: 'test1',
        sid: 'ssid',
        email: 'test@test.com',
        ip: '192.168.0.1',
        ua: 'Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36' 
      },
      q: 't',
      t_client: 1484741395471,
      suggestion_limit: 5,
      item_limit: 3,
      log: false
  	},
  	json: true 
  };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Key', '2e963f3e-38bd-4c00-9636-c00e48945eb7');

$api_instance = new Swagger\Client\Api\DefaultApi();
$autocomplete = new \Swagger\Client\Model\AutocompleteRequest(array(
    'user' => array(
        'uid' => 'test1',
        'sid' => 'ssid',
        'email' => 'test@test.com',
        'ip' => '192.168.0.1',
        'ua' => 'Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36',
        'lang' => array(
            'en-US',
            'en-GB',
            'no'
        )
    ),
    'q' => 't',
    't_client' => '1484741395471',
    'suggestion_limit' => 5,
    'item_limit' => 3,
    'log' => false
));

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

?>
A binary file was returned

You couldn't be authenticated

{
  "meta": {
    "q": "t",
    "suggestion_limit": 3,
    "item_limit": 3,
    "rid": "a-edb49c53-eec3-48cc-85ab-d70f77b6e7b2"
  },
  "suggestions": [
    {
      "value": "t"
    },
    {
      "value": "t shirt"
    },
    {
      "value": "t example"
    }
  ],
  "items": [
    {
      "product_url": "http://findify-demo-store.myshopify.com/products/example-t-shirt",
      "price": [
        19.99,
        19.99,
        19.99,
        19.99,
        19.99,
        23,
        25
      ],
      "id": "6411337927",
      "title": "Example T-Shirt",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/shopify_shirt_small.png?v=1462524515",
      "compare_at": -1,
      "stickers": {
        "in-stock": false,
        "out-of-stock": false,
        "discount": false,
        "free-shipping": false
      }
    },
    {
      "product_url": "http://findify-demo-store.myshopify.com/products/hills-canine-vetessentials-mature-adult",
      "price": [
        18.38,
        55.34
      ],
      "id": "6411340743",
      "title": "Hill's Canine Vetessentials Mature Adult",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/hills_vetessentials_canine_mature_adult_small.jpeg?v=1462524523",
      "compare_at": -1,
      "stickers": {
        "in-stock": false,
        "out-of-stock": false,
        "discount": false,
        "free-shipping": false
      }
    },
    {
      "product_url": "http://findify-demo-store.myshopify.com/products/hills-canine-vetessentials-adult",
      "price": [
        16.75,
        51.4
      ],
      "id": "6411340167",
      "title": "Hill's Canine Vetessentials Adult",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/hills_vetessentials_canine_adult_small.jpeg?v=1462524521",
      "compare_at": -1,
      "stickers": {
        "in-stock": false,
        "out-of-stock": false,
        "discount": false,
        "free-shipping": false
      }
    }
  ]
}
{
  "error": {
    "message": "You should provide Findify API Key"
  }
}

Body Params

t_client
date-time
required

Timestamp when the request is sent from the browser

user
object
required
 
user.uid
string
required

max length: 32 characters

user.sid
string
required

max length: 32 characters

user.email
string
user.ip
string
user.ua
string
user.lang
array of strings
q
string
required
suggestion_limit
int32

max = 10

item_limit
int32

max = 10

callback
string
log
boolean
 

Autocomplete response description

// Autocomplete response structure
{	
	/** Autocomplete request meta data */
	meta: {
		/** Item limit - this is the limitation of the product matches returned */
		item_limit: 3,
		/** Suggestion limit - this is the limitation of the suggestions returned */
		suggestion_limit: 6,
		/** Query taht was used to perform request */
		q: 'sample',
		/** Rerquest ID - first part: prefix that points to the source of ther request (a/s/sc/r/c) */
		/** In case of autocomplete request prefix - is "a" */
		/** Second part is rendomly generated string */
		rid: 's-9fcc881c-1420-4e57-bc58-e234829c363c'
	},
	/** Array of returned product matches */
	items: [
		/** Object that represents default autocomplete product match */
		/** Important note: there might be additional fields in response, it depends on autocomplet returnable fields configuration */
		{
			/** Boolean flag that indicates whether the product is available or not */
			availability: true,
			/** Product ID */
			id: '4123451324123',
			/** Product URL */
			product_url: 'https://store-name.com/path_to_product',
			/** Price with which the discount price is compared */
			/** In case when product doesn't have sale price this fields will be -1 */
			compare_at: 100,
			/** Array of availble product prices */
			price: [90],
			/** If product has sale price this field contains array of numbers */
			/** that represents discount value in percentage for each discounted price */
			discount: [10],
			/** Url for thumbnail image (cropped main product image) */
			thumbnail_url: 'https://cdn_name.com/path_the_thumbnail_image',
			/** Object with boolean flags which indicate which stickers to show  */
			stickers: {
				discount: true,
				availability: true,
				in-stock: true,
				out-of-stock: false
			}
		}
	],
	/** Array of returned suggestions */
	suggestions: [
		{
			value: 'a'
		},
		{
			value: 'b'
		}
	]
}
Suggest Edits

/search/content

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api-v3.findify.io/v3/search/content
curl --request POST \
  --url https://api-v3.findify.io/v3/search/content \
  --header "X-Key: 680d373d-06b3-442b-bebc-d35a5b0868b3" \
  --header "Content-Type: application/json" \
  --data '{"user":{"lang":["en-GB"],"uid":"test1","sid":"ssid","email":"test@test.com","ip":"192.168.0.1","ua":"Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36"},"q":"Socks","type": ["instagram"],"t_client":1484742065791,"filters":[{ "name": "post.hashtags", "type": "text", "values": [{ "value": "bamboosocks" }] }], "sort":[],"offset":0,"limit":20,"log":false}'
 var request = require("request"); 

var options = {
    method: 'POST',
    url: 'https://api-v3.findify.io/v3/search/content',
    headers: {
      "X-key": "680d373d-06b3-442b-bebc-d35a5b0868b3"
    },
    body: {
        user: {
            lang: ['en-GB'],
            uid: 'test1',
            sid: 'ssid',
            email: 'test@test.com',
            ip: '192.168.0.1',
            ua: 'Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36'
        },
      	t_client: "1484742065791",
        q: 'Socks',
      	type: ['instagram'],
        t_client: 1484742065791,
        filters: [{
                name: 'post.hashtags',
                type: 'text',
                values: [{"value": "bamboosocks"}]
            }
        ],
        sort: [],
        offset: 0,
        limit: 20,
        log: false
    },
    json: true
};

request(options, function(error, response, body) {
    if (error) throw new Error(error);

    console.log(body);
})
//Please, don't forget to include the SDK script
//Which you can find here: https://github.com/findify/javascript-sdk

var client = FindifySDK.init({
    key: '680d373d-06b3-442b-bebc-d35a5b0868b3',
    user: {
        uid: 'test1',
        sid: 'ssid',
      	email: 'test@test.com'
    },
    log: false
});

var request = {
    q: 'Socks',
  	type: ['instagram'],
    filters: [{
        name: 'post.hashtags',
        type: 'text',
        values: [{"value": "bamboosocks"}]
    }],
    sort: [],
    offset: 0,
    limit: 20,
};

client.search.content(request).then(function (response) {
  	console.log(response);
});
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Key', '680d373d-06b3-442b-bebc-d35a5b0868b3');

$api_instance = new Swagger\Client\Api\DefaultApi();
$search = new \Swagger\Client\Model\SearchRequest(array(
    'user' => array(
        'uid' => 'test1',
        'sid' => 'ssid',
        'email' => 'test@test.com',
        'ip' => '192.168.0.1',
        'ua' => 'Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36',
        'lang' => array(
            'en-US',
            'en-GB',
            'no'
        )
    ),
    'q' => 'Socks',
    't_client' => 1484741395471,
    'filters' => array(
        array(
            'name' => 'post.hashtags',
            'type' => 'text',
            'values' => array(
                array(
                    'value' => array('bamboosocks')
                )
            )
        )
    ),
    'sort' => array(),
    'offset' => 0,
    'limit' => 20,
    'log' => false
));

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

?>
A binary file was returned

You couldn't be authenticated

{
    "meta": {
        "q": "socks",
        "offset": 0,
        "limit": 20,
        "total": 15,
        "filters": [
            {
                "name": "post.hashtags",
                "type": "text",
                "values": [
                    {
                        "value": "bamboosocks"
                    }
                ]
            }
        ],
        "sort": [],
        "type": [
            "instagram"
        ],
        "rid": "c-32d2b16b-b0ad-4676-94e4-eae010b57be9",
        "query_type": "and"
    },
    "facets": [],
    "items": [
        {
            "source": "instagram",
            "id": "102",
            "image_id": "5aac2aca505b7d30a8524e4f",
            "low_resolution_image_url": "//scontent.cdninstagram.com/vp/9eb85bd03fa0c3763c02fc899970b6d1/5B40F722/t51.2885-15/s320x320/e35/28152739_151883155505286_608048570318192640_n.jpg",
            "original_image_url": "//scontent.cdninstagram.com/vp/4939f9ccc6848f30bb980834715eb4ff/5B39AFFE/t51.2885-15/s640x640/sh0.08/e35/28152739_151883155505286_608048570318192640_n.jpg",
            "image_url": "//scontent.cdninstagram.com/vp/92a7be49f6533f1277eaf472976895a3/5B2823DF/t51.2885-15/s150x150/e35/28152739_151883155505286_608048570318192640_n.jpg",
            "external_media_id": "1720224939967288864_6253558014",
            "tagged_products": [
                {
                    "id": 33753494,
                    "name": "Solid Colours Gift Box | 4 pairs of plain bamboo organic crew socks",
                    "domain_key": "1677",
                    "product_link": "https://yotpo.com/go/tUYCN7i4",
                    "product_url": "http://seriouslysillysocks.com/solid-colours-gift-box-4-pairs-of-plain-bamboo-organic-crew-socks/",
                    "image_url": "https://ddcfq0gxiontw.cloudfront.net/Product/33967253/27614412/square.jpg?1508303774"
                },
                {
                    "id": 33607022,
                    "name": "Plain soft bamboo organic crew socks in denim | By seriouslysillysocks",
                    "domain_key": "1618",
                    "product_link": "https://yotpo.com/go/cvInPo0X",
                    "product_url": "http://seriouslysillysocks.com/plain-soft-bamboo-organic-crew-socks-in-denim-by-seriouslysillysocks/",
                    "image_url": "https://ddcfq0gxiontw.cloudfront.net/Product/33820781/27434489/square.jpg?1521018255"
                },
                {
                    "id": 34794217,
                    "name": "Plain soft bamboo organic crew sock in yellow | By seriouslysillysocks",
                    "domain_key": "1620",
                    "product_link": "https://yotpo.com/go/xcfUTe5i",
                    "product_url": "http://seriouslysillysocks.com/plain-soft-bamboo-organic-crew-sock-in-yellow-by-seriouslysillysocks/",
                    "image_url": "https://ddcfq0gxiontw.cloudfront.net/Product/35007979/28620720/square.jpg?1510011838"
                }
            ],
            "post": {
                "profile_picture": "https://scontent.cdninstagram.com/vp/135bf7f7ae221d1f96f8db7a1107938b/5B4E0850/t51.2885-19/22639090_349130718881132_6121542158852816896_n.jpg",
                "username": "seriouslysillysocks",
                "location_name": "",
                "created_time": "2018-02-22T08:06:54.000+00:00",
                "hashtags": [
                    "seriouslysillysocks",
                    "brightsocks",
                    "bamboosocks",
                    "socks",
                    "bamboo",
                    "colourfulsocks",
                    "toomuchchoice"
                ],
                "content": "Somedays its hard to choose which socks to wear, we love our bamboo range from #seriouslysillysocks #bamboo #bamboosocks #socks #toomuchchoice #brightsocks #colourfulsocks",
                "votes_up": 0,
                "votes_down": 0
            }
        },
        {
            "source": "instagram",
            "id": "953",
            "image_id": "5aac2b88505b7d2a6c529b21",
            "low_resolution_image_url": "//scontent.cdninstagram.com/vp/9767b1858613d921d8ea3ba7bd91e847/5B2B479C/t51.2885-15/e35/p320x320/27892849_187829385153540_252043627415470080_n.jpg",
            "original_image_url": "//scontent.cdninstagram.com/vp/28be155116bd6dd6e9a0f1da9209a0a2/5B4E3970/t51.2885-15/sh0.08/e35/p640x640/27892849_187829385153540_252043627415470080_n.jpg",
            "image_url": "//scontent.cdninstagram.com/vp/ced41e4fc9031a06a2d95c5e28c396f0/5B2D1A36/t51.2885-15/s150x150/e35/c0.128.1024.1024/27892849_187829385153540_252043627415470080_n.jpg",
            "external_media_id": "1715879908133347184_6253558014",
            "tagged_products": [
                {
                    "id": 37411846,
                    "name": "Four-legged 3 pair bundle womens soft bamboo crew socks | Doris & Dude",
                    "domain_key": "1885",
                    "product_link": "https://yotpo.com/go/ppNLSVLD",
                    "product_url": "http://seriouslysillysocks.com/four-legged-3-pair-bundle-womens-soft-bamboo-crew-socks-doris-dude/",
                    "image_url": "https://ddcfq0gxiontw.cloudfront.net/Product/37635113/30807015/square.jpg?1517017427"
                }
            ],
            "post": {
                "profile_picture": "https://scontent.cdninstagram.com/vp/135bf7f7ae221d1f96f8db7a1107938b/5B4E0850/t51.2885-19/22639090_349130718881132_6121542158852816896_n.jpg",
                "username": "seriouslysillysocks",
                "location_name": "",
                "created_time": "2018-02-16T08:14:06.000+00:00",
                "hashtags": [
                    "seriouslysillysocks",
                    "animalsocks",
                    "bamboosocks",
                    "socks",
                    "bamboo",
                    "fourleggedfriend"
                ],
                "content": "Four legged bamboo socks bundles! Sometimes it hard to choose just one favourite animal\n#fourleggedfriend #bamboo #bamboosocks #socks #seriouslysillysocks #animalsocks\nlink in bio @dorisanddude",
                "votes_up": 0,
                "votes_down": 0
            }
        },
        {
            "source": "instagram",
            "id": "221",
            "image_id": "5aac2ba2505b7d2d32528f07",
            "low_resolution_image_url": "//scontent.cdninstagram.com/vp/a1c56070507bc5c7d810c6f66d8477e3/5B479156/t51.2885-15/e35/p320x320/27580799_2048929112017023_87217797800656896_n.jpg",
            "original_image_url": "//scontent.cdninstagram.com/vp/935c519f5313a21a1d30cd7a3622a1c1/5B32E4BA/t51.2885-15/sh0.08/e35/p640x640/27580799_2048929112017023_87217797800656896_n.jpg",
            "image_url": "//scontent.cdninstagram.com/vp/684fbc9cd963bac438ae38f6c05405a1/5B2836FE/t51.2885-15/s150x150/e35/c0.135.1080.1080/27580799_2048929112017023_87217797800656896_n.jpg",
            "external_media_id": "1711725391242450499_6253558014",
            "tagged_products": [
                {
                    "id": 33836348,
                    "name": "Flower Chintz bamboo organic crew sock in purple | seriouslysillysocks",
                    "domain_key": "1659",
                    "product_link": "https://yotpo.com/go/b5qFdgKx",
                    "product_url": "http://seriouslysillysocks.com/flower-chintz-bamboo-organic-crew-sock-in-purple-seriouslysillysocks/",
                    "image_url": "https://ddcfq0gxiontw.cloudfront.net/Product/34050107/27693855/square.jpg?1513435344"
                }
            ],
            "post": {
                "profile_picture": "https://scontent.cdninstagram.com/vp/135bf7f7ae221d1f96f8db7a1107938b/5B4E0850/t51.2885-19/22639090_349130718881132_6121542158852816896_n.jpg",
                "username": "seriouslysillysocks",
                "location_name": "",
                "created_time": "2018-02-10T14:39:49.000+00:00",
                "hashtags": [
                    "seriouslysillysocks",
                    "bamboosocks",
                    "socks",
                    "bamboo",
                    "butterfly"
                ],
                "content": "Dreaming of spring days... our organic bamboo socks are perfect for spring, link in bio\n#seriouslysillysocks #butterfly #socks #bamboosocks #bamboo",
                "votes_up": 0,
                "votes_down": 0
            }
        },
        {
            "source": "instagram",
            "id": "35",
            "image_id": "5aac2bbc6020e429706286f1",
            "low_resolution_image_url": "//scontent.cdninstagram.com/vp/801c62cd666a21b8f988e8d720ab575b/5B39E1CE/t51.2885-15/s320x320/e35/27578455_1565442440199675_7779169573969854464_n.jpg",
            "original_image_url": "//scontent.cdninstagram.com/vp/d72a989523f0c098ccb4d1ea45a2d384/5B4D2783/t51.2885-15/s640x640/sh0.08/e35/27578455_1565442440199675_7779169573969854464_n.jpg",
            "image_url": "//scontent.cdninstagram.com/vp/96509b886913ad995b6ae4e4891a5e67/5B361AFE/t51.2885-15/s150x150/e35/27578455_1565442440199675_7779169573969854464_n.jpg",
            "external_media_id": "1707882378011587634_6253558014",
            "tagged_products": [
                {
                    "id": 35328118,
                    "name": "Reusable bamboo mug and matching plain women's bamboo organic socks",
                    "domain_key": "1784",
                    "product_link": "https://yotpo.com/go/tlZk5egx",
                    "product_url": "http://seriouslysillysocks.com/reusable-bamboo-mug-and-matching-plain-womens-bamboo-organic-socks/",
                    "image_url": "https://ddcfq0gxiontw.cloudfront.net/Product/35541950/29102042/square.jpg?1511751799"
                },
                {
                    "id": 34824068,
                    "name": "Stripe reusable bamboo mug and matching women's bamboo organic socks",
                    "domain_key": "1783",
                    "product_link": "https://yotpo.com/go/646SJEVz",
                    "product_url": "http://seriouslysillysocks.com/stripe-reusable-bamboo-mug-and-matching-womens-bamboo-organic-socks/",
                    "image_url": "https://ddcfq0gxiontw.cloudfront.net/Product/35037830/28649721/square.jpg?1510070808"
                },
                {
                    "id": 35055060,
                    "name": "Reusable bamboo mug and matching plain men's bamboo organic socks",
                    "domain_key": "1782",
                    "product_link": "https://yotpo.com/go/uXp3BHke",
                    "product_url": "http://seriouslysillysocks.com/reusable-bamboo-mug-and-matching-plain-mens-bamboo-organic-socks/",
                    "image_url": "https://ddcfq0gxiontw.cloudfront.net/Product/35268843/28837487/square.jpg?1510703407"
                }
            ],
            "post": {
                "profile_picture": "https://scontent.cdninstagram.com/vp/135bf7f7ae221d1f96f8db7a1107938b/5B4E0850/t51.2885-19/22639090_349130718881132_6121542158852816896_n.jpg",
                "username": "seriouslysillysocks",
                "location_name": "",
                "created_time": "2018-02-05T07:24:26.000+00:00",
                "hashtags": [
                    "seriouslysillysocks",
                    "bamboomug",
                    "bamboosocks",
                    "socks",
                    "coffee",
                    "bamboo"
                ],
                "content": "Need coffee! And what better way to serve it than in one of our reusable bamboo mugs.\nLink in Bio\n#coffee #bamboo #bamboosocks #bamboomug #seriouslysillysocks #socks",
                "votes_up": 0,
                "votes_down": 0
            }
        },
        {
            "source": "instagram",
            "id": "174",
            "image_id": "5aac2c166020e42970628940",
            "low_resolution_image_url": "//scontent.cdninstagram.com/vp/9eafd4db6f29ebfcd1eb8993f72ca11f/5B4133AD/t51.2885-15/s320x320/e35/26864740_1727594193950276_9205574431114526720_n.jpg",
            "original_image_url": "//scontent.cdninstagram.com/vp/ad8383164de2095e13ae9f2b183f7122/5B3246E0/t51.2885-15/s640x640/sh0.08/e35/26864740_1727594193950276_9205574431114526720_n.jpg",
            "image_url": "//scontent.cdninstagram.com/vp/e3e70921bb0d1a75d97be9982f2d9758/5B46939D/t51.2885-15/s150x150/e35/26864740_1727594193950276_9205574431114526720_n.jpg",
            "external_media_id": "1702787602492721566_6253558014",
            "tagged_products": [
                {
                    "id": 37676692,
                    "name": "Pinstripe Gift Box | 4 pairs of women's bamboo crew socks by Braintree",
                    "domain_key": "1891",
                    "product_link": "https://yotpo.com/go/s95oRZvL",
                    "product_url": "http://seriouslysillysocks.com/pinstripe-gift-box-4-pairs-of-womens-bamboo-crew-socks-by-braintree/",
                    "image_url": "https://ddcfq0gxiontw.cloudfront.net/Product/37899969/31066133/square.jpg?1519177973"
                }
            ],
            "post": {
                "profile_picture": "https://scontent.cdninstagram.com/vp/135bf7f7ae221d1f96f8db7a1107938b/5B4E0850/t51.2885-19/22639090_349130718881132_6121542158852816896_n.jpg",
                "username": "seriouslysillysocks",
                "location_name": "",
                "created_time": "2018-01-29T06:42:02.000+00:00",
                "hashtags": [
                    "giftbox",
                    "boldsocks",
                    "brightsocks",
                    "bamboosocks",
                    "socks",
                    "bamboo",
                    "colourfulsocks",
                    "stripes",
                    "stripesocks",
                    "seriouslysillysocks",
                    "braintree"
                ],
                "content": "The ladies pinstripe gift box by Braintree contain socks that are made from super-soft bamboo, they are presented in a gift box that is made of fully recyclable materials and is fully reusable! available in our shop: link in bio\n\n#braintree #giftbox #bamboosocks #bamboo #stripesocks #stripes #socks #seriouslysillysocks #colourfulsocks #boldsocks #brightsocks",
                "votes_up": 0,
                "votes_down": 0
            }
        },
        {
            "source": "instagram",
            "id": "924",
            "image_id": "5aac2c2c6020e42ceb627ca4",
            "low_resolution_image_url": "//scontent.cdninstagram.com/vp/a11edd800a5eb34742a547baf9d22dd3/5B325CEA/t51.2885-15/s320x320/e35/26868900_1841171739517001_5601899331339681792_n.jpg",
            "original_image_url": "//scontent.cdninstagram.com/vp/03e451be526202b6de75b3a2d803d5fc/5B4051A7/t51.2885-15/s640x640/sh0.08/e35/26868900_1841171739517001_5601899331339681792_n.jpg",
            "image_url": "//scontent.cdninstagram.com/vp/6dbc621bf0dc725d22c3d48da6faf93d/5B4BFFDA/t51.2885-15/s150x150/e35/26868900_1841171739517001_5601899331339681792_n.jpg",
            "external_media_id": "1701498721411598400_6253558014",
            "tagged_products": [
                {
                    "id": 33323705,
                    "name": "Paw Prints soft bamboo organic crew sock, purple | seriouslysillysocks",
                    "domain_key": "1649",
                    "product_link": "https://yotpo.com/go/nKHcwSaK",
                    "product_url": "http://seriouslysillysocks.com/paw-prints-soft-bamboo-organic-crew-sock-purple-seriouslysillysocks/",
                    "image_url": "https://ddcfq0gxiontw.cloudfront.net/Product/33537452/27166207/square.jpg?1523039057"
                }
            ],
            "post": {
                "profile_picture": "https://scontent.cdninstagram.com/vp/135bf7f7ae221d1f96f8db7a1107938b/5B4E0850/t51.2885-19/22639090_349130718881132_6121542158852816896_n.jpg",
                "username": "seriouslysillysocks",
                "location_name": "",
                "created_time": "2018-01-27T12:01:15.000+00:00",
                "hashtags": [
                    "purple",
                    "boldsocks",
                    "comfort",
                    "animalsocks",
                    "pawsforthought",
                    "comfortable",
                    "socks",
                    "brightsocks",
                    "pawprint",
                    "colourfulsocks",
                    "purplesocks",
                    "organicsocks",
                    "paws",
                    "comfysocks",
                    "sillysocks",
                    "bamboosocks",
                    "crazysocks",
                    "bamboo",
                    "organic",
                    "suistainable",
                    "seriouslysillysocks",
                    "comfy"
                ],
                "content": "It's a paw print kind of day... our sustainable organic bamboo paw print socks are available in our shop (link in bio) #pawprint #seriouslysillysocks .\n.\n.\n#bamboosocks #bamboo #suistainable #organic #organicsocks #animalsocks #purple #purplesocks #paws #pawsforthought #sillysocks #crazysocks #boldsocks #socks #brightsocks #comfysocks #comfortable #comfort #comfy #colourfulsocks",
                "votes_up": 0,
                "votes_down": 0
            }
        },
        {
            "source": "instagram",
            "id": "42",
            "image_id": "5aac2c83505b7d2c84528a1b",
            "low_resolution_image_url": "//scontent.cdninstagram.com/vp/81fd4d58e6247f492bd71cdf53e60892/5B2B9F66/t51.2885-15/s320x320/e35/26407912_546876589022616_9115823324163735552_n.jpg",
            "original_image_url": "//scontent.cdninstagram.com/vp/45cff86ca75174869770d283b9944d20/5B298425/t51.2885-15/s640x640/sh0.08/e35/26407912_546876589022616_9115823324163735552_n.jpg",
            "image_url": "//scontent.cdninstagram.com/vp/a2bd868346f9f60b37ded96758bf332c/5B4BE521/t51.2885-15/s150x150/e35/26407912_546876589022616_9115823324163735552_n.jpg",
            "external_media_id": "1697245108116022998_6253558014",
            "tagged_products": [
                {
                    "id": 36998317,
                    "name": "Rabbit women's super-soft bamboo crew socks in blueberry | By Thought",
                    "domain_key": "1855",
                    "product_link": "https://yotpo.com/go/3LRkC48t",
                    "product_url": "http://seriouslysillysocks.com/rabbit-womens-super-soft-bamboo-crew-socks-in-blueberry-by-thought/",
                    "image_url": "https://ddcfq0gxiontw.cloudfront.net/Product/37212675/30633958/square.jpg?1521098847"
                },
                {
                    "id": 36890688,
                    "name": "Rabbit women's super-soft bamboo crew socks in dark grey | By Thought",
                    "domain_key": "1857",
                    "product_link": "https://yotpo.com/go/t1auFMlO",
                    "product_url": "http://seriouslysillysocks.com/rabbit-womens-super-soft-bamboo-crew-socks-in-dark-grey-by-thought/",
                    "image_url": "https://ddcfq0gxiontw.cloudfront.net/Product/37105046/30543371/square.jpg?1515807137"
                },
                {
                    "id": 36964896,
                    "name": "Rabbit women's super-soft bamboo crew socks in sea blue | By Thought",
                    "domain_key": "1858",
                    "product_link": "https://yotpo.com/go/adMdHSZZ",
                    "product_url": "http://seriouslysillysocks.com/rabbit-womens-super-soft-bamboo-crew-socks-in-sea-blue-by-thought/",
                    "image_url": "https://ddcfq0gxiontw.cloudfront.net/Product/37179254/30615528/square.jpg?1516152992"
                }
            ],
            "post": {
                "profile_picture": "https://scontent.cdninstagram.com/vp/135bf7f7ae221d1f96f8db7a1107938b/5B4E0850/t51.2885-19/22639090_349130718881132_6121542158852816896_n.jpg",
                "username": "seriouslysillysocks",
                "location_name": "",
                "created_time": "2018-01-21T15:10:05.000+00:00",
                "hashtags": [
                    "brightsocks",
                    "bamboosocks",
                    "rabbitsocks",
                    "bamboo",
                    "socks",
                    "colourfulsocks",
                    "cutesocks",
                    "rabbit",
                    "seriouslysillysocks",
                    "bunny"
                ],
                "content": "New bamboo socks in stock now! we love these new bamboo rabbit socks by @thoughtclothing see the range here: http://ow.ly/bhPj30hUjl0 \n#rabbit #bamboo #bamboosocks #cutesocks #rabbitsocks #bunny #socks #seriouslysillysocks #brightsocks #colourfulsocks",
                "votes_up": 0,
                "votes_down": 0
            }
        },
        {
            "source": "instagram",
            "id": "290",
            "image_id": "5aac2ca46020e429706293a5",
            "low_resolution_image_url": "//scontent.cdninstagram.com/vp/21afdfda0faca33538c8b70d7923ca7d/5B2C6556/t51.2885-15/s320x320/e35/26221502_2109406229346074_483692692820197376_n.jpg",
            "original_image_url": "//scontent.cdninstagram.com/vp/b7515c5a26960429bc5e9441f6146115/5B359415/t51.2885-15/s640x640/sh0.08/e35/26221502_2109406229346074_483692692820197376_n.jpg",
            "image_url": "//scontent.cdninstagram.com/vp/bbe8d1b67ee906f7c98f469dd12c9d29/5B29D511/t51.2885-15/s150x150/e35/26221502_2109406229346074_483692692820197376_n.jpg",
            "external_media_id": "1696424540462438670_6253558014",
            "tagged_products": [
                {
                    "id": 33636632,
                    "name": "Spot n Stripe bamboo organic crew socks in denim | seriouslysillysocks",
                    "domain_key": "1641",
                    "product_link": "https://yotpo.com/go/9vOMobEy",
                    "product_url": "http://seriouslysillysocks.com/spot-n-stripe-bamboo-organic-crew-socks-in-denim-seriouslysillysocks/",
                    "image_url": "https://ddcfq0gxiontw.cloudfront.net/Product/33850391/27482651/square.jpg?1508172788"
                }
            ],
            "post": {
                "profile_picture": "https://scontent.cdninstagram.com/vp/135bf7f7ae221d1f96f8db7a1107938b/5B4E0850/t51.2885-19/22639090_349130718881132_6121542158852816896_n.jpg",
                "username": "seriouslysillysocks",
                "location_name": "",
                "created_time": "2018-01-20T11:59:45.000+00:00",
                "hashtags": [
                    "boldsocks",
                    "spotsandstripes",
                    "organicbamboo",
                    "comfortable",
                    "socks",
                    "colourfulsocks",
                    "sockselfie",
                    "bluesocks",
                    "spottysocks",
                    "organicsocks",
                    "sillysocks",
                    "bamboosocks",
                    "crazysocks",
                    "bamboo",
                    "lazyday",
                    "stripesocks",
                    "ilovesocks",
                    "seriouslysillysocks",
                    "organic"
                ],
                "content": "It's a spots n stripes kind of day! These #seriouslysillysocks are made from #bamboo and are available in two sizes \nhttp://bit.ly/2Bf5AFz\n.\n.\n.  #bamboosocks #spottysocks #stripesocks #socks #boldsocks #sillysocks #crazysocks #bluesocks #ilovesocks #colourfulsocks #comfortable #lazyday #sockselfie #organicsocks #organicbamboo #organic #spotsandstripes",
                "votes_up": 0,
                "votes_down": 0
            }
        },
        {
            "source": "instagram",
            "id": "771",
            "image_id": "5aac2d4a6020e4297062a26b",
            "low_resolution_image_url": "//scontent.cdninstagram.com/vp/aaac0797a7c711997a23d3d9dac33ffc/5B4DBA0D/t51.2885-15/e35/p320x320/26065349_1133094680159293_6897004517099831296_n.jpg",
            "original_image_url": "//scontent.cdninstagram.com/vp/0d39a3d7b9cd7c731824166f28bceb4c/5B32479A/t51.2885-15/e35/26065349_1133094680159293_6897004517099831296_n.jpg",
            "image_url": "//scontent.cdninstagram.com/vp/1a93d2c8c3520ce20058b799df0ae9f7/5B3EBE98/t51.2885-15/s150x150/e35/c0.48.384.384/26065349_1133094680159293_6897004517099831296_n.jpg",
            "external_media_id": "1690558644317772990_6253558014",
            "tagged_products": [],
            "post": {
                "profile_picture": "https://scontent.cdninstagram.com/vp/135bf7f7ae221d1f96f8db7a1107938b/5B4E0850/t51.2885-19/22639090_349130718881132_6121542158852816896_n.jpg",
                "username": "seriouslysillysocks",
                "location_name": "",
                "created_time": "2018-01-12T09:45:16.000+00:00",
                "hashtags": [
                    "colourfulsocks",
                    "sillysocks",
                    "bamboo",
                    "seriouslysillysocks",
                    "organic",
                    "boldsocks",
                    "socks",
                    "softsocks",
                    "cycling",
                    "cyclingsocks",
                    "bamboosocks",
                    "organicsocks"
                ],
                "content": "Our #seriouslysillysocks are made from organic bamboo, these soft ladies cycling socks are great for the cyclist in your life! http://ow.ly/R0Oc30hCxmK\n#cycling #socks #boldsocks #colourfulsocks #cyclingsocks #bamboo #bamboosocks #sillysocks #softsocks #organic #organicsocks",
                "votes_up": 0,
                "votes_down": 0
            }
        },
        {
            "source": "instagram",
            "id": "964",
            "image_id": "5abcd3b87f7d8a4e6a35454d",
            "low_resolution_image_url": "//scontent.cdninstagram.com/vp/f001afc50e43edf6b7e2e38cb9c895ca/5B36862E/t51.2885-15/s320x320/e35/23160886_124566181558372_1409638653440819200_n.jpg",
            "original_image_url": "//scontent.cdninstagram.com/vp/a44f2f6086e0f5b5cf6bb0424d2f159d/5B6B676D/t51.2885-15/s640x640/sh0.08/e35/23160886_124566181558372_1409638653440819200_n.jpg",
            "image_url": "//scontent.cdninstagram.com/vp/f53655b52187f0cfe76e5d3e98036ec3/5B720C69/t51.2885-15/s150x150/e35/23160886_124566181558372_1409638653440819200_n.jpg",
            "external_media_id": "1637858085899108192_6253558014",
            "tagged_products": [],
            "post": {
                "profile_picture": "https://scontent.cdninstagram.com/vp/c808626e532371c77f1b51b26fe359d1/5B759550/t51.2885-19/22639090_349130718881132_6121542158852816896_n.jpg",
                "username": "seriouslysillysocks",
                "location_name": "",
                "created_time": "2017-10-31T16:38:40.000+00:00",
                "hashtags": [
                    "birds",
                    "gift",
                    "menssocks",
                    "thoughtsocks",
                    "crazysocks",
                    "seriouslysillysocks",
                    "bamboosocks",
                    "ducks",
                    "sockgiftbox",
                    "socks",
                    "colourfulsocks",
                    "birdwatching",
                    "giftbox",
                    "sockgift",
                    "mensbamboosocks"
                ],
                "content": "Stand out from the flock with our men's birds soft bamboo gift box! http://ow.ly/SCtE30gem0r\n\n#seriouslysillysocks #thoughtsocks #bamboosocks #birds #ducks #giftbox\n#socks #sockgiftbox #menssocks\n#mensbamboosocks #crazysocks #colourfulsocks #birdwatching #gift #sockgift  @thoughtclothing",
                "votes_up": 0,
                "votes_down": 0
            }
        },
        {
            "source": "instagram",
            "id": "224",
            "image_id": "5aac2b37505b7d2a6c529a3f",
            "low_resolution_image_url": "//scontent.cdninstagram.com/vp/1c23189602ac19d5d7df455022c675c1/5B35F9D6/t51.2885-15/e35/p320x320/27880540_185698808867751_1151779545817284608_n.jpg",
            "original_image_url": "//scontent.cdninstagram.com/vp/b44e1d034e5e7983bea7cc1663394020/5B443681/t51.2885-15/sh0.08/e35/p640x640/27880540_185698808867751_1151779545817284608_n.jpg",
            "image_url": "//scontent.cdninstagram.com/vp/2d1fc84e29d4e43b4baea67e7f35c652/5B2D5C33/t51.2885-15/s150x150/e35/c0.128.1024.1024/27880540_185698808867751_1151779545817284608_n.jpg",
            "external_media_id": "1717566428410061309_6253558014",
            "tagged_products": [
                {
                    "id": 38354657,
                    "name": "Waspish women's soft bamboo knee-high socks, sky blue | Doris & Dude",
                    "domain_key": "1902",
                    "product_link": "https://yotpo.com/go/jyyO5VXl",
                    "product_url": "http://seriouslysillysocks.com/waspish-womens-soft-bamboo-knee-high-socks-sky-blue-doris-dude/",
                    "image_url": "https://ddcfq0gxiontw.cloudfront.net/Product/38577936/31551676/square.jpg?1519115997"
                }
            ],
            "post": {
                "profile_picture": "https://scontent.cdninstagram.com/vp/135bf7f7ae221d1f96f8db7a1107938b/5B4E0850/t51.2885-19/22639090_349130718881132_6121542158852816896_n.jpg",
                "username": "seriouslysillysocks",
                "location_name": "",
                "created_time": "2018-02-18T16:04:55.000+00:00",
                "hashtags": [
                    "kneehighsocks",
                    "kneehighs",
                    "bamboosocks",
                    "seriouslysillysocks",
                    "bamboo"
                ],
                "content": "New knee high bamboo socks are in stock for spring, we love these wasp socks #bamboosocks #bamboo #kneehighsocks #kneehighs #seriouslysillysocks @dorisanddude :link in bio",
                "votes_up": 0,
                "votes_down": 0
            }
        },
        {
            "source": "instagram",
            "id": "131",
            "image_id": "5aac2c626020e429706289bc",
            "low_resolution_image_url": "//scontent.cdninstagram.com/vp/402f54c75b0b944fd26eb083f8e4a68e/5B3C0588/t51.2885-15/s320x320/e35/26871227_781566915372644_4346372539795111936_n.jpg",
            "original_image_url": "//scontent.cdninstagram.com/vp/8bb6590dd757bef5f9745188edb923c0/5B4B08CB/t51.2885-15/s640x640/sh0.08/e35/26871227_781566915372644_4346372539795111936_n.jpg",
            "image_url": "//scontent.cdninstagram.com/vp/1b798ddbffc419c1cc5429f1df6d32f9/5B286FCF/t51.2885-15/s150x150/e35/26871227_781566915372644_4346372539795111936_n.jpg",
            "external_media_id": "1698771801846791536_6253558014",
            "tagged_products": [
                {
                    "id": 26100121,
                    "name": "Black sheep men's soft bamboo crew socks in purple | By Doris & Dude",
                    "domain_key": "1563",
                    "product_link": "https://yotpo.com/go/lh20QFZL",
                    "product_url": "http://seriouslysillysocks.com/black-sheep-mens-soft-bamboo-crew-socks-in-purple-by-doris-dude/",
                    "image_url": "https://ddcfq0gxiontw.cloudfront.net/Product/26305385/19819616/square.jpg?1503591250"
                },
                {
                    "id": 16110103,
                    "name": "Black Sheep Women's Super-Soft Bamboo Crew Socks in purple | By Doris & Dude",
                    "domain_key": "1053",
                    "product_link": "https://yotpo.com/go/dG9BPDy8",
                    "product_url": "http://seriouslysillysocks.com/black-sheep-womens-super-soft-bamboo-crew-socks-in-purple-by-doris-dude/",
                    "image_url": "https://ddcfq0gxiontw.cloudfront.net/Product/16227869/11918060/square.jpg?1474478160"
                }
            ],
            "post": {
                "profile_picture": "https://scontent.cdninstagram.com/vp/135bf7f7ae221d1f96f8db7a1107938b/5B4E0850/t51.2885-19/22639090_349130718881132_6121542158852816896_n.jpg",
                "username": "seriouslysillysocks",
                "location_name": "",
                "created_time": "2018-01-23T17:43:21.000+00:00",
                "hashtags": [
                    "funnysocks",
                    "animalsocks",
                    "bamboosocks",
                    "bamboo",
                    "colourfulsocks",
                    "seriouslysillysocks",
                    "organic",
                    "organicsocks"
                ],
                "content": "We love these bamboo socks by Doris and Dude for their amusing design, sustainable materials, softness and moisture control, check out the Doris and due range here: http://ow.ly/bFo530hUlbw @dorisanddude  #seriouslysillysocks #bamboosocks #bamboo #colourfulsocks #animalsocks #funnysocks #organicsocks #organic",
                "votes_up": 0,
                "votes_down": 0
            }
        },
        {
            "source": "instagram",
            "id": "12",
            "image_id": "5aac2cc2505b7d2c84528ec3",
            "low_resolution_image_url": "//scontent.cdninstagram.com/vp/cb21a7a3583dc6b32b03899256285a5c/5B35A5B5/t51.2885-15/s320x320/e35/26158823_411519599300787_7077502871356309504_n.jpg",
            "original_image_url": "//scontent.cdninstagram.com/vp/d3cd257d77ad41f3d17e6664fd039208/5B308F97/t51.2885-15/e35/26158823_411519599300787_7077502871356309504_n.jpg",
            "image_url": "//scontent.cdninstagram.com/vp/affede7c4cafa7916c2628ec849ddbf3/5B3711F2/t51.2885-15/s150x150/e35/26158823_411519599300787_7077502871356309504_n.jpg",
            "external_media_id": "1694108497685719950_6253558014",
            "tagged_products": [
                {
                    "id": 37747167,
                    "name": "Kieran men's super-soft bamboo crew socks in green | By Thought",
                    "domain_key": "1827",
                    "product_link": "https://yotpo.com/go/klLsEUvJ",
                    "product_url": "http://seriouslysillysocks.com/kieran-mens-super-soft-bamboo-crew-socks-in-green-by-thought/",
                    "image_url": "https://ddcfq0gxiontw.cloudfront.net/Product/37970444/31131070/square.jpg?1517881670"
                }
            ],
            "post": {
                "profile_picture": "https://scontent.cdninstagram.com/vp/135bf7f7ae221d1f96f8db7a1107938b/5B4E0850/t51.2885-19/22639090_349130718881132_6121542158852816896_n.jpg",
                "username": "seriouslysillysocks",
                "location_name": "",
                "created_time": "2018-01-17T07:18:12.000+00:00",
                "hashtags": [
                    "thoughtclothing",
                    "bamboosocks",
                    "seriouslysillysocks",
                    "bamboo",
                    "colourfulsocks",
                    "stripes",
                    "stripesocks"
                ],
                "content": "Sometimes you just can't beat a classic stripe sock, see our new range of men's bamboo stripe socks by thought clothing here: http://ow.ly/8hRG30hKXMU\n#stripesocks #stripes #colourfulsocks #seriouslysillysocks #bamboosocks #bamboo #thoughtclothing @thoughtclothing",
                "votes_up": 0,
                "votes_down": 0
            }
        },
        {
            "source": "instagram",
            "id": "856",
            "image_id": "5aac2cfc6020e42ceb628c1c",
            "low_resolution_image_url": "//scontent.cdninstagram.com/vp/5f76b8df3d451cd2f20f298d444a3691/5B418B7A/t51.2885-15/s320x320/e35/26262017_579441039060574_961924588126601216_n.jpg",
            "original_image_url": "//scontent.cdninstagram.com/vp/f29530e562440ac110c7baa5ebf56032/5B3A5B33/t51.2885-15/e35/26262017_579441039060574_961924588126601216_n.jpg",
            "image_url": "//scontent.cdninstagram.com/vp/752e30061182af78bded978a9204ac2c/5B34E987/t51.2885-15/s150x150/e35/26262017_579441039060574_961924588126601216_n.jpg",
            "external_media_id": "1693408429290709337_6253558014",
            "tagged_products": [
                {
                    "id": 38022241,
                    "name": "Jemima women's soft bamboo over-the-knee socks in grey | By Thought",
                    "domain_key": "1874",
                    "product_link": "https://yotpo.com/go/rfp81T8b",
                    "product_url": "http://seriouslysillysocks.com/jemima-womens-soft-bamboo-over-the-knee-socks-in-grey-by-thought/",
                    "image_url": "https://ddcfq0gxiontw.cloudfront.net/Product/38245523/31364035/square.jpg?1518187337"
                }
            ],
            "post": {
                "profile_picture": "https://scontent.cdninstagram.com/vp/135bf7f7ae221d1f96f8db7a1107938b/5B4E0850/t51.2885-19/22639090_349130718881132_6121542158852816896_n.jpg",
                "username": "seriouslysillysocks",
                "location_name": "",
                "created_time": "2018-01-16T08:07:17.000+00:00",
                "hashtags": [
                    "colourfulsocks",
                    "bamboo",
                    "kneehighsocks",
                    "seriouslysillysocks",
                    "overkneesocks",
                    "spotsocks",
                    "spottysocks",
                    "longsocks",
                    "stripesocks",
                    "bamboosocks",
                    "kneesocks"
                ],
                "content": "Look at our new over-the-knee bamboo spot and stripe socks by Thought Clothing, see the range here: http://ow.ly/uMi630hKXto \n#kneesocks #bamboo #bamboosocks #spottysocks #spotsocks #seriouslysillysocks #colourfulsocks #kneehighsocks #overkneesocks#longsocks #stripesocks @thoughtclothing",
                "votes_up": 0,
                "votes_down": 0
            }
        },
        {
            "source": "instagram",
            "id": "670",
            "image_id": "5abcd3f17f7d8a4e903547eb",
            "low_resolution_image_url": "//scontent.cdninstagram.com/vp/561c3617a4b9917d8bad2aa8232584e2/5B745027/t51.2885-15/e35/p320x320/29096273_234228200470106_3823254632767946752_n.jpg",
            "original_image_url": "//scontent.cdninstagram.com/vp/7bcdc400c22be006b7d72018cbfb3c1a/5B745870/t51.2885-15/sh0.08/e35/p640x640/29096273_234228200470106_3823254632767946752_n.jpg",
            "image_url": "//scontent.cdninstagram.com/vp/506f461aacddefb0e38319c01ac6ec04/5B6D5858/t51.2885-15/s150x150/e35/c0.52.750.750/29096273_234228200470106_3823254632767946752_n.jpg",
            "external_media_id": "1745674913383375589_6253558014",
            "tagged_products": [
                {
                    "id": 36964896,
                    "name": "Rabbit women's super-soft bamboo crew socks in sea blue | By Thought",
                    "domain_key": "1858",
                    "product_link": "https://yotpo.com/go/adMdHSZZ",
                    "product_url": "http://seriouslysillysocks.com/rabbit-womens-super-soft-bamboo-crew-socks-in-sea-blue-by-thought/",
                    "image_url": "https://ddcfq0gxiontw.cloudfront.net/Product/37179254/30615528/square.jpg?1516152992"
                },
                {
                    "id": 36998317,
                    "name": "Rabbit women's super-soft bamboo crew socks in blueberry | By Thought",
                    "domain_key": "1855",
                    "product_link": "https://yotpo.com/go/3LRkC48t",
                    "product_url": "http://seriouslysillysocks.com/rabbit-womens-super-soft-bamboo-crew-socks-in-blueberry-by-thought/",
                    "image_url": "https://ddcfq0gxiontw.cloudfront.net/Product/37212675/30633958/square.jpg?1521098847"
                },
                {
                    "id": 36890688,
                    "name": "Rabbit women's super-soft bamboo crew socks in dark grey | By Thought",
                    "domain_key": "1857",
                    "product_link": "https://yotpo.com/go/t1auFMlO",
                    "product_url": "http://seriouslysillysocks.com/rabbit-womens-super-soft-bamboo-crew-socks-in-dark-grey-by-thought/",
                    "image_url": "https://ddcfq0gxiontw.cloudfront.net/Product/37105046/30543371/square.jpg?1515807137"
                }
            ],
            "post": {
                "profile_picture": "https://scontent.cdninstagram.com/vp/c808626e532371c77f1b51b26fe359d1/5B759550/t51.2885-19/22639090_349130718881132_6121542158852816896_n.jpg",
                "username": "seriouslysillysocks",
                "location_name": "",
                "created_time": "2018-03-29T10:51:27.000+00:00",
                "hashtags": [
                    "excited",
                    "bunnies",
                    "bamboo",
                    "easter",
                    "bunny",
                    "bamboosocks",
                    "bunnysocks"
                ],
                "content": "It's nearly easter!\nWho's excited?\n@thoughtclothing #easter #bunny #bamboosocks #bamboo #bunnies #bunnysocks #excited",
                "votes_up": 0,
                "votes_down": 0
            }
        }
    ]
}

Body Params

user
object
required
 
user.uid
string
required

max length: 32 characters

user.sid
string
required

max length: 32 characters

user.email
string
user.ip
string
user.ua
string
user.lang
array of strings
t_client
string
required
q
string

Search query

type
array of strings

Array of requested content providers

sort
array of objects

Array of sort fields

field
order
filters
array of objects

Array of filter rules

name
type
values
offset
int32
limit
int32

max = 120

callback
string
log
boolean
 

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Suggest Edits

Smart Collection API

 

Smart Collection API provides and ability to use our filters on pages other than search results.

Suggest Edits

/smart-collection/{slot}

Get the smart collections results

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api-v3.findify.io/v3/smart-collection/slot
curl --request POST \
  --url https://api-v3.findify.io/v3/smart-collection/test \
  --header "X-Key: 2e963f3e-38bd-4c00-9636-c00e48945eb7" \
  --header "Content-Type: application/json" \
  --data '{"user":{"lang":["en-GB"],"uid":"test1","sid":"ssid","email":"test@test.com","ip":"192.168.0.1","ua":"Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36"},"t_client":1484742065791,"sort":[{"field":"price","order":"desc"}],"offset":0,"limit":20,"log":false}'
//Please, don't forget to include the SDK script
//Which you can find here: https://github.com/findify/javascript-sdk

var client = FindifySDK.init({
    key: '2e963f3e-38bd-4c00-9636-c00e48945eb7',
    user: {
        uid: 'test1',
        sid: 'ssid',
      	email: 'test@test.com'
    },
    log: false
});

var request = {
    slot: 'test',
    sort: [{
        field: 'price',
        order: 'desc'
    }],
    offset: 0,
    limit: 20,
};

client.collection(request).then(function (response) {
  	console.log(response);
});
var request = require("request");
 
var options = {
    method: 'POST',
    url: 'https://api-v3.findify.io/v3/search',
  	headers: {
      "X-key": "2e963f3e-38bd-4c00-9636-c00e48945eb7"
    },
    body: {
        user: {
            lang: ['en-GB'],
            uid: 'test1',
            sid: 'ssid',
            email: 'test@test.com',
            ip: '192.168.0.1',
            ua: 'Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36'
        },
        q: '1484742065791',
        t_client: 1484742065791,
        filters: [{
                name: 'category1',
                type: 'category',
                values: [{"value": "Dog Food"}]
            }
        ],
        sort: [{
            field: 'price',
            order: 'desc'
        }],
        offset: 0,
        limit: 20,
        log: false
    },
    json: true
};

request(options, function(error, response, body) {
    if (error) throw new Error(error);

    console.log(body);
})
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Key', '2e963f3e-38bd-4c00-9636-c00e48945eb7');

$api_instance = new Swagger\Client\Api\DefaultApi();
$collection   = new \Swagger\Client\Model\CollectionRequest(array(
    'user' => array(
        'uid' => 'test1',
        'sid' => 'ssid',
        'email' => 'test@test.com',
        'ip' => '192.168.0.1',
        'ua' => 'Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36',
        'lang' => array(
            'en-US',
            'en-GB',
            'no'
        )
    ),
    't_client' => '1484741395471',
    'offset' => 0,
    'limit' => 20,
    'log' => false
));

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

?>
A binary file was returned

You couldn't be authenticated

{
  "meta": {
    "no_result": true,
    "corrected_q": "canine",
    "q": "canin",
    "offset": 0,
    "limit": 20,
    "total": 20,
    "filters": [],
    "sort": [],
    "rid": "s-9fcc881c-1420-4e57-bc58-e234829c363c"
  },
  "facets": [
    {
      "name": "category",
      "type": "category",
      "values": [
        {
          "selected": false,
          "count": 17,
          "has_children": false,
          "value": "Dog Food",
          "name": "category1"
        },
        {
          "selected": false,
          "count": 3,
          "has_children": false,
          "value": "Canned Dog Food",
          "name": "category1"
        }
      ],
      "sort_type": "count"
    },
    {
      "name": "brand",
      "values": [
        {
          "count": 20,
          "has_children": false,
          "name": "brand",
          "value": "Hill's",
          "selected": false
        }
      ],
      "type": "text",
      "sort_type": "count"
    },
    {
      "name": "price",
      "values": [
        {
          "name": "price",
          "count": 7,
          "value": "_20",
          "has_children": false,
          "to": 20,
          "selected": false
        },
        {
          "name": "price",
          "count": 11,
          "value": "20_40",
          "has_children": false,
          "from": 20,
          "to": 40,
          "selected": false
        },
        {
          "name": "price",
          "count": 10,
          "value": "40_50",
          "has_children": false,
          "from": 40,
          "to": 50,
          "selected": false
        },
        {
          "name": "price",
          "count": 13,
          "value": "50_",
          "has_children": false,
          "from": 50,
          "selected": false
        }
      ],
      "type": "range",
      "min": 16.75,
      "max": 81.99,
      "sort_type": "value"
    },
    {
      "name": "tags",
      "values": [
        {
          "count": 20,
          "has_children": false,
          "name": "tags",
          "value": "Dog",
          "selected": false
        },
        {
          "count": 15,
          "has_children": false,
          "name": "tags",
          "value": "Small Breed",
          "selected": false
        },
        {
          "count": 13,
          "has_children": false,
          "name": "tags",
          "value": "Medium Breed",
          "selected": false
        },
        {
          "count": 12,
          "has_children": false,
          "name": "tags",
          "value": "Adult",
          "selected": false
        },
        {
          "count": 12,
          "has_children": false,
          "name": "tags",
          "value": "Giant Breed",
          "selected": false
        },
        {
          "count": 12,
          "has_children": false,
          "name": "tags",
          "value": "Large Breed",
          "selected": false
        },
        {
          "count": 12,
          "has_children": false,
          "name": "tags",
          "value": "Puppy",
          "selected": false
        },
        {
          "count": 2,
          "has_children": false,
          "name": "tags",
          "value": "Old",
          "selected": false
        }
      ],
      "type": "text",
      "sort_type": "count"
    }
  ],
  "items": [
    {
      "seller": "",
      "short_description": "",
      "product_url": "http://findify-demo-store.myshopify.com/products/hills-canine-vetessentials-adult",
      "color": [],
      "variants_ids": [
        "20493959751",
        "20493959879"
      ],
      "image_2_url": "",
      "description": "Pienso para Dogs - Telepienso",
      "discount": [
        17
      ],
      "created_at": "2016-05-06T08:48:41.000Z",
      "availability": true,
      "delivery_time": "",
      "variants": [],
      "title": "Hill's Canine Vetessentials Adult",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/hills_vetessentials_canine_adult_small.jpeg?v=1462524521",
      "price": [
        16.75,
        51.4
      ],
      "stickers": {
        "discount": [
          17
        ],
        "availability": true,
        "in-stock": false,
        "out-of-stock": false,
        "free-shipping": false
      },
      "id": "6411340167",
      "sku": [
        "53743859309",
        "53743855308"
      ],
      "brand": "Hill's",
      "quantity": -1,
      "color_variants": 1,
      "shipping_cost": "",
      "image_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/hills_vetessentials_canine_adult_medium.jpeg?v=1462524521",
      "custom_fields": {},
      "rating_score": -1,
      "tags": [
        "Dog"
      ],
      "condition": "",
      "product_type": "",
      "material": [],
      "size": [],
      "shipping_weight": "",
      "category": [
        {
          "category2": "",
          "category3": "",
          "category4": "",
          "category1": "Dog Food"
        }
      ],
      "compare_at": -1
    },
    {
      "seller": "",
      "short_description": "",
      "product_url": "http://findify-demo-store.myshopify.com/products/hills-canine-vetessentials-adult-mini",
      "color": [],
      "variants_ids": [
        "20493960263",
        "20493960327"
      ],
      "image_2_url": "",
      "description": "Pienso para Dogs - Telepienso",
      "discount": [
        17
      ],
      "created_at": "2016-05-06T08:48:42.000Z",
      "availability": true,
      "delivery_time": "",
      "variants": [],
      "title": "Hill's Canine Vetessentials Adult Mini",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/hills_vetessentials_canine_adult_mini_small.jpeg?v=1462524522",
      "price": [
        16.75,
        45.68
      ],
      "stickers": {
        "discount": [
          17
        ],
        "availability": true,
        "in-stock": false,
        "out-of-stock": false,
        "free-shipping": false
      },
      "id": "6411340615",
      "sku": [
        "53743900001",
        "53743900309"
      ],
      "brand": "Hill's",
      "quantity": -1,
      "color_variants": 1,
      "shipping_cost": "",
      "image_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/hills_vetessentials_canine_adult_mini_medium.jpeg?v=1462524522",
      "custom_fields": {},
      "rating_score": -1,
      "tags": [
        "Adult",
        "Dog",
        "Small Breed"
      ],
      "condition": "",
      "product_type": "",
      "material": [],
      "size": [],
      "shipping_weight": "",
      "category": [
        {
          "category2": "",
          "category3": "",
          "category4": "",
          "category1": "Dog Food"
        }
      ],
      "compare_at": -1
    },
    {
      "seller": "",
      "short_description": "",
      "product_url": "http://findify-demo-store.myshopify.com/products/hills-canine-vetessentials-mature-adult",
      "color": [],
      "variants_ids": [
        "20493960455",
        "20493960583"
      ],
      "image_2_url": "",
      "description": "Pienso para Dogs - Telepienso",
      "discount": [
        17
      ],
      "created_at": "2016-05-06T08:48:43.000Z",
      "availability": true,
      "delivery_time": "",
      "variants": [],
      "title": "Hill's Canine Vetessentials Mature Adult",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/hills_vetessentials_canine_mature_adult_small.jpeg?v=1462524523",
      "price": [
        18.38,
        55.34
      ],
      "stickers": {
        "discount": [
          17
        ],
        "availability": true,
        "in-stock": false,
        "out-of-stock": false,
        "free-shipping": false
      },
      "id": "6411340743",
      "sku": [
        "53743859308",
        "53743855505"
      ],
      "brand": "Hill's",
      "quantity": 1,
      "color_variants": 1,
      "shipping_cost": "",
      "image_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/hills_vetessentials_canine_mature_adult_medium.jpeg?v=1462524523",
      "custom_fields": {},
      "rating_score": -1,
      "tags": [
        "Dog"
      ],
      "condition": "",
      "product_type": "",
      "material": [],
      "size": [],
      "shipping_weight": "",
      "category": [
        {
          "category2": "",
          "category3": "",
          "category4": "",
          "category1": "Dog Food"
        }
      ],
      "compare_at": -1
    },
    {
      "seller": "",
      "short_description": "",
      "product_url": "http://findify-demo-store.myshopify.com/products/hills-canine-vetessentials-mature-adult-mini",
      "color": [],
      "variants_ids": [
        "20493961031",
        "20493961095"
      ],
      "image_2_url": "",
      "description": "Pienso para Dogs - Telepienso",
      "discount": [
        17
      ],
      "created_at": "2016-05-06T08:48:44.000Z",
      "availability": true,
      "delivery_time": "",
      "variants": [],
      "title": "Hill's Canine Vetessentials Mature Adult Mini",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/hills_vetessentials_mature_adult_mini_small.jpeg?v=1462524524",
      "price": [
        18.38,
        49.98
      ],
      "stickers": {
        "discount": [
          17
        ],
        "availability": true,
        "in-stock": false,
        "out-of-stock": false,
        "free-shipping": false
      },
      "id": "6411341127",
      "sku": [
        "53743900100",
        "53743900308"
      ],
      "brand": "Hill's",
      "quantity": 1,
      "color_variants": 1,
      "shipping_cost": "",
      "image_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/hills_vetessentials_mature_adult_mini_medium.jpeg?v=1462524524",
      "custom_fields": {},
      "rating_score": -1,
      "tags": [
        "Dog",
        "Old",
        "Small Breed"
      ],
      "condition": "",
      "product_type": "",
      "material": [],
      "size": [],
      "shipping_weight": "",
      "category": [
        {
          "category2": "",
          "category3": "",
          "category4": "",
          "category1": "Dog Food"
        }
      ],
      "compare_at": -1
    },
    {
      "seller": "",
      "short_description": "",
      "product_url": "http://findify-demo-store.myshopify.com/products/hills-prescription-diet-canine-a-d-humedo",
      "color": [],
      "variants_ids": [
        "20493973063"
      ],
      "image_2_url": "",
      "description": "Pienso para Dogs - Telepienso",
      "discount": [
        4
      ],
      "created_at": "2016-05-06T08:49:08.000Z",
      "availability": true,
      "delivery_time": "",
      "variants": [],
      "title": "Hill's Prescription Diet Canine a/d húmedo",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_a_d_small.jpeg?v=1462524548",
      "price": [
        58.13
      ],
      "stickers": {
        "discount": [
          4
        ],
        "availability": true,
        "in-stock": false,
        "out-of-stock": false,
        "free-shipping": false
      },
      "id": "6411349575",
      "sku": [
        "53743557005"
      ],
      "brand": "Hill's",
      "quantity": -1,
      "color_variants": 1,
      "shipping_cost": "",
      "image_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_a_d_medium.jpeg?v=1462524548",
      "custom_fields": {},
      "rating_score": -1,
      "tags": [
        "Adult",
        "Dog",
        "Giant Breed",
        "Large Breed",
        "Medium Breed",
        "Puppy",
        "Small Breed"
      ],
      "condition": "",
      "product_type": "",
      "material": [],
      "size": [],
      "shipping_weight": "",
      "category": [
        {
          "category2": "",
          "category3": "",
          "category4": "",
          "category1": "Canned Dog Food"
        }
      ],
      "compare_at": 60.56
    },
    {
      "seller": "",
      "short_description": "",
      "product_url": "http://findify-demo-store.myshopify.com/products/hills-prescription-diet-b-d",
      "color": [],
      "variants_ids": [
        "20493973255"
      ],
      "image_2_url": "",
      "description": "Pienso para Dogs - Telepienso",
      "discount": [
        4
      ],
      "created_at": "2016-05-06T08:49:09.000Z",
      "availability": true,
      "delivery_time": "",
      "variants": [],
      "title": "Hill's Prescription Diet Canine b/d",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/Hills_Prescription_Diet_Canine_b_d_small.jpeg?v=1462524549",
      "price": [
        42.23
      ],
      "stickers": {
        "discount": [
          4
        ],
        "availability": true,
        "in-stock": false,
        "out-of-stock": false,
        "free-shipping": false
      },
      "id": "6411349767",
      "sku": [
        "53743954103"
      ],
      "brand": "Hill's",
      "quantity": 1,
      "color_variants": 1,
      "shipping_cost": "",
      "image_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/Hills_Prescription_Diet_Canine_b_d_medium.jpeg?v=1462524549",
      "custom_fields": {},
      "rating_score": -1,
      "tags": [
        "Dog",
        "Giant Breed",
        "Large Breed",
        "Medium Breed",
        "Old",
        "Small Breed"
      ],
      "condition": "",
      "product_type": "",
      "material": [],
      "size": [],
      "shipping_weight": "",
      "category": [
        {
          "category2": "",
          "category3": "",
          "category4": "",
          "category1": "Dog Food"
        }
      ],
      "compare_at": 43.98
    },
    {
      "seller": "",
      "short_description": "",
      "product_url": "http://findify-demo-store.myshopify.com/products/hill-s-prescription-diet-canine-c-d",
      "color": [],
      "variants_ids": [
        "20493973575",
        "20493973639",
        "20493973703"
      ],
      "image_2_url": "",
      "description": "Pienso para Dogs - Telepienso",
      "discount": [
        3,
        4
      ],
      "created_at": "2016-05-06T08:49:10.000Z",
      "availability": true,
      "delivery_time": "",
      "variants": [],
      "title": "Hill's Prescription Diet Canine c/d",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_c_d_small.jpeg?v=1462524550",
      "price": [
        18.33,
        38.1,
        72.62
      ],
      "stickers": {
        "discount": [
          4,
          3
        ],
        "availability": true,
        "in-stock": false,
        "out-of-stock": false,
        "free-shipping": false
      },
      "id": "6411350087",
      "sku": [
        "53743855409",
        "53743434309",
        "53743917503"
      ],
      "brand": "Hill's",
      "quantity": 1,
      "color_variants": 1,
      "shipping_cost": "",
      "image_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_c_d_medium.jpeg?v=1462524550",
      "custom_fields": {},
      "rating_score": -1,
      "tags": [
        "Dog",
        "Giant Breed",
        "Large Breed",
        "Medium Breed",
        "Small Breed"
      ],
      "condition": "",
      "product_type": "",
      "material": [],
      "size": [],
      "shipping_weight": "",
      "category": [
        {
          "category2": "",
          "category3": "",
          "category4": "",
          "category1": "Dog Food"
        }
      ],
      "compare_at": -1
    },
    {
      "seller": "",
      "short_description": "",
      "product_url": "http://findify-demo-store.myshopify.com/products/hill-s-prescription-diet-canine-d-d-huevo-y-arroz",
      "color": [],
      "variants_ids": [
        "20493973895",
        "20493973959",
        "20493974023"
      ],
      "image_2_url": "",
      "description": "Pienso para Dogs - Telepienso",
      "discount": [
        4
      ],
      "created_at": "2016-05-06T08:49:11.000Z",
      "availability": true,
      "delivery_time": "",
      "variants": [],
      "title": "Hill's Prescription Diet Canine d/d Huevo y Arroz",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_d_d_egg_rice_small.jpeg?v=1462524551",
      "price": [
        22.97,
        44.91,
        81.99
      ],
      "stickers": {
        "discount": [
          4
        ],
        "availability": true,
        "in-stock": false,
        "out-of-stock": false,
        "free-shipping": false
      },
      "id": "6411350279",
      "sku": [
        "53743911105",
        "53743911305",
        "53743917703"
      ],
      "brand": "Hill's",
      "quantity": 1,
      "color_variants": 1,
      "shipping_cost": "",
      "image_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_d_d_egg_rice_medium.jpeg?v=1462524551",
      "custom_fields": {},
      "rating_score": -1,
      "tags": [
        "Adult",
        "Dog",
        "Giant Breed",
        "Large Breed",
        "Medium Breed",
        "Puppy",
        "Small Breed"
      ],
      "condition": "",
      "product_type": "",
      "material": [],
      "size": [],
      "shipping_weight": "",
      "category": [
        {
          "category2": "",
          "category3": "",
          "category4": "",
          "category1": "Dog Food"
        }
      ],
      "compare_at": -1
    },
    {
      "seller": "",
      "short_description": "",
      "product_url": "http://findify-demo-store.myshopify.com/products/hill-s-prescription-diet-canine-d-d-pato-y-arroz",
      "color": [],
      "variants_ids": [
        "20493974407",
        "20493974471",
        "20493974535"
      ],
      "image_2_url": "",
      "description": "Pienso para Dogs - Telepienso",
      "discount": [
        4
      ],
      "created_at": "2016-05-06T08:49:12.000Z",
      "availability": true,
      "delivery_time": "",
      "variants": [],
      "title": "Hill's Prescription Diet Canine d/d Pato y Arroz",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_d_d_pato_arroz_small.jpeg?v=1462524552",
      "price": [
        22.97,
        44.91,
        81.99
      ],
      "stickers": {
        "discount": [
          4
        ],
        "availability": true,
        "in-stock": false,
        "out-of-stock": false,
        "free-shipping": false
      },
      "id": "6411350599",
      "sku": [
        "53743911700",
        "53743911809",
        "53743917900"
      ],
      "brand": "Hill's",
      "quantity": 1,
      "color_variants": 1,
      "shipping_cost": "",
      "image_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_d_d_pato_arroz_medium.jpeg?v=1462524552",
      "custom_fields": {},
      "rating_score": -1,
      "tags": [
        "Adult",
        "Dog",
        "Giant Breed",
        "Large Breed",
        "Medium Breed",
        "Puppy",
        "Small Breed"
      ],
      "condition": "",
      "product_type": "",
      "material": [],
      "size": [],
      "shipping_weight": "",
      "category": [
        {
          "category2": "",
          "category3": "",
          "category4": "",
          "category1": "Dog Food"
        }
      ],
      "compare_at": -1
    },
    {
      "seller": "",
      "short_description": "",
      "product_url": "http://findify-demo-store.myshopify.com/products/hill-s-prescription-diet-canine-d-d-salmon-y-arroz",
      "color": [],
      "variants_ids": [
        "20493976135",
        "20493976263",
        "20493976327"
      ],
      "image_2_url": "",
      "description": "Pienso para Dogs - Telepienso",
      "discount": [
        4
      ],
      "created_at": "2016-05-06T08:49:13.000Z",
      "availability": true,
      "delivery_time": "",
      "variants": [],
      "title": "Hill's Prescription Diet Canine d/d Salmón y Arroz",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_d_d_salmon_arroz_small.jpeg?v=1462524553",
      "price": [
        22.97,
        44.91,
        81.99
      ],
      "stickers": {
        "discount": [
          4
        ],
        "availability": true,
        "in-stock": false,
        "out-of-stock": false,
        "free-shipping": false
      },
      "id": "6411351239",
      "sku": [
        "53743911403",
        "53743911503",
        "53743917801"
      ],
      "brand": "Hill's",
      "quantity": -1,
      "color_variants": 1,
      "shipping_cost": "",
      "image_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_d_d_salmon_arroz_medium.jpeg?v=1462524553",
      "custom_fields": {},
      "rating_score": -1,
      "tags": [
        "Adult",
        "Dog",
        "Giant Breed",
        "Large Breed",
        "Medium Breed",
        "Puppy",
        "Small Breed"
      ],
      "condition": "",
      "product_type": "",
      "material": [],
      "size": [],
      "shipping_weight": "",
      "category": [
        {
          "category2": "",
          "category3": "",
          "category4": "",
          "category1": "Dog Food"
        }
      ],
      "compare_at": -1
    },
    {
      "seller": "",
      "short_description": "",
      "product_url": "http://findify-demo-store.myshopify.com/products/hills-prescription-diet-canine-h-d",
      "color": [],
      "variants_ids": [
        "20493976519"
      ],
      "image_2_url": "",
      "description": "Pienso para Dogs - Telepienso",
      "discount": [
        4
      ],
      "created_at": "2016-05-06T08:49:14.000Z",
      "availability": true,
      "delivery_time": "",
      "variants": [],
      "title": "Hill's Prescription Diet Canine h/d",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_h_d_small.jpeg?v=1462524554",
      "price": [
        43.05
      ],
      "stickers": {
        "discount": [
          4
        ],
        "availability": true,
        "in-stock": false,
        "out-of-stock": false,
        "free-shipping": false
      },
      "id": "6411351495",
      "sku": [
        "53743435701"
      ],
      "brand": "Hill's",
      "quantity": 1,
      "color_variants": 1,
      "shipping_cost": "",
      "image_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_h_d_medium.jpeg?v=1462524554",
      "custom_fields": {},
      "rating_score": -1,
      "tags": [
        "Adult",
        "Dog",
        "Giant Breed",
        "Large Breed",
        "Medium Breed",
        "Puppy",
        "Small Breed"
      ],
      "condition": "",
      "product_type": "",
      "material": [],
      "size": [],
      "shipping_weight": "",
      "category": [
        {
          "category2": "",
          "category3": "",
          "category4": "",
          "category1": "Dog Food"
        }
      ],
      "compare_at": 44.81
    },
    {
      "seller": "",
      "short_description": "",
      "product_url": "http://findify-demo-store.myshopify.com/products/hill-s-prescription-diet-canine-i-d-1",
      "color": [],
      "variants_ids": [
        "20493976775",
        "20493976839",
        "20493976903"
      ],
      "image_2_url": "",
      "description": "Pienso para Dogs - Telepienso",
      "discount": [
        4,
        7
      ],
      "created_at": "2016-05-06T08:49:15.000Z",
      "availability": true,
      "delivery_time": "",
      "variants": [],
      "title": "Hill's Prescription Diet Canine i/d",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_i_d_1_small.jpeg?v=1462524555",
      "price": [
        18.33,
        39.66,
        71.89
      ],
      "stickers": {
        "discount": [
          7,
          4
        ],
        "availability": true,
        "in-stock": false,
        "out-of-stock": false,
        "free-shipping": false
      },
      "id": "6411351815",
      "sku": [
        "53743855301",
        "53743431505",
        "53743918105"
      ],
      "brand": "Hill's",
      "quantity": -1,
      "color_variants": 1,
      "shipping_cost": "",
      "image_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_i_d_1_medium.jpeg?v=1462524555",
      "custom_fields": {},
      "rating_score": -1,
      "tags": [
        "Dog"
      ],
      "condition": "",
      "product_type": "",
      "material": [],
      "size": [],
      "shipping_weight": "",
      "category": [
        {
          "category2": "",
          "category3": "",
          "category4": "",
          "category1": "Dog Food"
        }
      ],
      "compare_at": -1
    },
    {
      "seller": "",
      "short_description": "",
      "product_url": "http://findify-demo-store.myshopify.com/products/hills-prescription-diet-canine-j-d",
      "color": [],
      "variants_ids": [
        "20493978119",
        "20493978247",
        "20493978311"
      ],
      "image_2_url": "",
      "description": "Pienso para Dogs - Telepienso",
      "discount": [
        4,
        8
      ],
      "created_at": "2016-05-06T08:49:16.000Z",
      "availability": true,
      "delivery_time": "",
      "variants": [],
      "title": "Hill's Prescription Diet Canine j/d",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_j_d_small.jpeg?v=1462524556",
      "price": [
        20.86,
        38.88,
        72.89
      ],
      "stickers": {
        "discount": [
          8,
          4
        ],
        "availability": true,
        "in-stock": false,
        "out-of-stock": false,
        "free-shipping": false
      },
      "id": "6411352071",
      "sku": [
        "53743451503",
        "53743453303",
        "53743918303"
      ],
      "brand": "Hill's",
      "quantity": -1,
      "color_variants": 1,
      "shipping_cost": "",
      "image_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_j_d_medium.jpeg?v=1462524556",
      "custom_fields": {},
      "rating_score": -1,
      "tags": [
        "Adult",
        "Dog",
        "Giant Breed",
        "Large Breed",
        "Medium Breed",
        "Puppy"
      ],
      "condition": "",
      "product_type": "",
      "material": [],
      "size": [],
      "shipping_weight": "",
      "category": [
        {
          "category2": "",
          "category3": "",
          "category4": "",
          "category1": "Dog Food"
        }
      ],
      "compare_at": -1
    },
    {
      "seller": "",
      "short_description": "",
      "product_url": "http://findify-demo-store.myshopify.com/products/hills-prescription-diet-canine-j-d-mini",
      "color": [],
      "variants_ids": [
        "20493978503",
        "20493978567"
      ],
      "image_2_url": "",
      "description": "Pienso para Dogs - Telepienso",
      "discount": [
        4
      ],
      "created_at": "2016-05-06T08:49:16.000Z",
      "availability": true,
      "delivery_time": "",
      "variants": [],
      "title": "Hill's Prescription Diet Canine j/d Mini",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_j_d_mini_small.jpeg?v=1462524556",
      "price": [
        20.86,
        38.88
      ],
      "stickers": {
        "discount": [
          4
        ],
        "availability": true,
        "in-stock": false,
        "out-of-stock": false,
        "free-shipping": false
      },
      "id": "6411352327",
      "sku": [
        "53743805703",
        "53743805801"
      ],
      "brand": "Hill's",
      "quantity": 1,
      "color_variants": 1,
      "shipping_cost": "",
      "image_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_j_d_mini_medium.jpeg?v=1462524556",
      "custom_fields": {},
      "rating_score": -1,
      "tags": [
        "Adult",
        "Dog",
        "Puppy",
        "Small Breed"
      ],
      "condition": "",
      "product_type": "",
      "material": [],
      "size": [],
      "shipping_weight": "",
      "category": [
        {
          "category2": "",
          "category3": "",
          "category4": "",
          "category1": "Dog Food"
        }
      ],
      "compare_at": -1
    },
    {
      "seller": "",
      "short_description": "",
      "product_url": "http://findify-demo-store.myshopify.com/products/hills-prescription-diet-canine-j-d-reduced-calorie",
      "color": [],
      "variants_ids": [
        "20493978951",
        "20493979015"
      ],
      "image_2_url": "",
      "description": "Pienso para Dogs - Telepienso",
      "discount": [
        4
      ],
      "created_at": "2016-05-06T08:49:17.000Z",
      "availability": true,
      "delivery_time": "",
      "variants": [],
      "title": "Hill's Prescription Diet Canine j/d Reduced Calorie",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_j_d_reduced_calorie_small.jpeg?v=1462524557",
      "price": [
        34.25,
        80.08
      ],
      "stickers": {
        "discount": [
          4
        ],
        "availability": true,
        "in-stock": false,
        "out-of-stock": false,
        "free-shipping": false
      },
      "id": "6411352711",
      "sku": [
        "53743514007",
        "53743513901"
      ],
      "brand": "Hill's",
      "quantity": -1,
      "color_variants": 1,
      "shipping_cost": "",
      "image_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_j_d_reduced_calorie_medium.jpeg?v=1462524557",
      "custom_fields": {},
      "rating_score": -1,
      "tags": [
        "Dog"
      ],
      "condition": "",
      "product_type": "",
      "material": [],
      "size": [],
      "shipping_weight": "",
      "category": [
        {
          "category2": "",
          "category3": "",
          "category4": "",
          "category1": "Dog Food"
        }
      ],
      "compare_at": -1
    },
    {
      "seller": "",
      "short_description": "",
      "product_url": "http://findify-demo-store.myshopify.com/products/hills-prescription-diet-canine-k-d",
      "color": [],
      "variants_ids": [
        "20493979207",
        "20493979271",
        "20493979335"
      ],
      "image_2_url": "",
      "description": "Pienso para Dogs - Telepienso",
      "discount": [
        4
      ],
      "created_at": "2016-05-06T08:49:18.000Z",
      "availability": true,
      "delivery_time": "",
      "variants": [],
      "title": "Hill's Prescription Diet Canine k/d",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_k_d_small.jpeg?v=1462524558",
      "price": [
        18.29,
        39.5,
        74.11
      ],
      "stickers": {
        "discount": [
          4
        ],
        "availability": true,
        "in-stock": false,
        "out-of-stock": false,
        "free-shipping": false
      },
      "id": "6411352903",
      "sku": [
        "53743855805",
        "53743435401",
        "53743918304"
      ],
      "brand": "Hill's",
      "quantity": 1,
      "color_variants": 1,
      "shipping_cost": "",
      "image_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_k_d_medium.jpeg?v=1462524558",
      "custom_fields": {},
      "rating_score": -1,
      "tags": [
        "Adult",
        "Dog",
        "Giant Breed",
        "Large Breed",
        "Medium Breed",
        "Puppy",
        "Small Breed"
      ],
      "condition": "",
      "product_type": "",
      "material": [],
      "size": [],
      "shipping_weight": "",
      "category": [
        {
          "category2": "",
          "category3": "",
          "category4": "",
          "category1": "Dog Food"
        }
      ],
      "compare_at": -1
    },
    {
      "seller": "",
      "short_description": "",
      "product_url": "http://findify-demo-store.myshopify.com/products/hills-prescription-diet-canine-k-d-humedo",
      "color": [],
      "variants_ids": [
        "20493979463"
      ],
      "image_2_url": "",
      "description": "Pienso para Dogs - Telepienso",
      "discount": [
        4
      ],
      "created_at": "2016-05-06T08:49:18.000Z",
      "availability": true,
      "delivery_time": "",
      "variants": [],
      "title": "Hill's Prescription Diet Canine k/d húmedo",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_k_d_lata_small.jpeg?v=1462524558",
      "price": [
        37.97
      ],
      "stickers": {
        "discount": [
          4
        ],
        "availability": true,
        "in-stock": false,
        "out-of-stock": false,
        "free-shipping": false
      },
      "id": "6411353031",
      "sku": [
        "53743801101"
      ],
      "brand": "Hill's",
      "quantity": -1,
      "color_variants": 1,
      "shipping_cost": "",
      "image_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_k_d_lata_medium.jpeg?v=1462524558",
      "custom_fields": {},
      "rating_score": -1,
      "tags": [
        "Adult",
        "Dog",
        "Giant Breed",
        "Large Breed",
        "Medium Breed",
        "Puppy",
        "Small Breed"
      ],
      "condition": "",
      "product_type": "",
      "material": [],
      "size": [],
      "shipping_weight": "",
      "category": [
        {
          "category2": "",
          "category3": "",
          "category4": "",
          "category1": "Canned Dog Food"
        }
      ],
      "compare_at": 39.55
    },
    {
      "seller": "",
      "short_description": "",
      "product_url": "http://findify-demo-store.myshopify.com/products/hills-prescription-diet-canine-l-d",
      "color": [],
      "variants_ids": [
        "20493979719",
        "20493979783",
        "20493979911"
      ],
      "image_2_url": "",
      "description": "Pienso para Dogs - Telepienso",
      "discount": [
        4
      ],
      "created_at": "2016-05-06T08:49:19.000Z",
      "availability": true,
      "delivery_time": "",
      "variants": [],
      "title": "Hill's Prescription Diet Canine L/d",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_l_d_small.jpeg?v=1462524559",
      "price": [
        20.86,
        43.05,
        78.85
      ],
      "stickers": {
        "discount": [
          4
        ],
        "availability": true,
        "in-stock": false,
        "out-of-stock": false,
        "free-shipping": false
      },
      "id": "6411353287",
      "sku": [
        "53743855000",
        "53743733905",
        "53743855901"
      ],
      "brand": "Hill's",
      "quantity": -1,
      "color_variants": 1,
      "shipping_cost": "",
      "image_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_l_d_medium.jpeg?v=1462524559",
      "custom_fields": {},
      "rating_score": -1,
      "tags": [
        "Adult",
        "Dog",
        "Giant Breed",
        "Large Breed",
        "Medium Breed",
        "Puppy",
        "Small Breed"
      ],
      "condition": "",
      "product_type": "",
      "material": [],
      "size": [],
      "shipping_weight": "",
      "category": [
        {
          "category2": "",
          "category3": "",
          "category4": "",
          "category1": "Dog Food"
        }
      ],
      "compare_at": -1
    },
    {
      "seller": "",
      "short_description": "",
      "product_url": "http://findify-demo-store.myshopify.com/products/hills-prescription-diet-canine-l-d-humedo",
      "color": [],
      "variants_ids": [
        "20493980231"
      ],
      "image_2_url": "",
      "description": "Pienso para Dogs - Telepienso",
      "discount": [
        4
      ],
      "created_at": "2016-05-06T08:49:19.000Z",
      "availability": true,
      "delivery_time": "",
      "variants": [],
      "title": "Hill's Prescription Diet Canine l/d húmedo",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_l_d_lata_small.jpeg?v=1462524559",
      "price": [
        40.33
      ],
      "stickers": {
        "discount": [
          4
        ],
        "availability": true,
        "in-stock": false,
        "out-of-stock": false,
        "free-shipping": false
      },
      "id": "6411353671",
      "sku": [
        "53743801100"
      ],
      "brand": "Hill's",
      "quantity": -1,
      "color_variants": 1,
      "shipping_cost": "",
      "image_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_l_d_lata_medium.jpeg?v=1462524559",
      "custom_fields": {},
      "rating_score": -1,
      "tags": [
        "Adult",
        "Dog",
        "Giant Breed",
        "Large Breed",
        "Medium Breed",
        "Puppy",
        "Small Breed"
      ],
      "condition": "",
      "product_type": "",
      "material": [],
      "size": [],
      "shipping_weight": "",
      "category": [
        {
          "category2": "",
          "category3": "",
          "category4": "",
          "category1": "Canned Dog Food"
        }
      ],
      "compare_at": 42.02
    },
    {
      "seller": "",
      "short_description": "",
      "product_url": "http://findify-demo-store.myshopify.com/products/hill-s-prescription-diet-p-d",
      "color": [],
      "variants_ids": [
        "20493980743",
        "20493980807"
      ],
      "image_2_url": "",
      "description": "Pienso para Dogs - Telepienso",
      "discount": [
        4
      ],
      "created_at": "2016-05-06T08:49:21.000Z",
      "availability": true,
      "delivery_time": "",
      "variants": [],
      "title": "Hill's Prescription Diet Canine p/d",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/hills-prescription-diet-canine-p-djpeg_small.jpeg?v=1462524561",
      "price": [
        42.23,
        78.9
      ],
      "stickers": {
        "discount": [
          4
        ],
        "availability": true,
        "in-stock": false,
        "out-of-stock": false,
        "free-shipping": false
      },
      "id": "6411354119",
      "sku": [
        "53743437003",
        "53743857700"
      ],
      "brand": "Hill's",
      "quantity": 1,
      "color_variants": 1,
      "shipping_cost": "",
      "image_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/hills-prescription-diet-canine-p-djpeg_medium.jpeg?v=1462524561",
      "custom_fields": {},
      "rating_score": -1,
      "tags": [
        "Dog",
        "Medium Breed",
        "Puppy",
        "Small Breed"
      ],
      "condition": "",
      "product_type": "",
      "material": [],
      "size": [],
      "shipping_weight": "",
      "category": [
        {
          "category2": "",
          "category3": "",
          "category4": "",
          "category1": "Dog Food"
        }
      ],
      "compare_at": -1
    }
  ],
  "banner": {}
}
{
  "error": {
    "message": "You should provide Findify API Key"
  }
}
{
  "meta": {
    "no_result": true,
    "corrected_q": "canine",
    "q": "canin",
    "offset": 0,
    "limit": 20,
    "total": 20,
    "filters": [],
    "sort": [],
    "rid": "s-9fcc881c-1420-4e57-bc58-e234829c363c"
  },
  "facets": [],
  "items": [],
  "redirect": {
  	"name": "/collection-slot",
    "url": "/collection-slot"
  },
  "banner": {}
}

Path Params

slot
string
required

Collection handle

Body Params

t_client
date-time
required
user
object
required
 
user.uid
string
required

max length: 32 characters

user.sid
string
required

max length: 32 characters

user.email
string
user.ip
string
user.ua
string
user.lang
array of strings
sort
array of objects
field
order
filters
array of objects
name
type
values
offset
int32
limit
int32

max = 120

callback
string
log
boolean
rules
array of objects
action
type
name
values
 

Get the complete smart collection results. This is similar to a search query.

Suggest Edits

Recommendation API

 

Recommendation API provides a set of routes to access different types of recommendations

Suggest Edits

/recommend/{slot}

Get recommendation using pre-configured slot. The slot configuration is available in the Merchant Dashboard. The benefit of using slot is that we calculate CTR and other parameters for each slot and can give you analytics on each recommendation slot.

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api-v3.findify.io/v3/recommend/slot
curl --request POST \
  --url https://api-v3.findify.io/v3/recommend/findify-home-rec-1 \
  --header "X-Key: 2e963f3e-38bd-4c00-9636-c00e48945eb7" \
  --header "Content-Type: application/json" \
  --data '{"user":{"lang":["en-GB"],"uid":"test1","sid":"ssid","email":"test@test.com","ip":"192.168.0.1","ua":"Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36"},"t_client":1484742065791,"offset":0,"log":false}'
//Please, don't forget to include the SDK script
//Which you can find here: https://github.com/findify/javascript-sdk

var client = FindifySDK.init({
    key: '2e963f3e-38bd-4c00-9636-c00e48945eb7',
    user: {
        uid: 'test1',
        sid: 'ssid',
      	email: 'test@test.com'
    },
    log: false
});

var request = {
    slot: 'product-findify-rec-1'
};

client.recommendations('predefined', request).then(function(response) {
    console.log(response);
});
var request = require("request");

var options = {
    method: 'POST',
  	headers: {
      "X-key": "2e963f3e-38bd-4c00-9636-c00e48945eb7"
    },
    url: 'https://api-v3.findify.io/v3/recommend/findify-home-rec-1',
    body: {
        user: {
            lang: ['en-GB'],
            uid: 'test1',
            sid: 'ssid',
            email: 'test@test.com',
            ip: '192.168.0.1',
            ua: 'Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36'
        },
        t_client: 1484742065791,
        offset: 0,
        limit: 5,
        log: false
    },
    json: true
};

request(options, function(error, response, body) {
    if (error) throw new Error(error);

    console.log(body);
});
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Key', '2e963f3e-38bd-4c00-9636-c00e48945eb7');

$api_instance = new Swagger\Client\Api\DefaultApi();
$recommendation = new \Swagger\Client\Model\GenericRecommendationRequest(array(
    'user' => array(
        'uid' => 'test1',
        'sid' => 'ssid',
        'email' => 'test@test.com',
        'ip' => '192.168.0.1',
        'ua' => 'Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36',
        'lang' => array(
            'en-US',
            'en-GB',
            'no'
        )
    ),
    't_client' => '1484741395471',
    'offset' => 0,
    'log' => false
));

try {
    $result = $api_instance->recommendSlotPost('findify-home-rec-1', $recommendation);
    echo $result;
}
catch (Exception $e) {
    echo 'Exception when calling DefaultApi->recommendSlotPost: ', $e->getMessage(), PHP_EOL;
}

?>
A binary file was returned

You couldn't be authenticated

{
  "meta": {
    "limit": 5,
    "offset": 0,
    "user_id": "test1",
    "total": 49,
    "rid": "r-ea052570-c9a6-4ff1-a5b4-538adb8a1050"
  },
  "items": [
    {
      "seller": "",
      "short_description": "",
      "product_url": "http://findify-demo-store.myshopify.com/products/hill-s-prescription-diet-p-d",
      "color": [],
      "variants_ids": [
        "20493980743",
        "20493980807"
      ],
      "image_2_url": "",
      "description": "Pienso para Dogs - Telepienso",
      "discount": [
        4
      ],
      "created_at": "2016-05-06T08:49:21.000Z",
      "availability": true,
      "delivery_time": "",
      "variants": [],
      "title": "Hill's Prescription Diet Canine p/d",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/hills-prescription-diet-canine-p-djpeg_small.jpeg?v=1462524561",
      "price": [
        42.23,
        78.9
      ],
      "stickers": {
        "discount": [
          4
        ],
        "availability": true,
        "in-stock": false,
        "out-of-stock": false,
        "free-shipping": false
      },
      "id": "6411354119",
      "sku": [
        "53743437003",
        "53743857700"
      ],
      "brand": "Hill's",
      "quantity": 1,
      "color_variants": 1,
      "shipping_cost": "",
      "image_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/hills-prescription-diet-canine-p-djpeg_medium.jpeg?v=1462524561",
      "custom_fields": {},
      "rating_score": -1,
      "tags": [
        "Dog",
        "Medium Breed",
        "Puppy",
        "Small Breed"
      ],
      "condition": "",
      "product_type": "",
      "material": [],
      "size": [],
      "shipping_weight": "",
      "category": [
        {
          "category2": "",
          "category3": "",
          "category4": "",
          "category1": "Dog Food"
        }
      ],
      "compare_at": -1
    },
    {
      "seller": "",
      "short_description": "",
      "product_url": "http://findify-demo-store.myshopify.com/products/hills-prescription-diet-canine-l-d",
      "color": [],
      "variants_ids": [
        "20493979719",
        "20493979783",
        "20493979911"
      ],
      "image_2_url": "",
      "description": "Pienso para Dogs - Telepienso",
      "discount": [
        4
      ],
      "created_at": "2016-05-06T08:49:19.000Z",
      "availability": true,
      "delivery_time": "",
      "variants": [],
      "title": "Hill's Prescription Diet Canine L/d",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_l_d_small.jpeg?v=1462524559",
      "price": [
        20.86,
        43.05,
        78.85
      ],
      "stickers": {
        "discount": [
          4
        ],
        "availability": true,
        "in-stock": false,
        "out-of-stock": false,
        "free-shipping": false
      },
      "id": "6411353287",
      "sku": [
        "53743855000",
        "53743733905",
        "53743855901"
      ],
      "brand": "Hill's",
      "quantity": -1,
      "color_variants": 1,
      "shipping_cost": "",
      "image_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_l_d_medium.jpeg?v=1462524559",
      "custom_fields": {},
      "rating_score": -1,
      "tags": [
        "Adult",
        "Dog",
        "Giant Breed",
        "Large Breed",
        "Medium Breed",
        "Puppy",
        "Small Breed"
      ],
      "condition": "",
      "product_type": "",
      "material": [],
      "size": [],
      "shipping_weight": "",
      "category": [
        {
          "category2": "",
          "category3": "",
          "category4": "",
          "category1": "Dog Food"
        }
      ],
      "compare_at": -1
    },
    {
      "seller": "",
      "short_description": "",
      "product_url": "http://findify-demo-store.myshopify.com/products/hills-prescription-diet-canine-l-d-humedo",
      "color": [],
      "variants_ids": [
        "20493980231"
      ],
      "image_2_url": "",
      "description": "Pienso para Dogs - Telepienso",
      "discount": [
        4
      ],
      "created_at": "2016-05-06T08:49:19.000Z",
      "availability": true,
      "delivery_time": "",
      "variants": [],
      "title": "Hill's Prescription Diet Canine l/d húmedo",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_l_d_lata_small.jpeg?v=1462524559",
      "price": [
        40.33
      ],
      "stickers": {
        "discount": [
          4
        ],
        "availability": true,
        "in-stock": false,
        "out-of-stock": false,
        "free-shipping": false
      },
      "id": "6411353671",
      "sku": [
        "53743801100"
      ],
      "brand": "Hill's",
      "quantity": -1,
      "color_variants": 1,
      "shipping_cost": "",
      "image_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_l_d_lata_medium.jpeg?v=1462524559",
      "custom_fields": {},
      "rating_score": -1,
      "tags": [
        "Adult",
        "Dog",
        "Giant Breed",
        "Large Breed",
        "Medium Breed",
        "Puppy",
        "Small Breed"
      ],
      "condition": "",
      "product_type": "",
      "material": [],
      "size": [],
      "shipping_weight": "",
      "category": [
        {
          "category2": "",
          "category3": "",
          "category4": "",
          "category1": "Canned Dog Food"
        }
      ],
      "compare_at": 42.02
    },
    {
      "seller": "",
      "short_description": "",
      "product_url": "http://findify-demo-store.myshopify.com/products/hills-prescription-diet-canine-k-d",
      "color": [],
      "variants_ids": [
        "20493979207",
        "20493979271",
        "20493979335"
      ],
      "image_2_url": "",
      "description": "Pienso para Dogs - Telepienso",
      "discount": [
        4
      ],
      "created_at": "2016-05-06T08:49:18.000Z",
      "availability": true,
      "delivery_time": "",
      "variants": [],
      "title": "Hill's Prescription Diet Canine k/d",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_k_d_small.jpeg?v=1462524558",
      "price": [
        18.29,
        39.5,
        74.11
      ],
      "stickers": {
        "discount": [
          4
        ],
        "availability": true,
        "in-stock": false,
        "out-of-stock": false,
        "free-shipping": false
      },
      "id": "6411352903",
      "sku": [
        "53743855805",
        "53743435401",
        "53743918304"
      ],
      "brand": "Hill's",
      "quantity": 1,
      "color_variants": 1,
      "shipping_cost": "",
      "image_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_k_d_medium.jpeg?v=1462524558",
      "custom_fields": {},
      "rating_score": -1,
      "tags": [
        "Adult",
        "Dog",
        "Giant Breed",
        "Large Breed",
        "Medium Breed",
        "Puppy",
        "Small Breed"
      ],
      "condition": "",
      "product_type": "",
      "material": [],
      "size": [],
      "shipping_weight": "",
      "category": [
        {
          "category2": "",
          "category3": "",
          "category4": "",
          "category1": "Dog Food"
        }
      ],
      "compare_at": -1
    },
    {
      "seller": "",
      "short_description": "",
      "product_url": "http://findify-demo-store.myshopify.com/products/hills-prescription-diet-canine-k-d-humedo",
      "color": [],
      "variants_ids": [
        "20493979463"
      ],
      "image_2_url": "",
      "description": "Pienso para Dogs - Telepienso",
      "discount": [
        4
      ],
      "created_at": "2016-05-06T08:49:18.000Z",
      "availability": true,
      "delivery_time": "",
      "variants": [],
      "title": "Hill's Prescription Diet Canine k/d húmedo",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_k_d_lata_small.jpeg?v=1462524558",
      "price": [
        37.97
      ],
      "stickers": {
        "discount": [
          4
        ],
        "availability": true,
        "in-stock": false,
        "out-of-stock": false,
        "free-shipping": false
      },
      "id": "6411353031",
      "sku": [
        "53743801101"
      ],
      "brand": "Hill's",
      "quantity": -1,
      "color_variants": 1,
      "shipping_cost": "",
      "image_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_k_d_lata_medium.jpeg?v=1462524558",
      "custom_fields": {},
      "rating_score": -1,
      "tags": [
        "Adult",
        "Dog",
        "Giant Breed",
        "Large Breed",
        "Medium Breed",
        "Puppy",
        "Small Breed"
      ],
      "condition": "",
      "product_type": "",
      "material": [],
      "size": [],
      "shipping_weight": "",
      "category": [
        {
          "category2": "",
          "category3": "",
          "category4": "",
          "category1": "Canned Dog Food"
        }
      ],
      "compare_at": 39.55
    }
  ]
}
{
  "error": {
    "message": "You should provide Findify API Key"
  }
}

Path Params

slot
string
required

Recommendation slot

Body Params

t_client
date-time
required
user
object
required
 
user.uid
string
required

max length: 32 characters

user.sid
string
required

max length: 32 characters

user.email
string
user.ip
string
user.ua
string
user.lang
array of strings
item_id
string
item_ids
array of strings
offset
int32
callback
string
log
boolean
 

Get the list of items for the specific recommendation slot

Suggest Edits

/recommend/items/newest

Provides latest products in your store

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api-v3.findify.io/v3/recommend/items/newest
curl --request POST \
  --url https://api-v3.findify.io/v3/recommend/items/newest \
  --header "X-Key: 2e963f3e-38bd-4c00-9636-c00e48945eb7" \
  --header "Content-Type: application/json" \
  --data '{"user":{"lang":["en-GB"],"uid":"test1","sid":"ssid","email":"test@test.com","ip":"192.168.0.1","ua":"Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36"},"t_client":1484742065791,"offset":0,"limit":5,"log":false}'
//Please, don't forget to include the SDK script
//Which you can find here: https://github.com/findify/javascript-sdk

var client = FindifySDK.init({
    key: '2e963f3e-38bd-4c00-9636-c00e48945eb7',
    user: {
        uid: 'test1',
        sid: 'ssid',
      	email: 'test@test.com'
    },
    log: false
});

var request = {
    offset: 0,
    limit: 5
};

client.recommendations('newest', request).then(function (response) {
  console.log(response);
});
var request = require("request"); 

var options = {
    method: 'POST',
    headers: {
      "X-key": "2e963f3e-38bd-4c00-9636-c00e48945eb7"
    },
    url: 'https://api-v3.findify.io/v3/recommend/items/newest',
    body: {
        user: {
            lang: ['en-GB'],
            uid: 'test1',
            sid: 'ssid',
            email: 'test@test.com',
            ip: '192.168.0.1',
            ua: 'Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36'
        },
        t_client: 1484742065791,
        offset: 0,
        limit: 5,
        log: false
    },
    json: true
};

request(options, function(error, response, body) {
    if (error) throw new Error(error);

    console.log(body);
});
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Key', '2e963f3e-38bd-4c00-9636-c00e48945eb7');

$api_instance = new Swagger\Client\Api\DefaultApi();
$recommendation = new \Swagger\Client\Model\GenericRecommendationRequest(array(
    'user' => array(
        'uid' => 'test1',
        'sid' => 'ssid',
        'email' => 'test@test.com',
        'ip' => '192.168.0.1',
        'ua' => 'Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36',
        'lang' => array(
            'en-US',
            'en-GB',
            'no'
        )
    ),
    't_client' => '1484741395471',
    'offset' => 0,
    'limit' => 5,
    'log' => false
));

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

?>
A binary file was returned

You couldn't be authenticated

{
  "meta": {
    "limit": 5,
    "offset": 0,
    "user_id": "test1",
    "total": 49,
    "rid": "r-ea052570-c9a6-4ff1-a5b4-538adb8a1050"
  },
  "items": [
    {
      "seller": "",
      "short_description": "",
      "product_url": "http://findify-demo-store.myshopify.com/products/hill-s-prescription-diet-p-d",
      "color": [],
      "variants_ids": [
        "20493980743",
        "20493980807"
      ],
      "image_2_url": "",
      "description": "Pienso para Dogs - Telepienso",
      "discount": [
        4
      ],
      "created_at": "2016-05-06T08:49:21.000Z",
      "availability": true,
      "delivery_time": "",
      "variants": [],
      "title": "Hill's Prescription Diet Canine p/d",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/hills-prescription-diet-canine-p-djpeg_small.jpeg?v=1462524561",
      "price": [
        42.23,
        78.9
      ],
      "stickers": {
        "discount": [
          4
        ],
        "availability": true,
        "in-stock": false,
        "out-of-stock": false,
        "free-shipping": false
      },
      "id": "6411354119",
      "sku": [
        "53743437003",
        "53743857700"
      ],
      "brand": "Hill's",
      "quantity": 1,
      "color_variants": 1,
      "shipping_cost": "",
      "image_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/hills-prescription-diet-canine-p-djpeg_medium.jpeg?v=1462524561",
      "custom_fields": {},
      "rating_score": -1,
      "tags": [
        "Dog",
        "Medium Breed",
        "Puppy",
        "Small Breed"
      ],
      "condition": "",
      "product_type": "",
      "material": [],
      "size": [],
      "shipping_weight": "",
      "category": [
        {
          "category2": "",
          "category3": "",
          "category4": "",
          "category1": "Dog Food"
        }
      ],
      "compare_at": -1
    },
    {
      "seller": "",
      "short_description": "",
      "product_url": "http://findify-demo-store.myshopify.com/products/hills-prescription-diet-canine-l-d",
      "color": [],
      "variants_ids": [
        "20493979719",
        "20493979783",
        "20493979911"
      ],
      "image_2_url": "",
      "description": "Pienso para Dogs - Telepienso",
      "discount": [
        4
      ],
      "created_at": "2016-05-06T08:49:19.000Z",
      "availability": true,
      "delivery_time": "",
      "variants": [],
      "title": "Hill's Prescription Diet Canine L/d",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_l_d_small.jpeg?v=1462524559",
      "price": [
        20.86,
        43.05,
        78.85
      ],
      "stickers": {
        "discount": [
          4
        ],
        "availability": true,
        "in-stock": false,
        "out-of-stock": false,
        "free-shipping": false
      },
      "id": "6411353287",
      "sku": [
        "53743855000",
        "53743733905",
        "53743855901"
      ],
      "brand": "Hill's",
      "quantity": -1,
      "color_variants": 1,
      "shipping_cost": "",
      "image_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_l_d_medium.jpeg?v=1462524559",
      "custom_fields": {},
      "rating_score": -1,
      "tags": [
        "Adult",
        "Dog",
        "Giant Breed",
        "Large Breed",
        "Medium Breed",
        "Puppy",
        "Small Breed"
      ],
      "condition": "",
      "product_type": "",
      "material": [],
      "size": [],
      "shipping_weight": "",
      "category": [
        {
          "category2": "",
          "category3": "",
          "category4": "",
          "category1": "Dog Food"
        }
      ],
      "compare_at": -1
    },
    {
      "seller": "",
      "short_description": "",
      "product_url": "http://findify-demo-store.myshopify.com/products/hills-prescription-diet-canine-l-d-humedo",
      "color": [],
      "variants_ids": [
        "20493980231"
      ],
      "image_2_url": "",
      "description": "Pienso para Dogs - Telepienso",
      "discount": [
        4
      ],
      "created_at": "2016-05-06T08:49:19.000Z",
      "availability": true,
      "delivery_time": "",
      "variants": [],
      "title": "Hill's Prescription Diet Canine l/d húmedo",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_l_d_lata_small.jpeg?v=1462524559",
      "price": [
        40.33
      ],
      "stickers": {
        "discount": [
          4
        ],
        "availability": true,
        "in-stock": false,
        "out-of-stock": false,
        "free-shipping": false
      },
      "id": "6411353671",
      "sku": [
        "53743801100"
      ],
      "brand": "Hill's",
      "quantity": -1,
      "color_variants": 1,
      "shipping_cost": "",
      "image_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_l_d_lata_medium.jpeg?v=1462524559",
      "custom_fields": {},
      "rating_score": -1,
      "tags": [
        "Adult",
        "Dog",
        "Giant Breed",
        "Large Breed",
        "Medium Breed",
        "Puppy",
        "Small Breed"
      ],
      "condition": "",
      "product_type": "",
      "material": [],
      "size": [],
      "shipping_weight": "",
      "category": [
        {
          "category2": "",
          "category3": "",
          "category4": "",
          "category1": "Canned Dog Food"
        }
      ],
      "compare_at": 42.02
    },
    {
      "seller": "",
      "short_description": "",
      "product_url": "http://findify-demo-store.myshopify.com/products/hills-prescription-diet-canine-k-d",
      "color": [],
      "variants_ids": [
        "20493979207",
        "20493979271",
        "20493979335"
      ],
      "image_2_url": "",
      "description": "Pienso para Dogs - Telepienso",
      "discount": [
        4
      ],
      "created_at": "2016-05-06T08:49:18.000Z",
      "availability": true,
      "delivery_time": "",
      "variants": [],
      "title": "Hill's Prescription Diet Canine k/d",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_k_d_small.jpeg?v=1462524558",
      "price": [
        18.29,
        39.5,
        74.11
      ],
      "stickers": {
        "discount": [
          4
        ],
        "availability": true,
        "in-stock": false,
        "out-of-stock": false,
        "free-shipping": false
      },
      "id": "6411352903",
      "sku": [
        "53743855805",
        "53743435401",
        "53743918304"
      ],
      "brand": "Hill's",
      "quantity": 1,
      "color_variants": 1,
      "shipping_cost": "",
      "image_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_k_d_medium.jpeg?v=1462524558",
      "custom_fields": {},
      "rating_score": -1,
      "tags": [
        "Adult",
        "Dog",
        "Giant Breed",
        "Large Breed",
        "Medium Breed",
        "Puppy",
        "Small Breed"
      ],
      "condition": "",
      "product_type": "",
      "material": [],
      "size": [],
      "shipping_weight": "",
      "category": [
        {
          "category2": "",
          "category3": "",
          "category4": "",
          "category1": "Dog Food"
        }
      ],
      "compare_at": -1
    },
    {
      "seller": "",
      "short_description": "",
      "product_url": "http://findify-demo-store.myshopify.com/products/hills-prescription-diet-canine-k-d-humedo",
      "color": [],
      "variants_ids": [
        "20493979463"
      ],
      "image_2_url": "",
      "description": "Pienso para Dogs - Telepienso",
      "discount": [
        4
      ],
      "created_at": "2016-05-06T08:49:18.000Z",
      "availability": true,
      "delivery_time": "",
      "variants": [],
      "title": "Hill's Prescription Diet Canine k/d húmedo",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_k_d_lata_small.jpeg?v=1462524558",
      "price": [
        37.97
      ],
      "stickers": {
        "discount": [
          4
        ],
        "availability": true,
        "in-stock": false,
        "out-of-stock": false,
        "free-shipping": false
      },
      "id": "6411353031",
      "sku": [
        "53743801101"
      ],
      "brand": "Hill's",
      "quantity": -1,
      "color_variants": 1,
      "shipping_cost": "",
      "image_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_k_d_lata_medium.jpeg?v=1462524558",
      "custom_fields": {},
      "rating_score": -1,
      "tags": [
        "Adult",
        "Dog",
        "Giant Breed",
        "Large Breed",
        "Medium Breed",
        "Puppy",
        "Small Breed"
      ],
      "condition": "",
      "product_type": "",
      "material": [],
      "size": [],
      "shipping_weight": "",
      "category": [
        {
          "category2": "",
          "category3": "",
          "category4": "",
          "category1": "Canned Dog Food"
        }
      ],
      "compare_at": 39.55
    }
  ]
}
{
  "error": {
    "message": "You should provide Findify API Key"
  }
}

Body Params

t_client
date-time
required
user
object
required
 
user.uid
string
required

max length: 32 characters

user.sid
string
required

max length: 32 characters

user.email
string
user.ip
string
user.ua
string
user.lang
array of strings
offset
int32
limit
string

max = 20

callback
string
log
boolean
 

This is a low level API, we recommend you to use the simple recommendation route to enable easy configuration via the Findify Merchant Dashboard.

Get the list of the newest items

Suggest Edits

/recommend/items/viewed/latest

Provides products recently viewed by the current user

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api-v3.findify.io/v3/recommend/items/viewed/latest
curl --request POST \
  --url https://api-v3.findify.io/v3/recommend/items/viewed/latest \
  --header "X-Key: 2e963f3e-38bd-4c00-9636-c00e48945eb7" \
  --header "Content-Type: application/json" \
  --data '{"user":{"lang":["en-GB"],"uid":"test1","sid":"ssid","email":"test@test.com","ip":"192.168.0.1","ua":"Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36"},"t_client":1484742065791,"offset":0,"limit":5,"log":false}'
//Please, don't forget to include the SDK script
//Which you can find here: https://github.com/findify/javascript-sdk

var client = FindifySDK.init({
    key: '2e963f3e-38bd-4c00-9636-c00e48945eb7',
    user: {
        uid: 'test1',
        sid: 'ssid',
      	email: 'test@test.com'
    },
    log: false
});

var request = {
    offset: 0,
    limit: 5
};

client.recommendations('latest', request).then(function (response) {
  console.log(response);
});
var request = require("request");
 
var options = {
    method: 'POST',
    headers: {
      "X-key": "2e963f3e-38bd-4c00-9636-c00e48945eb7"
    },
    url: 'https://api-v3.findify.io/v3/recommend/items/viewed/latest',
    body: {
        user: {
            lang: ['en-GB'],
            uid: 'test1',
            sid: 'ssid',
            email: 'test@test.com',
            ip: '192.168.0.1',
            ua: 'Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36'
        },
        t_client: 1484742065791,
        offset: 0,
        limit: 5,
        log: false
    },
    json: true
};

request(options, function(error, response, body) {
    if (error) throw new Error(error);

    console.log(body);
});
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Key', '2e963f3e-38bd-4c00-9636-c00e48945eb7');

$api_instance = new Swagger\Client\Api\DefaultApi();
$recommendation = new \Swagger\Client\Model\GenericRecommendationRequest(array(
    'user' => array(
        'uid' => 'test1',
        'sid' => 'ssid',
        'email' => 'test@test.com',
        'ip' => '192.168.0.1',
        'ua' => 'Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36',
        'lang' => array(
            'en-US',
            'en-GB',
            'no'
        )
    ),
    't_client' => '1484741395471',
    'offset' => 0,
    'limit' => 5,
    'log' => false
));

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

?>
A binary file was returned

You couldn't be authenticated

{
  "meta": {
    "limit": 5,
    "offset": 0,
    "user_id": "test1",
    "total": 49,
    "rid": "r-ea052570-c9a6-4ff1-a5b4-538adb8a1050"
  },
  "items": [
    {
      "seller": "",
      "short_description": "",
      "product_url": "http://findify-demo-store.myshopify.com/products/hill-s-prescription-diet-p-d",
      "color": [],
      "variants_ids": [
        "20493980743",
        "20493980807"
      ],
      "image_2_url": "",
      "description": "Pienso para Dogs - Telepienso",
      "discount": [
        4
      ],
      "created_at": "2016-05-06T08:49:21.000Z",
      "availability": true,
      "delivery_time": "",
      "variants": [],
      "title": "Hill's Prescription Diet Canine p/d",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/hills-prescription-diet-canine-p-djpeg_small.jpeg?v=1462524561",
      "price": [
        42.23,
        78.9
      ],
      "stickers": {
        "discount": [
          4
        ],
        "availability": true,
        "in-stock": false,
        "out-of-stock": false,
        "free-shipping": false
      },
      "id": "6411354119",
      "sku": [
        "53743437003",
        "53743857700"
      ],
      "brand": "Hill's",
      "quantity": 1,
      "color_variants": 1,
      "shipping_cost": "",
      "image_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/hills-prescription-diet-canine-p-djpeg_medium.jpeg?v=1462524561",
      "custom_fields": {},
      "rating_score": -1,
      "tags": [
        "Dog",
        "Medium Breed",
        "Puppy",
        "Small Breed"
      ],
      "condition": "",
      "product_type": "",
      "material": [],
      "size": [],
      "shipping_weight": "",
      "category": [
        {
          "category2": "",
          "category3": "",
          "category4": "",
          "category1": "Dog Food"
        }
      ],
      "compare_at": -1
    },
    {
      "seller": "",
      "short_description": "",
      "product_url": "http://findify-demo-store.myshopify.com/products/hills-prescription-diet-canine-l-d",
      "color": [],
      "variants_ids": [
        "20493979719",
        "20493979783",
        "20493979911"
      ],
      "image_2_url": "",
      "description": "Pienso para Dogs - Telepienso",
      "discount": [
        4
      ],
      "created_at": "2016-05-06T08:49:19.000Z",
      "availability": true,
      "delivery_time": "",
      "variants": [],
      "title": "Hill's Prescription Diet Canine L/d",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_l_d_small.jpeg?v=1462524559",
      "price": [
        20.86,
        43.05,
        78.85
      ],
      "stickers": {
        "discount": [
          4
        ],
        "availability": true,
        "in-stock": false,
        "out-of-stock": false,
        "free-shipping": false
      },
      "id": "6411353287",
      "sku": [
        "53743855000",
        "53743733905",
        "53743855901"
      ],
      "brand": "Hill's",
      "quantity": -1,
      "color_variants": 1,
      "shipping_cost": "",
      "image_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_l_d_medium.jpeg?v=1462524559",
      "custom_fields": {},
      "rating_score": -1,
      "tags": [
        "Adult",
        "Dog",
        "Giant Breed",
        "Large Breed",
        "Medium Breed",
        "Puppy",
        "Small Breed"
      ],
      "condition": "",
      "product_type": "",
      "material": [],
      "size": [],
      "shipping_weight": "",
      "category": [
        {
          "category2": "",
          "category3": "",
          "category4": "",
          "category1": "Dog Food"
        }
      ],
      "compare_at": -1
    },
    {
      "seller": "",
      "short_description": "",
      "product_url": "http://findify-demo-store.myshopify.com/products/hills-prescription-diet-canine-l-d-humedo",
      "color": [],
      "variants_ids": [
        "20493980231"
      ],
      "image_2_url": "",
      "description": "Pienso para Dogs - Telepienso",
      "discount": [
        4
      ],
      "created_at": "2016-05-06T08:49:19.000Z",
      "availability": true,
      "delivery_time": "",
      "variants": [],
      "title": "Hill's Prescription Diet Canine l/d húmedo",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_l_d_lata_small.jpeg?v=1462524559",
      "price": [
        40.33
      ],
      "stickers": {
        "discount": [
          4
        ],
        "availability": true,
        "in-stock": false,
        "out-of-stock": false,
        "free-shipping": false
      },
      "id": "6411353671",
      "sku": [
        "53743801100"
      ],
      "brand": "Hill's",
      "quantity": -1,
      "color_variants": 1,
      "shipping_cost": "",
      "image_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_l_d_lata_medium.jpeg?v=1462524559",
      "custom_fields": {},
      "rating_score": -1,
      "tags": [
        "Adult",
        "Dog",
        "Giant Breed",
        "Large Breed",
        "Medium Breed",
        "Puppy",
        "Small Breed"
      ],
      "condition": "",
      "product_type": "",
      "material": [],
      "size": [],
      "shipping_weight": "",
      "category": [
        {
          "category2": "",
          "category3": "",
          "category4": "",
          "category1": "Canned Dog Food"
        }
      ],
      "compare_at": 42.02
    },
    {
      "seller": "",
      "short_description": "",
      "product_url": "http://findify-demo-store.myshopify.com/products/hills-prescription-diet-canine-k-d",
      "color": [],
      "variants_ids": [
        "20493979207",
        "20493979271",
        "20493979335"
      ],
      "image_2_url": "",
      "description": "Pienso para Dogs - Telepienso",
      "discount": [
        4
      ],
      "created_at": "2016-05-06T08:49:18.000Z",
      "availability": true,
      "delivery_time": "",
      "variants": [],
      "title": "Hill's Prescription Diet Canine k/d",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_k_d_small.jpeg?v=1462524558",
      "price": [
        18.29,
        39.5,
        74.11
      ],
      "stickers": {
        "discount": [
          4
        ],
        "availability": true,
        "in-stock": false,
        "out-of-stock": false,
        "free-shipping": false
      },
      "id": "6411352903",
      "sku": [
        "53743855805",
        "53743435401",
        "53743918304"
      ],
      "brand": "Hill's",
      "quantity": 1,
      "color_variants": 1,
      "shipping_cost": "",
      "image_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_k_d_medium.jpeg?v=1462524558",
      "custom_fields": {},
      "rating_score": -1,
      "tags": [
        "Adult",
        "Dog",
        "Giant Breed",
        "Large Breed",
        "Medium Breed",
        "Puppy",
        "Small Breed"
      ],
      "condition": "",
      "product_type": "",
      "material": [],
      "size": [],
      "shipping_weight": "",
      "category": [
        {
          "category2": "",
          "category3": "",
          "category4": "",
          "category1": "Dog Food"
        }
      ],
      "compare_at": -1
    },
    {
      "seller": "",
      "short_description": "",
      "product_url": "http://findify-demo-store.myshopify.com/products/hills-prescription-diet-canine-k-d-humedo",
      "color": [],
      "variants_ids": [
        "20493979463"
      ],
      "image_2_url": "",
      "description": "Pienso para Dogs - Telepienso",
      "discount": [
        4
      ],
      "created_at": "2016-05-06T08:49:18.000Z",
      "availability": true,
      "delivery_time": "",
      "variants": [],
      "title": "Hill's Prescription Diet Canine k/d húmedo",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_k_d_lata_small.jpeg?v=1462524558",
      "price": [
        37.97
      ],
      "stickers": {
        "discount": [
          4
        ],
        "availability": true,
        "in-stock": false,
        "out-of-stock": false,
        "free-shipping": false
      },
      "id": "6411353031",
      "sku": [
        "53743801101"
      ],
      "brand": "Hill's",
      "quantity": -1,
      "color_variants": 1,
      "shipping_cost": "",
      "image_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_k_d_lata_medium.jpeg?v=1462524558",
      "custom_fields": {},
      "rating_score": -1,
      "tags": [
        "Adult",
        "Dog",
        "Giant Breed",
        "Large Breed",
        "Medium Breed",
        "Puppy",
        "Small Breed"
      ],
      "condition": "",
      "product_type": "",
      "material": [],
      "size": [],
      "shipping_weight": "",
      "category": [
        {
          "category2": "",
          "category3": "",
          "category4": "",
          "category1": "Canned Dog Food"
        }
      ],
      "compare_at": 39.55
    }
  ]
}
{
  "error": {
    "message": "You should provide Findify API Key"
  }
}

Body Params

t_client
date-time
required
user
object
required
 
user.uid
string
required

max length: 32 characters

user.sid
string
required

max length: 32 characters

user.email
string
user.ip
string
user.ua
string
user.lang
array of strings
offset
int32
limit
int32

max = 20

callback
string
log
boolean
 

This is a low level API, we recommend you to use the simple recommendation route to enable easy configuration via the Findify Merchant Dashboard.

Get the list of the latest items viewed by the user

Suggest Edits

/recommend/items/{item_id}/viewed/viewed

Provides 'users who viewed this product, also viewed these products' recommendation

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api-v3.findify.io/v3/recommend/items/item_id/viewed/viewed
curl --request POST \
  --url https://api-v3.findify.io/v3/recommend/items/6411354119/viewed/viewed \
  --header "X-Key: 2e963f3e-38bd-4c00-9636-c00e48945eb7" \
  --header "Content-Type: application/json" \
  --data '{"user":{"lang":["en-GB"],"uid":"test1","sid":"ssid","email":"test@test.com","ip":"192.168.0.1","ua":"Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36"},"t_client":1484742065791,"offset":0,"limit":5,"log":false}'
//Please, don't forget to include the SDK script
//Which you can find here: https://github.com/findify/javascript-sdk

var client = FindifySDK.init({
    key: '2e963f3e-38bd-4c00-9636-c00e48945eb7',
    user: {
        uid: 'test1',
        sid: 'ssid',
      	email: 'test@test.com'
    },
    log: false
});

var request = {
    offset: 0,
    limit: 5,
    item_id: '6411354119'
};

client.recommendations('viewed', request).then(function (response) {
  console.log(response);
});
var request = require("request");

var options = {
    method: 'POST',
    headers: {
      "X-key": "2e963f3e-38bd-4c00-9636-c00e48945eb7"
    },
    url: 'https://api-v3.findify.io/v3/recommend/items/6411354119/viewed/viewed',
    body: {
        user: {
            lang: ['en-GB'],
            uid: 'test1',
            sid: 'ssid',
            email: 'test@test.com',
            ip: '192.168.0.1',
            ua: 'Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36'
        },
        t_client: 1484742065791,
        offset: 0,
        limit: 5,
        log: false
    },
    json: true
};

request(options, function(error, response, body) {
    if (error) throw new Error(error);

    console.log(body);
});
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Key', '2e963f3e-38bd-4c00-9636-c00e48945eb7');

$api_instance = new Swagger\Client\Api\DefaultApi();
$recommendation = new \Swagger\Client\Model\RecommendationRequest(array(
    'user' => array(
        'uid' => 'test1',
        'sid' => 'ssid',
        'email' => 'test@test.com',
        'ip' => '192.168.0.1',
        'ua' => 'Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36',
        'lang' => array(
            'en-US',
            'en-GB',
            'no'
        )
    ),
    't_client' => '1484741395471',
    'offset' => 0,
    'limit' => 5,
    'log' => false
));

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

?>
A binary file was returned

You couldn't be authenticated

{
  "meta": {
    "limit": 5,
    "offset": 0,
    "user_id": "test1",
    "total": 49,
    "rid": "r-ea052570-c9a6-4ff1-a5b4-538adb8a1050"
  },
  "items": [
    {
      "seller": "",
      "short_description": "",
      "product_url": "http://findify-demo-store.myshopify.com/products/hill-s-prescription-diet-p-d",
      "color": [],
      "variants_ids": [
        "20493980743",
        "20493980807"
      ],
      "image_2_url": "",
      "description": "Pienso para Dogs - Telepienso",
      "discount": [
        4
      ],
      "created_at": "2016-05-06T08:49:21.000Z",
      "availability": true,
      "delivery_time": "",
      "variants": [],
      "title": "Hill's Prescription Diet Canine p/d",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/hills-prescription-diet-canine-p-djpeg_small.jpeg?v=1462524561",
      "price": [
        42.23,
        78.9
      ],
      "stickers": {
        "discount": [
          4
        ],
        "availability": true,
        "in-stock": false,
        "out-of-stock": false,
        "free-shipping": false
      },
      "id": "6411354119",
      "sku": [
        "53743437003",
        "53743857700"
      ],
      "brand": "Hill's",
      "quantity": 1,
      "color_variants": 1,
      "shipping_cost": "",
      "image_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/hills-prescription-diet-canine-p-djpeg_medium.jpeg?v=1462524561",
      "custom_fields": {},
      "rating_score": -1,
      "tags": [
        "Dog",
        "Medium Breed",
        "Puppy",
        "Small Breed"
      ],
      "condition": "",
      "product_type": "",
      "material": [],
      "size": [],
      "shipping_weight": "",
      "category": [
        {
          "category2": "",
          "category3": "",
          "category4": "",
          "category1": "Dog Food"
        }
      ],
      "compare_at": -1
    },
    {
      "seller": "",
      "short_description": "",
      "product_url": "http://findify-demo-store.myshopify.com/products/hills-prescription-diet-canine-l-d",
      "color": [],
      "variants_ids": [
        "20493979719",
        "20493979783",
        "20493979911"
      ],
      "image_2_url": "",
      "description": "Pienso para Dogs - Telepienso",
      "discount": [
        4
      ],
      "created_at": "2016-05-06T08:49:19.000Z",
      "availability": true,
      "delivery_time": "",
      "variants": [],
      "title": "Hill's Prescription Diet Canine L/d",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_l_d_small.jpeg?v=1462524559",
      "price": [
        20.86,
        43.05,
        78.85
      ],
      "stickers": {
        "discount": [
          4
        ],
        "availability": true,
        "in-stock": false,
        "out-of-stock": false,
        "free-shipping": false
      },
      "id": "6411353287",
      "sku": [
        "53743855000",
        "53743733905",
        "53743855901"
      ],
      "brand": "Hill's",
      "quantity": -1,
      "color_variants": 1,
      "shipping_cost": "",
      "image_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_l_d_medium.jpeg?v=1462524559",
      "custom_fields": {},
      "rating_score": -1,
      "tags": [
        "Adult",
        "Dog",
        "Giant Breed",
        "Large Breed",
        "Medium Breed",
        "Puppy",
        "Small Breed"
      ],
      "condition": "",
      "product_type": "",
      "material": [],
      "size": [],
      "shipping_weight": "",
      "category": [
        {
          "category2": "",
          "category3": "",
          "category4": "",
          "category1": "Dog Food"
        }
      ],
      "compare_at": -1
    },
    {
      "seller": "",
      "short_description": "",
      "product_url": "http://findify-demo-store.myshopify.com/products/hills-prescription-diet-canine-l-d-humedo",
      "color": [],
      "variants_ids": [
        "20493980231"
      ],
      "image_2_url": "",
      "description": "Pienso para Dogs - Telepienso",
      "discount": [
        4
      ],
      "created_at": "2016-05-06T08:49:19.000Z",
      "availability": true,
      "delivery_time": "",
      "variants": [],
      "title": "Hill's Prescription Diet Canine l/d húmedo",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_l_d_lata_small.jpeg?v=1462524559",
      "price": [
        40.33
      ],
      "stickers": {
        "discount": [
          4
        ],
        "availability": true,
        "in-stock": false,
        "out-of-stock": false,
        "free-shipping": false
      },
      "id": "6411353671",
      "sku": [
        "53743801100"
      ],
      "brand": "Hill's",
      "quantity": -1,
      "color_variants": 1,
      "shipping_cost": "",
      "image_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_l_d_lata_medium.jpeg?v=1462524559",
      "custom_fields": {},
      "rating_score": -1,
      "tags": [
        "Adult",
        "Dog",
        "Giant Breed",
        "Large Breed",
        "Medium Breed",
        "Puppy",
        "Small Breed"
      ],
      "condition": "",
      "product_type": "",
      "material": [],
      "size": [],
      "shipping_weight": "",
      "category": [
        {
          "category2": "",
          "category3": "",
          "category4": "",
          "category1": "Canned Dog Food"
        }
      ],
      "compare_at": 42.02
    },
    {
      "seller": "",
      "short_description": "",
      "product_url": "http://findify-demo-store.myshopify.com/products/hills-prescription-diet-canine-k-d",
      "color": [],
      "variants_ids": [
        "20493979207",
        "20493979271",
        "20493979335"
      ],
      "image_2_url": "",
      "description": "Pienso para Dogs - Telepienso",
      "discount": [
        4
      ],
      "created_at": "2016-05-06T08:49:18.000Z",
      "availability": true,
      "delivery_time": "",
      "variants": [],
      "title": "Hill's Prescription Diet Canine k/d",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_k_d_small.jpeg?v=1462524558",
      "price": [
        18.29,
        39.5,
        74.11
      ],
      "stickers": {
        "discount": [
          4
        ],
        "availability": true,
        "in-stock": false,
        "out-of-stock": false,
        "free-shipping": false
      },
      "id": "6411352903",
      "sku": [
        "53743855805",
        "53743435401",
        "53743918304"
      ],
      "brand": "Hill's",
      "quantity": 1,
      "color_variants": 1,
      "shipping_cost": "",
      "image_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_k_d_medium.jpeg?v=1462524558",
      "custom_fields": {},
      "rating_score": -1,
      "tags": [
        "Adult",
        "Dog",
        "Giant Breed",
        "Large Breed",
        "Medium Breed",
        "Puppy",
        "Small Breed"
      ],
      "condition": "",
      "product_type": "",
      "material": [],
      "size": [],
      "shipping_weight": "",
      "category": [
        {
          "category2": "",
          "category3": "",
          "category4": "",
          "category1": "Dog Food"
        }
      ],
      "compare_at": -1
    },
    {
      "seller": "",
      "short_description": "",
      "product_url": "http://findify-demo-store.myshopify.com/products/hills-prescription-diet-canine-k-d-humedo",
      "color": [],
      "variants_ids": [
        "20493979463"
      ],
      "image_2_url": "",
      "description": "Pienso para Dogs - Telepienso",
      "discount": [
        4
      ],
      "created_at": "2016-05-06T08:49:18.000Z",
      "availability": true,
      "delivery_time": "",
      "variants": [],
      "title": "Hill's Prescription Diet Canine k/d húmedo",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_k_d_lata_small.jpeg?v=1462524558",
      "price": [
        37.97
      ],
      "stickers": {
        "discount": [
          4
        ],
        "availability": true,
        "in-stock": false,
        "out-of-stock": false,
        "free-shipping": false
      },
      "id": "6411353031",
      "sku": [
        "53743801101"
      ],
      "brand": "Hill's",
      "quantity": -1,
      "color_variants": 1,
      "shipping_cost": "",
      "image_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_k_d_lata_medium.jpeg?v=1462524558",
      "custom_fields": {},
      "rating_score": -1,
      "tags": [
        "Adult",
        "Dog",
        "Giant Breed",
        "Large Breed",
        "Medium Breed",
        "Puppy",
        "Small Breed"
      ],
      "condition": "",
      "product_type": "",
      "material": [],
      "size": [],
      "shipping_weight": "",
      "category": [
        {
          "category2": "",
          "category3": "",
          "category4": "",
          "category1": "Canned Dog Food"
        }
      ],
      "compare_at": 39.55
    }
  ]
}
{
  "error": {
    "message": "You should provide Findify API Key"
  }
}

Path Params

item_id
string
required

Body Params

t_client
date-time
required
user
object
required
 
user.uid
string
required

max length: 32 characters

user.sid
string
required

max length: 32 characters

user.email
string
user.ip
string
user.ua
string
user.lang
array of strings
offset
int32
limit
int32

max = 20

callback
string
log
boolean
 

This is a low level API, we recommend you to use the simple recommendation route to enable easy configuration via the Findify Merchant Dashboard.

Get the list of the items related to the current item

Suggest Edits

/recommend/items/{item_id}/viewed/bought

Provides 'users who viewed this product, also bought these products' recommendation

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api-v3.findify.io/v3/recommend/items/item_id/viewed/bought
curl --request POST \
  --url https://api-v3.findify.io/v3/recommend/items/6411354119/viewed/bought \
  --header "X-Key: 2e963f3e-38bd-4c00-9636-c00e48945eb7" \
  --header "Content-Type: application/json" \
  --data '{"user":{"lang":["en-GB"],"uid":"test1","sid":"ssid","email":"test@test.com","ip":"192.168.0.1","ua":"Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36"},"t_client":1484742065791,"offset":0,"limit":5,"log":false}'
//Please, don't forget to include the SDK script
//Which you can find here: https://github.com/findify/javascript-sdk

var client = FindifySDK.init({
    key: '2e963f3e-38bd-4c00-9636-c00e48945eb7',
    user: {
        uid: 'test1',
        sid: 'ssid',
      	email: 'test@test.com'
    },
    log: false
});

var request = {
    offset: 0,
    limit: 5,
    item_id: '6411354119'
};

client.recommendations('bought', request).then(function (response) {
  console.log(response);
});
var request = require("request");

var options = {
    method: 'POST',
    headers: {
      "X-key": "2e963f3e-38bd-4c00-9636-c00e48945eb7"
    },
    url: 'https://api-v3.findify.io/v3/recommend/items/6411354119/viewed/bought',
    body: {
        user: {
            lang: ['en-GB'],
            uid: 'test1',
            sid: 'ssid',
            email: 'test@test.com',
            ip: '192.168.0.1',
            ua: 'Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36'
        },
        t_client: 1484742065791,
        offset: 0,
        limit: 5,
        log: false
    },
    json: true
};

request(options, function(error, response, body) {
    if (error) throw new Error(error);

    console.log(body);
});
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Key', '2e963f3e-38bd-4c00-9636-c00e48945eb7');

$api_instance = new Swagger\Client\Api\DefaultApi();
$recommendation = new \Swagger\Client\Model\RecommendationRequest(array(
    'user' => array(
        'uid' => 'test1',
        'sid' => 'ssid',
        'email' => 'test@test.com',
        'ip' => '192.168.0.1',
        'ua' => 'Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36',
        'lang' => array(
            'en-US',
            'en-GB',
            'no'
        )
    ),
    't_client' => '1484741395471',
    'offset' => 0,
    'limit' => 5,
    'log' => false
));

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

?>
A binary file was returned

You couldn't be authenticated

{
  "meta": {
    "limit": 5,
    "offset": 0,
    "user_id": "test1",
    "total": 49,
    "rid": "r-ea052570-c9a6-4ff1-a5b4-538adb8a1050"
  },
  "items": [
    {
      "seller": "",
      "short_description": "",
      "product_url": "http://findify-demo-store.myshopify.com/products/hill-s-prescription-diet-p-d",
      "color": [],
      "variants_ids": [
        "20493980743",
        "20493980807"
      ],
      "image_2_url": "",
      "description": "Pienso para Dogs - Telepienso",
      "discount": [
        4
      ],
      "created_at": "2016-05-06T08:49:21.000Z",
      "availability": true,
      "delivery_time": "",
      "variants": [],
      "title": "Hill's Prescription Diet Canine p/d",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/hills-prescription-diet-canine-p-djpeg_small.jpeg?v=1462524561",
      "price": [
        42.23,
        78.9
      ],
      "stickers": {
        "discount": [
          4
        ],
        "availability": true,
        "in-stock": false,
        "out-of-stock": false,
        "free-shipping": false
      },
      "id": "6411354119",
      "sku": [
        "53743437003",
        "53743857700"
      ],
      "brand": "Hill's",
      "quantity": 1,
      "color_variants": 1,
      "shipping_cost": "",
      "image_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/hills-prescription-diet-canine-p-djpeg_medium.jpeg?v=1462524561",
      "custom_fields": {},
      "rating_score": -1,
      "tags": [
        "Dog",
        "Medium Breed",
        "Puppy",
        "Small Breed"
      ],
      "condition": "",
      "product_type": "",
      "material": [],
      "size": [],
      "shipping_weight": "",
      "category": [
        {
          "category2": "",
          "category3": "",
          "category4": "",
          "category1": "Dog Food"
        }
      ],
      "compare_at": -1
    },
    {
      "seller": "",
      "short_description": "",
      "product_url": "http://findify-demo-store.myshopify.com/products/hills-prescription-diet-canine-l-d",
      "color": [],
      "variants_ids": [
        "20493979719",
        "20493979783",
        "20493979911"
      ],
      "image_2_url": "",
      "description": "Pienso para Dogs - Telepienso",
      "discount": [
        4
      ],
      "created_at": "2016-05-06T08:49:19.000Z",
      "availability": true,
      "delivery_time": "",
      "variants": [],
      "title": "Hill's Prescription Diet Canine L/d",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_l_d_small.jpeg?v=1462524559",
      "price": [
        20.86,
        43.05,
        78.85
      ],
      "stickers": {
        "discount": [
          4
        ],
        "availability": true,
        "in-stock": false,
        "out-of-stock": false,
        "free-shipping": false
      },
      "id": "6411353287",
      "sku": [
        "53743855000",
        "53743733905",
        "53743855901"
      ],
      "brand": "Hill's",
      "quantity": -1,
      "color_variants": 1,
      "shipping_cost": "",
      "image_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_l_d_medium.jpeg?v=1462524559",
      "custom_fields": {},
      "rating_score": -1,
      "tags": [
        "Adult",
        "Dog",
        "Giant Breed",
        "Large Breed",
        "Medium Breed",
        "Puppy",
        "Small Breed"
      ],
      "condition": "",
      "product_type": "",
      "material": [],
      "size": [],
      "shipping_weight": "",
      "category": [
        {
          "category2": "",
          "category3": "",
          "category4": "",
          "category1": "Dog Food"
        }
      ],
      "compare_at": -1
    },
    {
      "seller": "",
      "short_description": "",
      "product_url": "http://findify-demo-store.myshopify.com/products/hills-prescription-diet-canine-l-d-humedo",
      "color": [],
      "variants_ids": [
        "20493980231"
      ],
      "image_2_url": "",
      "description": "Pienso para Dogs - Telepienso",
      "discount": [
        4
      ],
      "created_at": "2016-05-06T08:49:19.000Z",
      "availability": true,
      "delivery_time": "",
      "variants": [],
      "title": "Hill's Prescription Diet Canine l/d húmedo",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_l_d_lata_small.jpeg?v=1462524559",
      "price": [
        40.33
      ],
      "stickers": {
        "discount": [
          4
        ],
        "availability": true,
        "in-stock": false,
        "out-of-stock": false,
        "free-shipping": false
      },
      "id": "6411353671",
      "sku": [
        "53743801100"
      ],
      "brand": "Hill's",
      "quantity": -1,
      "color_variants": 1,
      "shipping_cost": "",
      "image_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_l_d_lata_medium.jpeg?v=1462524559",
      "custom_fields": {},
      "rating_score": -1,
      "tags": [
        "Adult",
        "Dog",
        "Giant Breed",
        "Large Breed",
        "Medium Breed",
        "Puppy",
        "Small Breed"
      ],
      "condition": "",
      "product_type": "",
      "material": [],
      "size": [],
      "shipping_weight": "",
      "category": [
        {
          "category2": "",
          "category3": "",
          "category4": "",
          "category1": "Canned Dog Food"
        }
      ],
      "compare_at": 42.02
    },
    {
      "seller": "",
      "short_description": "",
      "product_url": "http://findify-demo-store.myshopify.com/products/hills-prescription-diet-canine-k-d",
      "color": [],
      "variants_ids": [
        "20493979207",
        "20493979271",
        "20493979335"
      ],
      "image_2_url": "",
      "description": "Pienso para Dogs - Telepienso",
      "discount": [
        4
      ],
      "created_at": "2016-05-06T08:49:18.000Z",
      "availability": true,
      "delivery_time": "",
      "variants": [],
      "title": "Hill's Prescription Diet Canine k/d",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_k_d_small.jpeg?v=1462524558",
      "price": [
        18.29,
        39.5,
        74.11
      ],
      "stickers": {
        "discount": [
          4
        ],
        "availability": true,
        "in-stock": false,
        "out-of-stock": false,
        "free-shipping": false
      },
      "id": "6411352903",
      "sku": [
        "53743855805",
        "53743435401",
        "53743918304"
      ],
      "brand": "Hill's",
      "quantity": 1,
      "color_variants": 1,
      "shipping_cost": "",
      "image_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_k_d_medium.jpeg?v=1462524558",
      "custom_fields": {},
      "rating_score": -1,
      "tags": [
        "Adult",
        "Dog",
        "Giant Breed",
        "Large Breed",
        "Medium Breed",
        "Puppy",
        "Small Breed"
      ],
      "condition": "",
      "product_type": "",
      "material": [],
      "size": [],
      "shipping_weight": "",
      "category": [
        {
          "category2": "",
          "category3": "",
          "category4": "",
          "category1": "Dog Food"
        }
      ],
      "compare_at": -1
    },
    {
      "seller": "",
      "short_description": "",
      "product_url": "http://findify-demo-store.myshopify.com/products/hills-prescription-diet-canine-k-d-humedo",
      "color": [],
      "variants_ids": [
        "20493979463"
      ],
      "image_2_url": "",
      "description": "Pienso para Dogs - Telepienso",
      "discount": [
        4
      ],
      "created_at": "2016-05-06T08:49:18.000Z",
      "availability": true,
      "delivery_time": "",
      "variants": [],
      "title": "Hill's Prescription Diet Canine k/d húmedo",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_k_d_lata_small.jpeg?v=1462524558",
      "price": [
        37.97
      ],
      "stickers": {
        "discount": [
          4
        ],
        "availability": true,
        "in-stock": false,
        "out-of-stock": false,
        "free-shipping": false
      },
      "id": "6411353031",
      "sku": [
        "53743801101"
      ],
      "brand": "Hill's",
      "quantity": -1,
      "color_variants": 1,
      "shipping_cost": "",
      "image_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_k_d_lata_medium.jpeg?v=1462524558",
      "custom_fields": {},
      "rating_score": -1,
      "tags": [
        "Adult",
        "Dog",
        "Giant Breed",
        "Large Breed",
        "Medium Breed",
        "Puppy",
        "Small Breed"
      ],
      "condition": "",
      "product_type": "",
      "material": [],
      "size": [],
      "shipping_weight": "",
      "category": [
        {
          "category2": "",
          "category3": "",
          "category4": "",
          "category1": "Canned Dog Food"
        }
      ],
      "compare_at": 39.55
    }
  ]
}
{
  "error": {
    "message": "You should provide Findify API Key"
  }
}

Path Params

item_id
string
required

Body Params

t_client
date-time
required
user
object
required
 
user.uid
string
required

max length: 32 characters

user.sid
string
required

max length: 32 characters

user.email
string
user.ip
string
user.ua
string
user.lang
array of strings
offset
int32
limit
int32

max = 20

callback
string
log
boolean
 

This is a low level API, we recommend you to use the simple recommendation route to enable easy configuration via the Findify Merchant Dashboard.

Get the list of the items related to the current item

Suggest Edits

/recommend/items/{item_id}/bought/bought

Provides 'frequently purchased together' recommendation

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api-v3.findify.io/v3/recommend/items/item_ids/bought/bought
curl --request POST \
  --url https://api-v3.findify.io/v3/recommend/items/6411354119,10116071626/bought/bought \
  --header "X-Key: 2e963f3e-38bd-4c00-9636-c00e48945eb7" \
  --header "Content-Type: application/json" \
  --data '{"user":{"lang":["en-GB"],"uid":"test1","sid":"ssid","email":"test@test.com","ip":"192.168.0.1","ua":"Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36"},"t_client":1484742065791,"offset":0,"limit":5,"log":false}'
//Please, don't forget to include the SDK script
//Which you can find here: https://github.com/findify/javascript-sdk

var client = FindifySDK.init({
    key: '2e963f3e-38bd-4c00-9636-c00e48945eb7',
    user: {
        uid: 'test1',
        sid: 'ssid',
      	email: 'test@test.com'
    },
    log: false
});

var request = {
    offset: 0,
    limit: 5,
    item_ids: ['6411354119', '10116071626']
};

client.recommendations('frequentlyPurchased', request).then(function (response) {
  console.log(response);
});
var request = require("request");

var options = {
    method: 'POST',
    headers: {
      "X-key": "2e963f3e-38bd-4c00-9636-c00e48945eb7"
    },
    url: 'https://api-v3.findify.io/v3/recommend/items/6411354119,10116071626/bought/bought',
    body: {
        user: {
            lang: ['en-GB'],
            uid: 'test1',
            sid: 'ssid',
            email: 'test@test.com',
            ip: '192.168.0.1',
            ua: 'Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36'
        },
        t_client: 1484742065791,
        offset: 0,
        limit: 5,
        log: false
    },
    json: true
};

request(options, function(error, response, body) {
    if (error) throw new Error(error);

    console.log(body);
});
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Key', '2e963f3e-38bd-4c00-9636-c00e48945eb7');

$api_instance = new Swagger\Client\Api\DefaultApi();
$recommendation = new \Swagger\Client\Model\RecommendationRequest(array(
    'user' => array(
        'uid' => 'test1',
        'sid' => 'ssid',
        'email' => 'test@test.com',
        'ip' => '192.168.0.1',
        'ua' => 'Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36',
        'lang' => array(
            'en-US',
            'en-GB',
            'no'
        )
    ),
    't_client' => '1484741395471',
    'offset' => 0,
    'limit' => 5,
    'log' => false
));

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

?>
A binary file was returned

You couldn't be authenticated

{
  "meta": {
    "limit": 5,
    "offset": 0,
    "user_id": "test1",
    "item_ids": ["6411354119", "10116071626"],
    "total": 49,
    "rid": "r-ea052570-c9a6-4ff1-a5b4-538adb8a1050"
  },
  "items": [
    {
      "seller": "",
      "short_description": "",
      "product_url": "http://findify-demo-store.myshopify.com/products/hill-s-prescription-diet-p-d",
      "color": [],
      "variants_ids": [
        "20493980743",
        "20493980807"
      ],
      "image_2_url": "",
      "description": "Pienso para Dogs - Telepienso",
      "discount": [
        4
      ],
      "created_at": "2016-05-06T08:49:21.000Z",
      "availability": true,
      "delivery_time": "",
      "variants": [],
      "title": "Hill's Prescription Diet Canine p/d",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/hills-prescription-diet-canine-p-djpeg_small.jpeg?v=1462524561",
      "price": [
        42.23,
        78.9
      ],
      "stickers": {
        "discount": [
          4
        ],
        "availability": true,
        "in-stock": false,
        "out-of-stock": false,
        "free-shipping": false
      },
      "id": "6411354119",
      "sku": [
        "53743437003",
        "53743857700"
      ],
      "brand": "Hill's",
      "quantity": 1,
      "color_variants": 1,
      "shipping_cost": "",
      "image_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/hills-prescription-diet-canine-p-djpeg_medium.jpeg?v=1462524561",
      "custom_fields": {},
      "rating_score": -1,
      "tags": [
        "Dog",
        "Medium Breed",
        "Puppy",
        "Small Breed"
      ],
      "condition": "",
      "product_type": "",
      "material": [],
      "size": [],
      "shipping_weight": "",
      "category": [
        {
          "category2": "",
          "category3": "",
          "category4": "",
          "category1": "Dog Food"
        }
      ],
      "compare_at": -1
    },
    {
      "seller": "",
      "short_description": "",
      "product_url": "http://findify-demo-store.myshopify.com/products/hills-prescription-diet-canine-l-d",
      "color": [],
      "variants_ids": [
        "20493979719",
        "20493979783",
        "20493979911"
      ],
      "image_2_url": "",
      "description": "Pienso para Dogs - Telepienso",
      "discount": [
        4
      ],
      "created_at": "2016-05-06T08:49:19.000Z",
      "availability": true,
      "delivery_time": "",
      "variants": [],
      "title": "Hill's Prescription Diet Canine L/d",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_l_d_small.jpeg?v=1462524559",
      "price": [
        20.86,
        43.05,
        78.85
      ],
      "stickers": {
        "discount": [
          4
        ],
        "availability": true,
        "in-stock": false,
        "out-of-stock": false,
        "free-shipping": false
      },
      "id": "6411353287",
      "sku": [
        "53743855000",
        "53743733905",
        "53743855901"
      ],
      "brand": "Hill's",
      "quantity": -1,
      "color_variants": 1,
      "shipping_cost": "",
      "image_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_l_d_medium.jpeg?v=1462524559",
      "custom_fields": {},
      "rating_score": -1,
      "tags": [
        "Adult",
        "Dog",
        "Giant Breed",
        "Large Breed",
        "Medium Breed",
        "Puppy",
        "Small Breed"
      ],
      "condition": "",
      "product_type": "",
      "material": [],
      "size": [],
      "shipping_weight": "",
      "category": [
        {
          "category2": "",
          "category3": "",
          "category4": "",
          "category1": "Dog Food"
        }
      ],
      "compare_at": -1
    },
    {
      "seller": "",
      "short_description": "",
      "product_url": "http://findify-demo-store.myshopify.com/products/hills-prescription-diet-canine-l-d-humedo",
      "color": [],
      "variants_ids": [
        "20493980231"
      ],
      "image_2_url": "",
      "description": "Pienso para Dogs - Telepienso",
      "discount": [
        4
      ],
      "created_at": "2016-05-06T08:49:19.000Z",
      "availability": true,
      "delivery_time": "",
      "variants": [],
      "title": "Hill's Prescription Diet Canine l/d húmedo",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_l_d_lata_small.jpeg?v=1462524559",
      "price": [
        40.33
      ],
      "stickers": {
        "discount": [
          4
        ],
        "availability": true,
        "in-stock": false,
        "out-of-stock": false,
        "free-shipping": false
      },
      "id": "6411353671",
      "sku": [
        "53743801100"
      ],
      "brand": "Hill's",
      "quantity": -1,
      "color_variants": 1,
      "shipping_cost": "",
      "image_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_l_d_lata_medium.jpeg?v=1462524559",
      "custom_fields": {},
      "rating_score": -1,
      "tags": [
        "Adult",
        "Dog",
        "Giant Breed",
        "Large Breed",
        "Medium Breed",
        "Puppy",
        "Small Breed"
      ],
      "condition": "",
      "product_type": "",
      "material": [],
      "size": [],
      "shipping_weight": "",
      "category": [
        {
          "category2": "",
          "category3": "",
          "category4": "",
          "category1": "Canned Dog Food"
        }
      ],
      "compare_at": 42.02
    },
    {
      "seller": "",
      "short_description": "",
      "product_url": "http://findify-demo-store.myshopify.com/products/hills-prescription-diet-canine-k-d",
      "color": [],
      "variants_ids": [
        "20493979207",
        "20493979271",
        "20493979335"
      ],
      "image_2_url": "",
      "description": "Pienso para Dogs - Telepienso",
      "discount": [
        4
      ],
      "created_at": "2016-05-06T08:49:18.000Z",
      "availability": true,
      "delivery_time": "",
      "variants": [],
      "title": "Hill's Prescription Diet Canine k/d",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_k_d_small.jpeg?v=1462524558",
      "price": [
        18.29,
        39.5,
        74.11
      ],
      "stickers": {
        "discount": [
          4
        ],
        "availability": true,
        "in-stock": false,
        "out-of-stock": false,
        "free-shipping": false
      },
      "id": "6411352903",
      "sku": [
        "53743855805",
        "53743435401",
        "53743918304"
      ],
      "brand": "Hill's",
      "quantity": 1,
      "color_variants": 1,
      "shipping_cost": "",
      "image_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_k_d_medium.jpeg?v=1462524558",
      "custom_fields": {},
      "rating_score": -1,
      "tags": [
        "Adult",
        "Dog",
        "Giant Breed",
        "Large Breed",
        "Medium Breed",
        "Puppy",
        "Small Breed"
      ],
      "condition": "",
      "product_type": "",
      "material": [],
      "size": [],
      "shipping_weight": "",
      "category": [
        {
          "category2": "",
          "category3": "",
          "category4": "",
          "category1": "Dog Food"
        }
      ],
      "compare_at": -1
    },
    {
      "seller": "",
      "short_description": "",
      "product_url": "http://findify-demo-store.myshopify.com/products/hills-prescription-diet-canine-k-d-humedo",
      "color": [],
      "variants_ids": [
        "20493979463"
      ],
      "image_2_url": "",
      "description": "Pienso para Dogs - Telepienso",
      "discount": [
        4
      ],
      "created_at": "2016-05-06T08:49:18.000Z",
      "availability": true,
      "delivery_time": "",
      "variants": [],
      "title": "Hill's Prescription Diet Canine k/d húmedo",
      "thumbnail_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_k_d_lata_small.jpeg?v=1462524558",
      "price": [
        37.97
      ],
      "stickers": {
        "discount": [
          4
        ],
        "availability": true,
        "in-stock": false,
        "out-of-stock": false,
        "free-shipping": false
      },
      "id": "6411353031",
      "sku": [
        "53743801101"
      ],
      "brand": "Hill's",
      "quantity": -1,
      "color_variants": 1,
      "shipping_cost": "",
      "image_url": "https://cdn.shopify.com/s/files/1/1281/0545/products/prescription_diet_canine_k_d_lata_medium.jpeg?v=1462524558",
      "custom_fields": {},
      "rating_score": -1,
      "tags": [
        "Adult",
        "Dog",
        "Giant Breed",
        "Large Breed",
        "Medium Breed",
        "Puppy",
        "Small Breed"
      ],
      "condition": "",
      "product_type": "",
      "material": [],
      "size": [],
      "shipping_weight": "",
      "category": [
        {
          "category2": "",
          "category3": "",
          "category4": "",
          "category1": "Canned Dog Food"
        }
      ],
      "compare_at": 39.55
    }
  ]
}
{
  "error": {
    "message": "You should provide Findify API Key"
  }
}

Path Params

item_ids
string
required

Item IDs separated by comma

Body Params

t_client
date-time
required
user
object
required
 
user.uid
string
required

max length: 32 characters

user.sid
string
required

max length: 32 characters

user.email
string
user.ip
string
user.ua
string
user.lang
array of strings
offset
int32
limit
int32

max = 20

callback
string
log
boolean
 
Suggest Edits

Feedback API

 

Feedback API provides a way to send information about user activity on the web page to power our ML and personalization algorithms

Suggest Edits

/feedback

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api-v3.findify.io/v3/feedback
curl --request POST \
  --url https://api-v3.findify.io/v3/feedback \
  --header "X-Key: 2e963f3e-38bd-4c00-9636-c00e48945eb7" \
  --header "Content-Type: application/json" \
  --data '{"user":{"lang":["en-GB"],"uid":"test1","sid":"ssid","email":"test@test.com","ip":"192.168.0.1","ua":"Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36"},"t_client":1484742065791, "log": false,"event":"click-item", "properties": {"rid": "r-ea052570-c9a6-4ff1-a5b4-538adb8a1050", "item_id": "6411354119"}}'
//Please, don't forget to include the SDK script
//Which you can find here: https://github.com/findify/javascript-sdk

var client = FindifySDK.init({
    key: '2e963f3e-38bd-4c00-9636-c00e48945eb7',
    user: {
        uid: 'test1',
        sid: 'ssid',
      	email: 'test@test.com'
    },
    log: false
});

var request = {
    rid: 'r-ea052570-c9a6-4ff1-a5b4-538adb8a1050',
    item_id: '6411354119'
};

client.feedback('click-item', request);
var request = require("request");
 
var options = {
    method: 'POST',
    headers: {
      "X-key": "2e963f3e-38bd-4c00-9636-c00e48945eb7"
    },
    url: 'https://api-v3.findify.io/v3/feedback',
    body: {
        user: {
            lang: ['en-GB'],
            uid: 'test1',
            sid: 'ssid',
            email: 'test@test.com',
            ip: '192.168.0.1',
            ua: 'Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36'
        },
        t_client: 1484742065791,
        log: 'false',
        event: 'click-item',
        properties: {
            rid: "r-ea052570-c9a6-4ff1-a5b4-538adb8a1050",
            item_id: "6411354119"
        }
    },
    json: true
};

request(options, function(error, response, body) {
    if (error) throw new Error(error);

    console.log(body);
});
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Key', '2e963f3e-38bd-4c00-9636-c00e48945eb7');

$api_instance = new Swagger\Client\Api\DefaultApi();
$feedback     = new \Swagger\Client\Model\Feedback(array(
    'user' => array(
        'uid' => 'test1',
        'sid' => 'ssid',
        'email' => 'test@test.com',
        'ip' => '192.168.0.1',
        'ua' => 'Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36',
        'lang' => array(
            'en-US',
            'en-GB',
            'no'
        )
    ),
    't_client' => '1484741395471',
    'event' => 'click-item',
    'properties' => array(
        'rid' => 'r-ea052570-c9a6-4ff1-a5b4-538adb8a1050',
        'item_id' => '6411354119'
    ),
    'log' => false
));

try {
    $result = $api_instance->feedbackPost('findify-home-rec-1', $feedback);
    echo $result;
}
catch (Exception $e) {
    echo 'Exception when calling DefaultApi->feedbackPost: ', $e->getMessage(), PHP_EOL;
}

?>
A binary file was returned

You couldn't be authenticated

{
  "error": {
    "message": "You should provide Findify API Key"
  }
}

Body Params

t_client
date-time
required
user
object
required
 
user.uid
string
required

max length: 32 characters

user.sid
string
required

max length: 32 characters

user.email
string
user.ip
string
user.ua
string
user.lang
array of strings
event
string
required

Event name

properties
mixed type
required

Event properties

callback
string
log
boolean
 

This is a low level API, we recommend you to use the Findify Merchant JS, or the Findify Feedback JS to speed up the integration.

Sends analytics information in order to help the personalization algorithm deliver more relevant items to the user

Generic structure

{
    "event": "EVENT NAME", //REQUIRED, Event name
    "properties": {
        // HERE ARE THE PROPERTIES RELATED TO EACH EVENT
    },
    "api_version": "v3",  // REQUIRED, API Version
    "key": string, //REQUIRED, Merchant API Key
    "t_client": unit_timestamp, //REQUIRED, Timestamp client in milliseconds
    "user": {
        "uid": string,      //REQUIRED, Permanent User ID
        "sid": string,      //REQUIRED, Session ID
        "ip": string,       //REQUIRED, IP of the customer
        "ua": string,       //REQUIRED, User-agent
        "lang": [string],   //OPTIONAL, Languages
        "email": string     //OPTIONAL, User email
    }
}

Click-suggestion event

{
    "event": "click-suggestion",
    "properties": {
        "rid": string,  //REQUIRED, Request id preceding the clickthrough
        "suggestion": string //REQUIRED, Suggestion that is clicked
    }
}

Click-item event

{
    "event": "click-item",
    "properties": {
        "rid": string,      // OPTIONAL, Request id preceding the clickthrough
        "item_id": string,   // REQUIRED, Item ID clicked
      	"variant_item_id": string //OPTIONAL, Variant ID clicked
    }
}

Page redirect event

{
     "event": "redirect",
     "properties": {
        "rid": string,  // REQUIRED, Request id preceding the redirection
        "suggestion": string // REQUIRED, Suggestion that leads to the redirection
     }
}

Purchase event

{
    "event": "purchase",
    "properties": {
        "order_id": string,     // REQUIRED, Order ID
        "currency": string,     // REQUIRED, Currency of the purchase
        "revenue": double,      // REQUIRED, Total revenue
      	"total_discount": double, // OPTIONAL, total order discount
      	"total_tax": double, //OPTIONAL, total tax applied to the order
      	"total_shipping": double, //OPTIONAL, total shipping applied to the order
        "affiliation": string,  // OPTIONAL, Affiliation of the purchase
        "line_items": [
            {
                "item_id": string,      // REQUIRED, Item ID bought
              	"variant_item_id": string, //OPTIONAL, Variant ID clicked
                "unit_price": double,   // REQUIRED, Sale price of the product
                "quantity”: int         // REQUIRED, Quantity bought
            }
        ]
    }
}

Add-to-cart event

{
    "event": "add-to-cart",
    "properties": {
        "rid": string,      // OPTIONAL, Request ID preceding the add-to-cart
        "item_id": string,  // REQUIRED, Item ID added to cart
        "variant_item_id": string, //OPTIONAL, Variant ID clicked
        "quantity": int     // OPTIONAL, Quantity added to cart, default = 1
    }
}

Cart event

{
    "event": "update-cart",
    "properties": {
        "line_items": [
            {
                "item_id": string,     // REQUIRED, Item ID
                "variant_item_id": string, //OPTIONAL, Variant ID clicked
                "unit_price": double,  // REQUIRED, Sale price of the product
                "quantity": int        // REQUIRED, Quantity bought
            }
        ]
    }
}

Page view

{
    "event": "view-page",
    "properties": {
        "url": string,      // REQUIRED, URL of the page viewed
        "ref": string,      // REQUIRED, Referer of the page
        "width": int,       // REQUIRED, Width of the customer's browser
        "height": int,      // REQUIRED, Height of the customer's browser
        "item_id": string,   // OPTIONAL, Item ID - only for product pages
        "variant_item_id": string //OPTIONAL, Variant ID clicked
    }
}
Suggest Edits

Push API - Products

Push API (products)

 

The Push API allows a merchant to push / update / delete SKUs near real-time without the need to synchronize the full catalog of products.

Once an update has been submitted to the Push API, it will spread automatically to our search engine and personalization platform within 3 minutes.

Authentication

In order to push events to the Push API, you would need to have a private API key.
At the moment, you would need to make a request to Findify, to get your private API key.

When having your private API key, you simply need to provide a header X-Key with the value of the private API key that you have.

Contact yourfriends@findify.io for more information.

Guarantees

The Push API applies all the rules-based transformations previously configured.
Adding, modifying or deleting a rule-based transformation will trigger a full product catalog resynchronization as the update would need to be performed on the full product catalog.

Suggest Edits

/products

Create a new SKU

 

Header Auth

 Authentication is required for this endpoint.
posthttps://pushapi.findify.io/v1/products
curl --request POST \
  --url https://pushapi.findify.io/v1/products \
  --header "X-Key: 2e964f3e-38bd-4c00-9636-c00e48945eb7" \
  --header "Content-Type: application/json" \
  --data '{"id":"67281","title":"My T-shirt - L","description":"T-shirt with long sleeves","price":59.99,"product_url":"https://findify.myshopify.com/products/67281","image_url":"https://findify.myshopify.com/products/67281/images/1.jpg","category":"Clothing > T-shirt > Long Sleeves","availability":true,"quantity":18,"created_at":"2018-05-20T20:30:18Z","item_group_id":"7281632"}'
A binary file was returned

You couldn't be authenticated

{
  "errors": [
    {
      "category": "string",
      "field": "string",
      "message": "string"
    }
  ],
  "warnings": [
    {
      "category": "string",
      "field": "string",
      "message": "string"
    }
  ]
}
{
  "errors": [
    {
      "category": "string",
      "field": "string",
      "message": "string"
    }
  ],
  "warnings": [
    {
      "category": "string",
      "field": "string",
      "message": "string"
    }
  ]
}
Internal server error

Body Params

id
string

ID of the SKU

title
string

Title of the SKU

description
string

Description associated with the SKU

price
double

Price of the SKU

product_url
string

URL to the SKU page

image_url
string

URL to the image

category
string

Category in which the SKU is located

availability
boolean

Availability of the SKU

quantity
int32

How many stocks do you have left of this product

created_at
date

Date when the product has been published

item_group_id
string

Parent ID of the SKU

 

Content of the payload

The list of attributes to add in the payload must contain all the mandatory fields of a SKU, as defined here.

Of course, it is possible to add more attributes to this payload:

  • optional fields like the "brand", the "sku", the "sale price", etc.
  • any other type of field - what we called "custom field".

Validations

The Push API performs some validations before accepting a payload.

Errors are provided when:

  • the type of a field is not what Findify is expecting. For instance, the field "price" should always be a Double.
  • the type of the custom field is different than the type already ingested previously.

Warnings are provided when:

  • we detect that the content of a field is not proper but not critical to accept an event. In this case, this is your decision to decide which action to take: make an update to the product or not.
Suggest Edits

/products/{id}

Update a product with the full list of mandatory attributes

 

Header Auth

 Authentication is required for this endpoint.
puthttps://pushapi.findify.io/v1/products/id
curl --request PUT \
  --url https://pushapi.findify.io/v1/products/67281 \
  --header "X-Key: 2e964f3e-38bd-4c00-9636-c00e48945eb7" \
  --header "Content-Type: application/json" \
  --data '{"id":"67281","title":"My T-shirt - M","description":"T-shirt with long sleeves","price":49.99,"product_url":"https://findify.myshopify.com/products/67281","image_url":"https://findify.myshopify.com/products/67281/images/2.jpg","category":"Clothing > T-shirt > Long Sleeves","availability":true,"quantity":18,"created_at":"2018-05-20T20:30:18Z","item_group_id":"7281632"}'
A binary file was returned

You couldn't be authenticated

{
  "errors": [
    {
      "category": "string",
      "field": "string",
      "message": "string"
    }
  ],
  "warnings": [
    {
      "category": "string",
      "field": "string",
      "message": "string"
    }
  ]
}
{
  "errors": [
    {
      "category": "string",
      "field": "string",
      "message": "string"
    }
  ],
  "warnings": [
    {
      "category": "string",
      "field": "string",
      "message": "string"
    }
  ]
}
Internal Server Error

Path Params

id
string
required

ID of the SKU

Query Params

id
string

ID of the SKU

title
string

Title of the SKU

description
string

Description associated with the SKU

price
double

Price of the SKU

product_url
string

URL to the SKU page

image_url
string

URL to the image

category
string

Category in which the SKU is located

availability
string

Availability of the SKU

quantity
string

Quantity left in the stock

created_at
date

Date when the product has been published

item_group_id
string

Parent ID of the SKU

 

Content of the payload

The payload must contain the full list of attributes required to create a product.
If a mandatory field is missing, an error will be returned to the client.

Suggest Edits

/products/{id}

Partial update of a SKU

 

Header Auth

 Authentication is required for this endpoint.
patchhttps://pushapi.findify.io/v1/products/id
curl --request PATCH \
  --url https://pushapi.findify.io/v1/products/67281 \
  --header "X-Key: 2e964f3e-38bd-4c00-9636-c00e48945eb7" \
  --header "Content-Type: application/json" \
  --data '{"id":"67281","price":39.99}'
A binary file was returned

You couldn't be authenticated

{
  "errors": [
    {
      "category": "string",
      "field": "string",
      "message": "string"
    }
  ],
  "warnings": [
    {
      "category": "string",
      "field": "string",
      "message": "string"
    }
  ]
}
{
  "errors": [
    {
      "category": "string",
      "field": "string",
      "message": "string"
    }
  ],
  "warnings": [
    {
      "category": "string",
      "field": "string",
      "message": "string"
    }
  ]
}
Internal Server Error

Path Params

id
string
required

ID of the SKU on which to perform the partial update

Body Params

id
string

ID of the SKU

price
double

Price of the SKU

 

Content of the payload

The field id is mandatory in the payload.
Any other fields can be specified (not just the price, as the example shows).

Suggest Edits

/products/{id}

Delete a SKU

 

Header Auth

 Authentication is required for this endpoint.
deletehttps://pushapi.findify.io/v1/products/id
curl --request DELETE \
  --url https://pushapi.findify.io/v1/products/67281 \
  --header "X-Key: 2e964f3e-38bd-4c00-9636-c00e48945eb7" \
  --header "Content-Type: application/json"
A binary file was returned

You couldn't be authenticated

Internal Server Error

Path Params

id
string
required

ID of the SKU to delete

 
Suggest Edits

Content API - Content

 

Content API not available for all merchants yet

The Content API is still in development and not available for all our merchants yet.

Introduction

The Content API allows a client to push and then search content-based documents (articles, pictures, videos, etc.).

A document can be of different sorts:

  • an article from a blog
  • a Youtube video
  • the content of a web page
  • a category page (from Shopify collection)
  • an Instagram image
  • any content that has been generated by the user (UGC = User Generated Content)

Content API

The content search feature is composed of 2 main components:

  • The content API that allows a client to add, modify or delete documents. This API is available under the domain pushapi.findify.io.
  • The content search API that lets the client search into their content index. This API has a different endpoint and is available under the domain api-v3.findify.io.

When an operation has been submitted to the content API (adding/modification/deletion), it will take maximum 3 minutes for the system to propagate the operation in the Findify search engine.

How is the payload built?

Each document belongs to a source that characterizes from where it comes from.
Both the id (unique identifier of the document) and the source needs to be provided for every operation submitted to the content API.
The source needs to be configured previously by Findify. This is a string that Findify provides and cannot be set by the client.

Each document can have a free set of attributes. The set of attributes is not enforced (except the "id" and the "source"). The content API accepts native types, list of data and nested objects.

API Authentication

In order to push documents to the Content API, you would need to request a private API key.
At the moment, the only way to get a private API key is to contact the Findify support, as the Content Search is not yet available to all merchants.

When having your private API key, you simply need to provide a header X-Key with the value of your private API key.

Contact yourfriends@findify.io for more information.

Suggest Edits

/content/{source}

Add a new document

 

Header Auth

 Authentication is required for this endpoint.
posthttps://pushapi.findify.io/v1/content/source
curl --request POST \
  --url https://pushapi.findify.io/v1/content/instagram \
  --header "X-Key: 3d964f3e-38bd-4c00-9636-c00e48945eb7" \
  --header "Content-Type: application/json" \
  --data  '{"id":"6372821","source":"instagram","author":"vgoloviznin", "url":"https://www.instagram.com/p/BZVY-O1F993/?tagged=findify","image_url":"https://scontent-frt3-1.cdninstagram.com/vp/b214f0ecc0f96689a38e276c182f0cf3/5B947DFB/t51.2885-15/e35/21879518_711184209080865_8456318305450328064_n.jpg","tags":["findify","praha","escaperoom","retreat"],"caption":"What a wonderful team building event","likes":26,"viewed":12836,"comments":[{"id":"7261","message":"Nice team picture!","author":"Oscar","author_id":"7282639"}],"created_at":"2016-01-11T22:42:00Z"}'
A binary file was returned

You couldn't be authenticated

{
  "errors": [
    {
      "category": "string",
      "field": "string",
      "message": "string"
    }
  ],
  "warnings": [
    {
      "category": "string",
      "field": "string",
      "message": "string"
    }
  ]
}
{
  "errors": [
    {
      "category": "string",
      "field": "string",
      "message": "string"
    }
  ],
  "warnings": [
    {
      "category": "string",
      "field": "string",
      "message": "string"
    }
  ]
}

Path Params

source
string
required

Source of the document

Body Params

id
string

Unique identifier of the document

source
string

Source (as described in Findify) of the document

 
Suggest Edits

/content/{source}/{id}

Update all the attributes of an existing document

 

Header Auth

 Authentication is required for this endpoint.
puthttps://pushapi.findify.io/v1/content/source/id
curl --request PUT \
  --url https://pushapi.findify.io/v1/content/instagram/6372821 \
  --header "X-Key: 3d964f3e-38bd-4c00-9636-c00e48945eb7" \
  --header "Content-Type: application/json" \
  --data  '{"id":"6372821","source":"instagram","author":"vgoloviznin","url":"https://www.instagram.com/p/BZVY-O1F993/?tagged=findify","image_url":"https://scontent-frt3-1.cdninstagram.com/vp/b214f0ecc0f96689a38e276c182f0cf3/5B947DFB/t51.2885-15/e35/21879518_711184209080865_8456318305450328064_n.jpg","tags":["findify","praha","escaperoom","retreat"],"caption":"What a wonderful team building event","likes":28,"viewed":14738,"comments":[{"id":"7261","message":"Nice team picture!","author":"Oscar","author_id":"7282639"},{"id":"7262","message":"Seems like you had a lot of fun!","author":"Marie","author_id":"2628373"}],"created_at":"2016-01-11T22:42:00Z"}'
A binary file was returned

You couldn't be authenticated

{
  "errors": [
    {
      "category": "string",
      "field": "string",
      "message": "string"
    }
  ],
  "warnings": [
    {
      "category": "string",
      "field": "string",
      "message": "string"
    }
  ]
}
{
  "errors": [
    {
      "category": "string",
      "field": "string",
      "message": "string"
    }
  ],
  "warnings": [
    {
      "category": "string",
      "field": "string",
      "message": "string"
    }
  ]
}

Path Params

id
string
required

Unique identifier of the document

source
string
required

Source of the document

Body Params

id
string

Unique identifier of the document

source
string

Source of the document

 
Suggest Edits

/content/{source}/{id}

Partial update of a document

 

Header Auth

 Authentication is required for this endpoint.
patchhttps://pushapi.findify.io/v1/content/source/id
curl --request PATCH \
  --url https://pushapi.findify.io/v1/content/instagram/6372821 \
  --header "X-Key: 3d964f3e-38bd-4c00-9636-c00e48945eb7" \
  --header "Content-Type: application/json" \
  --data  '{"id":"6372821","source":"instagram","likes":42,"viewed":32489}'
A binary file was returned

You couldn't be authenticated

{
  "errors": [
    {
      "category": "string",
      "field": "string",
      "message": "string"
    }
  ],
  "warnings": [
    {
      "category": "string",
      "field": "string",
      "message": "string"
    }
  ]
}
{
  "errors": [
    {
      "category": "string",
      "field": "string",
      "message": "string"
    }
  ],
  "warnings": [
    {
      "category": "string",
      "field": "string",
      "message": "string"
    }
  ]
}

Path Params

id
string
required

Unique identifier of the document

source
string
required

Source of the document

Body Params

id
string

Unique identifier of the document

source
string

Source of the document

 
Suggest Edits

/content/{source}/{id}

Delete a document

 

Header Auth

 Authentication is required for this endpoint.
deletehttps://pushapi.findify.io/v1/content/source/id
curl --request DELETE \
  --url https://pushapi.findify.io/v1/content/instagram/6372821 \
  --header "X-Key: 3d964f3e-38bd-4c00-9636-c00e48945eb7"
A binary file was returned

You couldn't be authenticated

{
  "errors": [
    {
      "category": "string",
      "field": "string",
      "message": "string"
    }
  ],
  "warnings": [
    {
      "category": "string",
      "field": "string",
      "message": "string"
    }
  ]
}

Path Params

source
string
required

Source of the document

id
string
required

Unique identifier of the document

 
Suggest Edits

Findify Analytics JS

 

Findify Analytics JS helps you integrate our Feedback API on the website and gather all the user behavior analytics that our ML and personalization require.

This is documentation for Analytics JS >= 3.x.
If you are looking for the old version of Analytics JS (< 3.x) it could be found here:

Suggest Edits

findifyAnalytics(config)

 

Initializes library.

Arguments:

config.key required (string): Merchant API key.

Returns:

Client instance, which could be used further for sending feedback requests to the server.

// First, you need to initialize library:
var client = findifyAnalytics({
    key: 'b9h348b89h439g43'
});

// Then, you should initialize client instance.
// Usually you want to do this on document ready event to collect all data from HTML tags.
client.initialize();

// After library initialized, we can send event requests to server with `client` instance. Let's perform click-suggestion request:
client.sendEvent('click-suggestion', {
  rid: 'request_id',
  suggestion: 'Black t-shirt'
});

// You can get `user` instance, which can be used further in `findify-sdk` library:
var user = client.user;

// To access events on the page you can use `client.state`,
// Analytics state represents all events that was defined on the page
// before findify

// You can listen for events with `listen` function
var unsubscribe = client.listen(function(event, payload) {
  console.log(event); // outputs event name
  console.log(payload); // outputs event payload
});
Suggest Edits

client.sendEvent(type, request)

 

This method has dynamic request argument. It depends on provided event type. See description below to get definitions of request argument for every event type.

Click suggestion event arguments:

type required ('click-suggestion'): Click suggestion event type.
request.rid required (string): Id of request, where user clicked on suggestion.
request.suggestion required (string): Suggestion title.

Click item event arguments:

type required ('click-item'): Click item event type.
request.item_id required (string): Id of item, which user clicked.
request.variant_item_id optional (string): Id of item variant.
request.rid optional (string): Id of request, where user clicked on item.

Redirect event arguments:

type required ('redirect'): Redirect event type.
request.rid required (string): Id of request, where redirect was happened.
request.suggestion required (string): Suggestion that leads to the redirection.

Purchase event arguments:

type required ('purchase'): Purchase event type.
request.order_id required (string): Id of order.
request.currency required (string): Currency of the purchase.
request.revenue required (number): Total revenue of the purchase.
request.total_discount optional (number): Total discount of the purchase.
request.total_tax optional (number): Total tax of the purchase.
request.shipping optional (number): Total shipping of the purchase.
request.line_items required (line_item[]): Items in cart.
request.affiliation optional (string): Affiliation of the purchase.

Update cart event arguments:

type required ('update-cart'): Update cart event type.
request.line_items required (line_item[]): Items in cart.

Add to cart event arguments:

type required ('add-to-cart'): Add to cart event type.
request.item_id required (string): Id of item, added to cart.
request.variant_item_id optional (string): Id of item variant.
request.rid optional (string): Id of request, where add to cart button was clicked.
request.quantity optional (number): Quantity of items, added to cart. Default - 1.

View page event arguments:

type required ('view-page'): View page event type.
request.item_id optional (string): Id of item. Only for product pages.
request.variant_item_id optional (string): Id of item variant.

Types:

line_item.item_id required (string): Id of item.
line_item.unit_price required (string): Price of the product.
line_item.quantity required (number): Quantity of items.
line_item.variant_item_id optional (string): Id of item variant.

Examples of usage:

// Click suggestion event
var request = {
    rid: '892',
    suggestion: 'White t-shirts'
};

client.sendEvent('click-suggestion', request);

// Click item event
var request = {
    rid: '892',
    item_id: '9842'
};

client.sendEvent('click-item', request);

// Redirect event
var request = {
    rid: '892',
    suggestion: '9842'
};

client.sendEvent('redirect', request);

// Purchase event
var request = {
    order_id: '451',
    currency: 'usd',
    revenue: 394.1,
    line_items: [{
        item_id: '5028',
        unit_price: 394.1,
        quantity: 2
    }]
};

client.sendEvent('purchase', request);

// Update cart event
var request = {
    line_items: [{
        item_id: '5028',
        unit_price: 394.1,
        quantity: 2
    }]
};

client.sendEvent('update-cart', request);

// Add to cart event
var request = {
    item_id: '5720',
    rid: '72046',
    quantity: 1,
};

client.sendEvent('add-to-cart', request);

// View page event
var request = {
    item_id: '8572'
};

client.sendEvent('view-page', request);
Suggest Edits

client.user

 

Returns:

Returns user object, which can be used further in FindifySDK, FindifyHelpers libraries or in plain Findify REST API.

Examples of usage:

var user = client.user;

var findifySdkClient = FindifySDK.init({
    key: 'f8923hg20hg248g8g9h',
    user: user
});
Suggest Edits

Introduction

 

Findify JS SDK is a JavaScript wrapper of the low-level JSON API.

Suggest Edits

FindifySDK.init(config)

 

Initializes library.

Arguments:

config.key required (string): Merchant API key.
config.user optional (user): User object. Could be provided either at initialization or at request.
config.method optional ('jsonp' || 'post'): Request method. Default 'jsonp'.
config.log optional (boolean): Defines, should Findify log requests on server.

Types:

user.uid required (string): Unique customer id.
user.sid required (string): Session id.
user.email optional (string): Customer email.
user.ip optional (number): Customer ip.
user.ua optional (string): Customer user agent.
user.lang optional (string[]): Languages.

Returns:

Client instance, which could be used further for sending requests to the server.

Examples of usage:

var client = FindifySDK.init({
    key: 'b9h348b89h439g43',
    user: {
        uid: 'f892hf2938f2g9p2',
        sid: 'g2984hg2jg9823g9',
    }
});

// After, you can send requests to server:
client.autocomplete(request).then(function (response) {
    // handle autocomplete response
});
Suggest Edits

client.autocomplete(request)

 

Arguments:

request.q required (string): Autocomplete query.
request.suggestion_limit optional (number): Limit of search suggestions.
request.item_limit optional (number): Limit of product matches.
request.user optional (object): User object. Could be provided either at initialization or at request.

Types:

user.uid required (string): Unique customer id.
user.sid required (string): Session id.
user.email optional (string): Customer email.
user.ip optional (number): Customer ip.
user.ua optional (string): Customer user agent.
user.lang optional (string[]): Languages.

Returns:

List of search suggestions queries, product matches and query meta data.

Examples of usage:

var request = {
    q: 'White t-shirt',
    suggestion_limit: 5,
    item_limit: 10,
};

client.autocomplete(request).then(function(response) {
    // handle autocomplete response
});
Suggest Edits

client.collection(request)

 

Arguments:

request.slot required (string): Name of collection slot.
request.offset optional (number): Offset of products items. Used in pagination.
request.limit optional (number): Number of products in result.
request.filters optional (filter[]): Array of selected filters.
request.sort optional (sort[]): Array of selected sortings.
request.user optional (user): User object. Could be provided either at initialization or at request.

Types

filter.name required (string): Name of filter.
filter.type required (string): Type of filter.
filter.values optional (object[]): Array of selected filter values.
filter.values[].value optional (string): Selected filter value.
filter.values[].from optional (string): Selected range filter "from" value.
filter.values[].to optional (string): Selected range filter "to" value.

sort.field required (string): Field for sorting.
sort.order required ('desc' || 'asc'): Sorting order.

user.uid required (string): Unique customer id.
user.sid required (string): Session id.
user.email optional (string): Customer email.
user.ip optional (number): Customer ip.
user.ua optional (string): Customer user agent.
user.lang optional (string[]): Languages.

Returns:

Smart collection with products list, selected facets list and meta data.

Examples of usage:

var request = {
    slot: 't-shirts',
    offset: 20,
    limit: 15,
    filters: [{
        name: 'category1',
        type: 'category',
        values: [{
            value: 'T-Shirts'
        }]
    }],
    sort: [{
        field: 'price',
        order: 'asc'
    }]
};

client.collection(request).then(function(response) {
    // handle collection response
});
Suggest Edits

client.recommendations(type, request)

 

Emits events to recommendation store.

Predefined recommendation request event

event.name required ('request'): Predefined recommendation request event name.
event.payload.slot required (string): Slot value.
event.payload.item_id optional (string)
event.payload.user optional (object): User object. Could be provided either at initialization or at request.

Newest recommendation request event

event.name required ('newest'): Newest recommendation request event name.
event.payload.offset optional (string): Offset of products in response.
event.payload.limit optional (string): Number of products in response.
event.payload.user optional (object): User object. Could be provided either at initialization or at request.

Trending recommendation request event

event.name required ('trending'): Trending recommendation request event name.
event.payload.offset optional (string): Offset of products in response.
event.payload.limit optional (string): Number of products in response.
event.payload.user optional (object): User object. Could be provided either at initialization or at request.

Latest recommendation request event

event.name required ('latest'): Latest recommendation request event name.
event.payload.offset optional (string): Offset of products in response.
event.payload.limit optional (string): Number of products in response.
event.payload.user optional (object): User object. Could be provided either at initialization or at request.

Viewed recommendation request event

event.name required ('viewed'): Viewed recommendation request event name.
event.payload.item_id required (string)
event.payload.offset optional (string): Offset of products in response.
event.payload.limit optional (string): Number of products in response.
event.payload.user optional (object): User object. Could be provided either at initialization or at request.

Bought recommendation request event

event.name required ('bought'): Bought recommendation request event name.
event.payload.item_id required (string)
event.payload.offset optional (string): Offset of products in response.
event.payload.limit optional (string): Number of products in response.
event.payload.user optional (object): User object. Could be provided either at initialization or at request.

Frequently purchased recommendation request event

event.name required ('frequentlyPurchased'): Frequently purchased recommendation request event name.
event.payload.item_ids required ((string | number)[]): Array of items ids.
event.payload.offset optional (string): Offset of products in response.
event.payload.limit optional (string): Number of products in response.
event.payload.user optional (object): User object. Could be provided either at initialization or at request.

Set request body event:

event.name required ('setRequestBody'): Set request body event name.
event.payload required (object): FindifySDK recommendation request data.

Featured recommendation request event

event.name required ('featured'): Featured recommendation request event name.
event.payload.user optional (object): User object. Could be provided either at initialization or at request.

Types:

user.uid required (string): Unique customer id.
user.sid required (string): Session id.
user.email optional (string): Customer email.
user.ip optional (number): Customer ip.
user.ua optional (string): Customer user agent.
user.lang optional (string[]): Languages.

Returns:

Recommendation store instance.

Examples of usage:

// Predefined recommendation
predefinedRecommendationStore
    .emit({
        name: 'request',
        payload: {
            slot: 'slotValue',
            item_id: '10'
        }
    });

// Newest recommendation
newestRecommendationStore
    .emit({
        name: 'request',
        payload: {
            offset: 5,
            limit: 10
        }
    });

// Trending recommendation
trendingRecommendationStore
    .emit({
        name: 'request',
        payload: {
            offset: 5,
            limit: 10
        }
    });

// Latest recommendation
latestRecommendationStore
    .emit({
        name: 'request',
        payload: {
            offset: 5,
            limit: 10
        }
    });

// Viewed recommendation
viewedRecommendationStore
    .emit({
        name: 'request',
        payload: {
            offset: 5,
            limit: 10,
            item_id: '10'
        }
    });

// Bought recommendation
boughtRecommendationStore
    .emit({
        name: 'request',
        payload: {
            offset: 5,
            limit: 10,
            item_id: '10'
        }
    });

// Frequently purchased recommendation
frequentlyPurchasedRecommendationStore
    .emit({
        name: 'request',
        payload: {
            offset: 5,
            limit: 10,
            item_ids: ['10', '11']
        }
    });


// Featured recommendation
featuredRecommendationStore
    .emit({
        name: 'request'
    });

// `setRequestBody` event
viewedRecommendationStore
    .emit({
        name: 'setRequestBody',
        payload: {
            offset: 10
        }
    })
    .emit({
        name: 'request'
    });
Suggest Edits

client.feedback(type, request)

 

This method has dynamic request argument. It depends on provided event type. See description below to get definitions of request argument for every event type.

Click suggestion event arguments:

type required ('click-suggestion'): Click suggestion event type.
request.rid required (string): Id of request, where user clicked on suggestion.
request.suggestion required (string): Suggestion title.
request.user optional (user): User object. Could be provided either at initialization or at request.

Click item event arguments:

type required ('click-item'): Click item event type.
request.item_id required (string): Id of item, which user clicked.
request.rid optional (string): Id of request, where user clicked on item.
request.user optional (user): User object. Could be provided either at initialization or at request.

Redirect event arguments:

type required ('redirect'): Redirect event type.
request.rid required (string): Id of request, where redirect was happened.
request.suggestion required (string): Suggestion that leads to the redirection.
request.user optional (user): User object. Could be provided either at initialization or at request.

Purchase event arguments:

type required ('purchase'): Purchase event type.
request.order_id required (string): Id of order.
request.currency required (string): Currency of the purchase.
request.revenue required (number): Total revenue of the purchase.
request.line_items required (line_item[]): Items in cart.
request.affiliation optional (string): Affiliation of the purchase.
request.user optional (user): User object. Could be provided either at initialization or at request.

Update cart event arguments:

type required ('update-cart'): Update cart event type.
request.line_items required (line_item[]): Items in cart.
request.user optional (user): User object. Could be provided either at initialization or at request.

Add to cart event arguments:

type required ('add-to-cart'): Add to cart event type.
request.item_id required (string): Id of item, added to cart.
request.rid optional (string): Id of request, where add to cart button was clicked.
request.quantity optional (number): Quantity of items, added to cart. Default - 1.
request.user optional (user): User object. Could be provided either at initialization or at request.

View page event arguments:

type required ('view-page'): View page event type.
request.url required (string): Url of the page viewed.
request.ref required (string): Referrer of the page.
request.width required (number): Width of the customer's browser.
request.height required (number): Height of the customer's browser.
request.item_id optional (string): Id of item. Only for product pages.
request.user optional (user): User object. Could be provided either at initialization or at request.

Types:

line_item.id required (string): Id of item.
line_item.unit_price required (string): Price of the product.
line_item.quantity required (number): Quantity of items.

user.uid required (string): Unique customer id.
user.sid required (string): Session id.
user.email optional (string): Customer email.
user.ip optional (number): Customer ip.
user.ua optional (string): Customer user agent.
user.lang optional (string[]): Languages.

Examples of usage:

// Click suggestion event
var request = {
    rid: '892',
    suggestion: 'White t-shirts'
};

client.feedback('click-suggestion', request);

// Click item event
var request = {
    rid: '892',
    item_id: '9842'
};

client.feedback('click-item', request);

// Redirect event
var request = {
    rid: '892',
    suggestion: 'T-shirt'
};

client.feedback('redirect', request);

// Purchase event
var request = {
    order_id: '451',
    currency: 'usd',
    revenue: 394.1,
    line_items: [{
        item_id: '5028',
        unit_price: 394.1,
        quantity: 2
    }]
};

client.feedback('purchase', request);

// Update cart event
var request = {
    line_items: [{
        item_id: '5028',
        unit_price: 394.1,
        quantity: 2
    }]
};

client.feedback('update-cart', request);

// Add to cart event
var request = {
    item_id: '5720',
    rid: '72046',
    quantity: 1,
};

client.feedback('add-to-cart', request);

// View page event
var request = {
    url: 'some-store.com',
    ref: 'some-referrer.com',
    width: 1366,
    height: 768,
    item_id: '8572'
};

client.feedback('view-page', request);
Suggest Edits

Introduction

This is a PHP SDK for our JSON API

 

Requirements

PHP 5.4.0 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "require": {
    "findify/sdk": "1.*"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

require_once('/path-to-findify-sdk/autoload.php');

Getting Started

Authentication

Please check Authentication to get the API key

Requesting the API

Please follow the installation procedure and then run the following:

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

// Configure API key authorization: key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Key', 'YOUR_API_KEY');

$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;
}

?>