Page Comparison

...

Purpose

Search

Endpoint

/api/v1/search

Method

GET
POST

(GET) Request params

(GET) Request optional params

(GET) Response fields

(GET) Response example

query: (type: string) search query
write_key: (type: string) company write_key, system field

anonymous_id: (type: uuid) person identifier, generated by epica.js
prev_query: (type: string) previous search query

autocomplete_items: (type: array(string)) query suggestions
found_products: (type: array(object)) relevant items from feed
query: (type: string) search query
found_categories: (type: array(object)) relevant categories from feed

Code Block

language	json

{
 "found_products": [
 {
 "price": 51.0,
 "title": "INSULAR Mummy Diaper Backpack Fashionable Large Capacity Mother Bag Multifunctional Travel Baby Backpack bag Nappy Bags",
 "score": 191.12119,
 "url": "https://demo-ec.epica.ai/products/insular-mummy-diaper-backpack-fashionable-large-capacity-mother-bag-multifunctional-travel-baby-backpack-stroller-bag-nappy-bags?variant=26562489581632",
 "discount_percent": 0,
 "image": "https://cdn2.shopify.com/s/files/1/0055/3143/5072/products/product-image-816957997.jpg?v=1552300692",
 "sku": "3207712833600_26562489581632",
 "discount": 51.0
 },
 {
 "price": 64.0,
 "title": "Diaper bag nappy",
 "score": 191.57248,
 "url": "https://demo-ec.epica.ai/products/baby-stroller-bag-fashion-mummy-bags-large-diaper-bag-backpack-baby-organizer-maternity-bags-for-mother-handbag-nappy-backpack?variant=26562746449984",
 "discount_percent": 0,
 "image": "https://cdn2.shopify.com/s/files/1/0055/3143/5072/products/product-image-508608478.jpg?v=1552300978",
 "sku": "3207756709952_26562746449984",
 "discount": 64.0
 }
 ],
 "found_products_count": 44,
 "autocomplete_items": [
 "red bag dollar",
 "red bags",
 "bag"
 ],
 "query": "red bag",
 "found_categories": [
 {
 "url": "https://demo-ec.epica.ai/collections/home-page",
 "title": "Home Page"
 },
 {
 "url": "https://demo-ec.epica.ai/collections/diaper-bags",
 "title": "Diaper Bags"
 }
 ]
}

(POST) Request body params

(POST) Request body optional params

(POST) Response fields

query: (type: string) search query
write_key: (type: string) company write_key, system field

anonymous_id: (type: uuid) person identifier, generated by epica.js
prev_query: (type: string) previous search query
filters: (type: object) search filters, more info in /api/v1/search/filter
page: (type: int) pagination

Code Block

language	json

{
 "found_products_count": 44,
 "query": "red bag",
 "found_products": [
 {
 "price": 51.0,
 "title": "INSULAR Mummy Diaper Backpack Fashionable Large Capacity Mother Bag Multifunctional Travel Baby Backpack bag Nappy Bags",
 "score": 191.12119,
 "url": "https://demo-ec.epica.ai/products/insular-mummy-diaper-backpack-fashionable-large-capacity-mother-bag-multifunctional-travel-baby-backpack-stroller-bag-nappy-bags?variant=26562489581632",
 "discount_percent": 0,
 "image": "https://cdn2.shopify.com/s/files/1/0055/3143/5072/products/product-image-816957997.jpg?v=1552300692",
 "sku": "3207712833600_26562489581632",
 "discount": 51.0
 },
 ...
 {
 "price": 61.0,
 "title": "Insular Mummy Maternity Diaper Bag Large Capacity Baby Stroller Bag Travel Nappy Backpack Designer Nursing Bag For Baby Care",
 "score": 23.472298,
 "url": "https://demo-ec.epica.ai/products/insular-mummy-maternity-diaper-bag-large-capacity-baby-stroller-bag-travel-nappy-backpack-designer-nursing-bag-for-baby-care?variant=26562233925696",
 "discount_percent": 0,
 "image": "https://cdn2.shopify.com/s/files/1/0055/3143/5072/products/product-image-786499954.jpg?v=1552300411",
 "sku": "3207670890560_26562233925696",
 "discount": 61.0
 }
 ],
 "page": 1,
 "filters": [
 {
 "max": 282.0,
 "title": "Price",
 "current_max": 282.0,
 "type": "price",
 "current_min": 1.0,
 "min": 1.0
 },
 {
 "based_on": "tag",
 "position": 1,
 "title": "All tag",
 "filter": "",
 "type": "filter",
 "values": [
 {
 "name": "0",
 "count": 1
 },
 ...
 {
 "name": "car seats",
 "count": 1
 }
 ],
 "id": 1
 },
 {
 "based_on": "collection",
 "position": 2,
 "title": "All collection",
 "filter": "",
 "type": "filter",
 "values": [
 {
 "name": "Diaper Bags",
 "count": 23
 },
 {
 "name": "Highchairs & Booster Seats",
 "count": 1
 },
 {
 "name": "Home Page",
 "count": 44
 }
 ]
 ...
 }
 ],
 "total_pages": 3
}

Errors

401: unauthorized. It means that you have not passed JWT auth. More info in API Authentication

Curl Example

Code Block
GET: curl -X GET -H "Content-Type: application/json" "https://api.epica.ai/api/v1/search?query=red%20stroller&write_key=6682adba374255dc50091d6d3702f36d"

...

Versions Compared

Old Version 3

New Version Current

Key