API Documentation
Product Search
API Documentation
Product Search
API for searching for products & recommendations.
POST
/
query
x-api-key
string
*
x-api-key
Required
string
QueryAPIRequest · object
*
query
Query · object
*
query
Required
object
query
Query · string
*
query
Required
string
num_results
Num Results · integer
num_results
integer
min_price
Min Price · integer
min_price
integer
max_price
Max Price · integer
max_price
integer
session
Session · object
session
object
session_id
Session Id · string
session_id
string
user_id
User Id · string
user_id
string
locale
Locale · string
locale
string
messages
Messages · array
messages
array
Authorizations
x-api-key
string
headerrequiredBody
application/json
query
object
requiredquery.query
string
requiredquery.num_results
integer
default: 5query.min_price
integer
query.max_price
integer
session
object
session.session_id
string
session.user_id
string
session.locale
string
default: en-USmessages
object[]
messages.role
enum<string>
requiredAn enumeration.
Available options:
user, assistant, system messages.type
enum<string>
requiredAn enumeration.
Available options:
message, summary, filter, tag messages.content
string
requiredResponse
200 - application/json
token
string
requiredresults
object[]
results.query
object
requiredresults.query.query
string
requiredresults.query.num_results
integer
default: 5results.query.min_price
integer
results.query.max_price
integer
results.products
object[]
requiredresults.products.merchant_product_id
string
requiredresults.products.merchant_name
string
requiredresults.products.merchant_logo
string
results.products.name
string
requiredresults.products.brand_name
string
results.products.links
object[]
requiredresults.products.links.url
string
requiredresults.products.links.text
string
requiredresults.products.links.type
string
requiredresults.products.thumbnail
string
results.products.upc
string
results.products.status
string
requiredresults.products.price
string
requiredresults.products.shipping_attributes
enum<string>[]
Available options:
free_shipping, one_day_shipping, two_day_shipping, in_store_pickup results.products.extensions
object
results.products.extensions.merchants
object
requiredresults.products.extensions.merchants.data
object[]
requiredresults.products.extensions.merchants.data.title
string
requiredresults.products.extensions.merchants.data.price
object
requiredresults.products.extensions.merchants.data.price.amount
integer
requiredresults.products.extensions.merchants.data.price.currency
string
requiredresults.products.extensions.merchants.data.links
object
requiredresults.products.extensions.merchants.data.links.tagged
string
results.products.extensions.merchants.data.links.original
string
results.products.extensions.merchants.data.images
object
requiredresults.products.extensions.merchants.data.images.thumbnail
string
results.products.extensions.merchants.data.shipping_attributes
enum<string>[]
Available options:
free_shipping, one_day_shipping, two_day_shipping, in_store_pickup Was this page helpful?