API Documentation
Product Search
API Documentation
Product Search
API for searching for products & recommendations.
POST
/
query
curl --request POST \
--url https://api.ioniccommerce.com/query \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"query": {
"query": "<string>",
"num_results": 5,
"min_price": 500000,
"max_price": 500000
},
"session": {
"session_id": "<string>",
"user_id": "<string>",
"locale": "en-US"
},
"messages": [
{
"role": "user",
"type": "message",
"content": "<string>"
}
]
}'
{
"token": "<string>",
"results": [
{
"query": {
"query": "<string>",
"num_results": 5,
"min_price": 500000,
"max_price": 500000
},
"products": [
{
"merchant_product_id": "<string>",
"merchant_name": "<string>",
"merchant_logo": "<string>",
"name": "<string>",
"brand_name": "<string>",
"links": [
{
"url": "<string>",
"text": "<string>",
"type": "<string>"
}
],
"thumbnail": "<string>",
"upc": "<string>",
"status": "<string>",
"price": "<string>",
"shipping_attributes": [
"free_shipping"
],
"extensions": {
"merchants": {
"data": [
{
"title": "<string>",
"price": {
"amount": 123,
"currency": "<string>"
},
"links": {
"tagged": "<string>",
"original": "<string>"
},
"images": {
"thumbnail": "<string>"
},
"shipping_attributes": [
"free_shipping"
]
}
]
}
}
}
]
}
]
}
Authorizations
Body
application/json
Response
200
application/json
Successful Response
An enumeration.
Available options:
free_shipping
, one_day_shipping
, two_day_shipping
, in_store_pickup
Was this page helpful?
curl --request POST \
--url https://api.ioniccommerce.com/query \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"query": {
"query": "<string>",
"num_results": 5,
"min_price": 500000,
"max_price": 500000
},
"session": {
"session_id": "<string>",
"user_id": "<string>",
"locale": "en-US"
},
"messages": [
{
"role": "user",
"type": "message",
"content": "<string>"
}
]
}'
{
"token": "<string>",
"results": [
{
"query": {
"query": "<string>",
"num_results": 5,
"min_price": 500000,
"max_price": 500000
},
"products": [
{
"merchant_product_id": "<string>",
"merchant_name": "<string>",
"merchant_logo": "<string>",
"name": "<string>",
"brand_name": "<string>",
"links": [
{
"url": "<string>",
"text": "<string>",
"type": "<string>"
}
],
"thumbnail": "<string>",
"upc": "<string>",
"status": "<string>",
"price": "<string>",
"shipping_attributes": [
"free_shipping"
],
"extensions": {
"merchants": {
"data": [
{
"title": "<string>",
"price": {
"amount": 123,
"currency": "<string>"
},
"links": {
"tagged": "<string>",
"original": "<string>"
},
"images": {
"thumbnail": "<string>"
},
"shipping_attributes": [
"free_shipping"
]
}
]
}
}
}
]
}
]
}