Guides

How to implement the "SearchProduct by URL" API

Catalog management

Suggest Edits

URL Search in OmniChat
When using URL-based search, you benefit from OmniChat’s SERP model, which leverages the power of Google’s search engine to find the most relevant products based on the provided search term. Additionally, it’s possible to perform image-based searches using Google Lens, offering a more visual and intuitive experience for users.

⚠️

Note: The effectiveness of SERP and Google Lens searches depends directly on the SEO quality of your store.

Benefits of using URL search in OmniChat:

  • Take advantage of OmniChat’s SERP module, powered by Google Search.
  • Perform image searches using Google Lens.
  • Achieve greater accuracy in search results.
  • Provide an enhanced experience with OmniChat’s Whizz Agent, increasing your conversion rates.

Whenever a product is queried by OmniChat, this API will be called and should return a list of products, following the pattern below:

[
    {
        "blocked": false,
        "objectId": "12345",
        "name": "iPhone 14 Pro",
        "productDescription": "Produto de teste",
        "externalUrl": "https://www.apple.com/br/iphone-14-pro/",
        "mainVariant": {
            "objectId": "12345-1",
            "externalImageURL": "https://www.apple.com/newsroom/images/product/iphone/geo/Apple-iPhone-14-Pro-iPhone-14-Pro-Max-deep-purple-220907-geo_inline.jpg.large.jpg",
            "erpId": "12345-2",
            "name": "iPhone 14 Pro 128gb Purple",
            "visible": true,
            "price": 9499.99,
            "salePrice": 9400,
            "quantity": 30,
            "sellerId": "1",
            "sellerName": "Apple",
            "width": 7.15,
            "height": 14.8,
            "variantLength": 1,
            "weight": 206,
            "variations": [
                {
                    "key": "Cor",
                    "value": "Purple"
                },
                {
                    "key": "Memória",
                    "value": "128gb"
                }
            ]
        },
        "variants": [
            {
                "objectId": "12345-1",
                "externalImageURL": "https://www.apple.com/newsroom/images/product/iphone/geo/Apple-iPhone-14-Pro-iPhone-14-Pro-Max-deep-purple-220907-geo_inline.jpg.large.jpg",
                "erpId": "54321-1",
                "name": "iPhone 14 Pro 128gb Purple",
                "visible": true,
                "price": 9499.99,
                "salePrice": 9400,
                "quantity": 30,
                "sellerId": "1",
                "sellerName": "Apple",
                "width": 7.15,
                "height": 14.8,
                "variantLength": 1,
                "weight": 206,
                "variations": [
                    {
                        "key": "Cor",
                        "value": "Purple"
                    },
                    {
                        "key": "Memória",
                        "value": "128gb"
                    }
                ]
            },
            {
                "objectId": "12345-2",
                "externalImageURL": "https://store.storeimages.cdn-apple.com/4982/as-images.apple.com/is/iphone-14-pro-gold-witb-202209_FMT_WHH?wid=560&hei=744&fmt=jpeg&qlt=90&.v=1660789320262",
                "erpId": "54321-2",
                "name": "iPhone 14 Pro 128gb Gold",
                "visible": true,
                "price": 9399.99,
                "salePrice": 9200,
                "quantity": 28,
                "sellerId": "1",
                "sellerName": "Apple",
                "width": 7.15,
                "height": 14.8,
                "variantLength": 1,
                "weight": 206,
                "variations": [
                    {
                        "key": "Cor",
                        "value": "Gold"
                    },
                    {
                        "key": "Memória",
                        "value": "128gb"
                    }
                ]
            },
            {
                "objectId": "12345-3",
                "externalImageURL": "https://www.apple.com/newsroom/images/product/iphone/geo/Apple-iPhone-14-Pro-iPhone-14-Pro-Max-silver-220907-geo_inline.jpg.large.jpg",
                "erpId": "54321-2",
                "name": "iPhone 14 Pro 128gb Silver",
                "visible": true,
                "price": 9499.99,
                "salePrice": 9499.99,
                "quantity": 0,
                "sellerId": "1",
                "sellerName": "Apple",
                "width": 7.15,
                "height": 14.8,
                "variantLength": 1,
                "weight": 206,
                "variations": [
                    {
                        "key": "Cor",
                        "value": "Gold"
                    },
                    {
                        "key": "Memória",
                        "value": "128gb"
                    }
                ]
            }
        ],
        "sellOutOfStock": false,
        "trackInventory": true
    }
]

To perform the search by URL, you will receive in your endpoint the queryParams with the searchType property equal to URL and its value will be a string array containing the URLs to be searched.

Example:

curl --location 'https://your_endpoint?searchType=URL&query=["https://omni.chat/products/iphone-16-128","https://omni.chat/products/iphone-16-512"]'

Updated 6 days ago