Get Recommended Products

1 min

GET

https://api.us1.odp.optimizely.com/v3/recommendations/products

Get recommendations for a customer or product.

Query Parameters

{identifier}=identifier_valuestring
Examples
Email Identifier:
{ "email": "[email protected]" }
Description
The identifier type and its value. Acceptable identifier types include: vuid, email, zaiusalias, and customer_id.
product_idsstring
Description
A comma-separated list of product IDs. Using the product_ids parameter allows you to generate recommended products based on the product IDs passed in.
typestring
Description
The type of recommendation requested. Acceptable values are: personal and contextual.
Allowed
personalcontextual
criteriaobject
Description
Filter criteria applied to the recommendations returned. you can use any field on the product schema to filter. See above for the filter construct.
sort_bystring
Description
Product field to sort by, which can be any base or custom field defined in your Product schema. Default sort is highest to lowest recommendation rank. Changing this will not change which products are returned, only the order in which they display in the array.
orderstring
Description
Options are asc and desc. Order in which to sort the resulting products. Changing this will not change which products are returned, only the order in which they display in the array. This will not change the order of products if there is no sort specified.
Default
asc
Allowed
ascdesc
limitstring
Description
The number of products to return. Must be an integer value from 1 to 100. Default is 10.
Default
10
Minimum
1
Maximum
100

Responses

200OK

Recommendation

Example

[
  {
    "product_id": "1234BLK",
    "name": "Basics - Black",
    "brand": "Jungle James Basics",
    "sku": "1234BLK",
    "upc": "042100005264",
    "image_url": "https://http.cat/404",
    "price": 25.99,
    "parent_product_id": "1234",
    "recommendation_type": "contextual"
  },
  {
    "product_id": "1234BLU",
    "name": "Basics - Blue",
    "brand": "Jungle James Basics",
    "sku": "1234BLU",
    "upc": "042100005265",
    "image_url": "https://http.cat/404",
    "price": 25.99,
    "parent_product_id": "1234",
    "recommendation_type": "contextual"
  }
]

product_idstring
Example
1234BLK
namestring
Example
Basics - Black
brandstring
Example
Jungle James Basics
skustring
Example
1234BLK
upcstring
Example
042100005264
image_urlstring
Example
https://http.cat/404
pricenumber
Example
25.99
Default
0
parent_product_idstring
Example
1234
recommendation_typestring
Example
contextual

400Bad Request

undefined

Example

{
  "title": "Bad Request",
  "status": 400,
  "timestamp": "2018-09-10T21:07:10-05:00",
  "detail": {
    "invalids": [
      {
        "field": "delimiter",
        "reason": "Unrecognized delimiter, valid options are comma, tab or pipe"
      }
    ]
  }
}

403Forbidden

undefined
Example
```
{
  "message": "Forbidden"
}
```

curl

curl --request GET \
     --url 'https://api.us1.odp.optimizely.com/v3/recommendations/products?criteria=object&order=asc&limit=10' \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.us1.odp.optimizely.com/v3/recommendations/products?criteria=object&order=asc&limit=10", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.us1.odp.optimizely.com/v3/recommendations/products?criteria=object&order=asc&limit=10")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.us1.odp.optimizely.com/v3/recommendations/products?criteria=object&order=asc&limit=10"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// OK
{
  "product_id": "1234BLK",
  "name": "Basics - Black",
  "brand": "Jungle James Basics",
  "sku": "1234BLK",
  "upc": "042100005264",
  "image_url": "https://http.cat/404",
  "price": 25.99,
  "parent_product_id": "1234",
  "recommendation_type": "contextual"
}

400

// Bad Request
"{\"title\":\"Bad Request\",\"status\":400,\"timestamp\":\"2018-09-10T21:07:10-05:00\",\"detail\":{\"invalids\":[{\"field\":\"delimiter\",\"reason\":\"Unrecognized delimiter, valid options are comma, tab or pipe\"}]}}"

403

// Forbidden
"{  \"message\": \"Forbidden\"}"