Get Recommended Products

get

https://api.zaius.com/v3/recommendations/products

Get recommendations for a customer or product.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Structuring criteria filters:

{"expression":
  {"operator": "AND",
   "predicates": 
     [{"field": "_on_sale",
       "datatype": "boolean",
       "value": "false",
       "operator": "="},
      {"field": "_gender",
       "datatype": "char",
       "value": "mens",
       "operator": "="}]
   }
}

Query Params

{identifier}=identifier_value

string

The identifier type and its value. Acceptable identifier types include: vuid, email, zaiusalias, and customer_id.

product_ids

string

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.

type

string

enum

The type of recommendation requested. Acceptable values are: personal and contextual.

Allowed:

criteria

object

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_by

string

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.

order

string

enum

Defaults to asc

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.

Allowed:

limit

string

1 to 100

Defaults to 10

The number of products to return. Must be an integer value from 1 to 100. Default is 10.

Responses

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400Bad Request

403Forbidden