Skip to main content
POST
/
catalog
/
text_search
{
  "products": [
    {
      "enrichment": {
        "type": "<string>",
        "type_synonyms": [
          "<string>"
        ],
        "tags": [
          "<string>"
        ],
        "styles": [
          "<string>"
        ],
        "image_with_single_product": true
      },
      "id": "<string>",
      "catalog": "<string>",
      "url": "<string>",
      "name": "<string>",
      "type": "<string>",
      "primary_product_id": "<string>",
      "description": "<string>",
      "gtin": "<string>",
      "categories": [
        {
          "name": "<string>",
          "url": "<string>"
        }
      ],
      "brand": {
        "type_": "<string>",
        "name": "<string>",
        "logo": "<string>",
        "url": "<string>",
        "description": "<string>",
        "sameAs": [
          "<string>"
        ]
      },
      "language_code": "<string>",
      "additional_attributes": {},
      "tags": [
        "<string>"
      ],
      "rating": {
        "type": "AggregateRating",
        "rating_count": 123,
        "average_rating": 3,
        "rating_histogram": [
          123
        ]
      },
      "images": [
        {
          "url": "<string>",
          "height": 123,
          "width": 123,
          "gs_url": "<string>",
          "size": 123
        }
      ],
      "image": {
        "url": "<string>",
        "height": 123,
        "width": 123,
        "gs_url": "<string>",
        "size": 123
      },
      "videos": [
        {
          "context": "https://schema.org/",
          "type": "<string>",
          "name": "<string>",
          "description": "<string>",
          "thumbnailUrl": [
            "<any>"
          ],
          "uploadDate": "2023-11-07T05:31:56Z",
          "duration": "<string>",
          "contentUrl": "<string>",
          "embedUrl": "<string>",
          "interactionCount": 123
        }
      ],
      "fulfillment_info": [
        {
          "type": "<string>",
          "place_ids": "<string>"
        }
      ],
      "audience": {
        "genders": [
          "<string>"
        ],
        "age_groups": [
          "<string>"
        ]
      },
      "color_info": {
        "color_families": [
          "<string>"
        ],
        "colors": [
          {}
        ]
      },
      "sizes": [
        "<string>"
      ],
      "materials": [
        "<string>"
      ],
      "fit": "<string>",
      "dimensions": "<string>",
      "patterns": [
        "<string>"
      ],
      "promotions": [
        {
          "promotion_id": "<string>"
        }
      ],
      "breadcrumbList": {
        "context": "https://schema.org/",
        "type_": "BreadcrumbList",
        "itemListElement": []
      },
      "organization": {
        "context": "<string>",
        "type": "<string>",
        "name": "<string>",
        "url": "<string>",
        "logo": "<string>",
        "contactPoint": {
          "type": "<string>",
          "telephone": "<string>",
          "email": "<string>",
          "contactType": "<string>",
          "address": {
            "type": "<any>",
            "streetAddress": "<any>",
            "addressLocality": "<any>",
            "addressRegion": "<any>",
            "postalCode": "<any>",
            "addressCountry": "<any>"
          }
        },
        "sameAs": [
          "<string>"
        ]
      },
      "offers": {
        "type_": "<string>",
        "name": "<string>",
        "priceSpecification": {
          "price": 123,
          "priceCurrency": "<string>",
          "validFrom": "2023-11-07T05:31:56Z",
          "validThrough": "2023-11-07T05:31:56Z"
        },
        "sku": "<string>",
        "availability": "<string>",
        "availabilityStarts": "2023-11-07T05:31:56Z",
        "availabilityEnds": "2023-11-07T05:31:56Z",
        "itemCondition": "<string>",
        "seller": {
          "context": "<string>",
          "type": "<string>",
          "name": "<string>",
          "url": "<string>",
          "logo": "<string>",
          "contactPoint": {},
          "sameAs": [
            "<any>"
          ]
        },
        "inventoryLevel": {
          "value": 123,
          "unitCode": "<string>"
        },
        "eligibleQuantity": {
          "value": 123,
          "unitCode": "<string>"
        }
      },
      "extra_text": "<string>",
      "review": [
        {
          "type_": "<string>",
          "author": {
            "type_": "<any>",
            "name": "<any>"
          },
          "datePublished": "2023-12-25",
          "reviewBody": "<string>",
          "reviewRating": {
            "type": "<any>",
            "rating_count": "<any>",
            "average_rating": "<any>",
            "rating_histogram": "<any>"
          }
        }
      ],
      "three_d_model": [
        {
          "context": "<string>",
          "type_": "<string>",
          "contentUrl": "<string>",
          "encodingFormat": "<string>",
          "uploadDate": "2023-11-07T05:31:56Z",
          "name": "<string>",
          "author": "<string>",
          "license": "<string>",
          "datePublished": "2023-11-07T05:31:56Z",
          "creator": "<string>",
          "contentSize": "<string>",
          "material": "<string>",
          "embedUrl": "<string>",
          "thumbnailUrl": [
            "<any>"
          ],
          "isBasedOnUrl": "<string>",
          "interactionCount": 123,
          "encoding": [
            "<any>"
          ]
        }
      ],
      "productGroupID": "<string>",
      "variesBy": [
        "<string>"
      ],
      "hasVariant": [
        {
          "enrichment": {
            "type": "<string>",
            "type_synonyms": [
              "<string>"
            ],
            "tags": [
              "<string>"
            ],
            "styles": [
              "<string>"
            ],
            "image_with_single_product": true
          },
          "id": "<string>",
          "catalog": "<string>",
          "url": "<string>",
          "name": "<string>",
          "type": "<string>",
          "primary_product_id": "<string>",
          "description": "<string>",
          "gtin": "<string>",
          "categories": [
            {
              "name": "<string>",
              "url": "<string>"
            }
          ],
          "brand": {
            "type_": "<string>",
            "name": "<string>",
            "logo": "<string>",
            "url": "<string>",
            "description": "<string>",
            "sameAs": [
              "<string>"
            ]
          },
          "language_code": "<string>",
          "additional_attributes": {},
          "tags": [
            "<string>"
          ],
          "rating": {
            "type": "AggregateRating",
            "rating_count": 123,
            "average_rating": 3,
            "rating_histogram": [
              123
            ]
          },
          "images": [
            {
              "url": "<string>",
              "height": 123,
              "width": 123,
              "gs_url": "<string>",
              "size": 123
            }
          ],
          "image": {
            "url": "<string>",
            "height": 123,
            "width": 123,
            "gs_url": "<string>",
            "size": 123
          },
          "videos": [
            {
              "context": "https://schema.org/",
              "type": "<string>",
              "name": "<string>",
              "description": "<string>",
              "thumbnailUrl": [
                "<any>"
              ],
              "uploadDate": "2023-11-07T05:31:56Z",
              "duration": "<string>",
              "contentUrl": "<string>",
              "embedUrl": "<string>",
              "interactionCount": 123
            }
          ],
          "fulfillment_info": [
            {
              "type": "<string>",
              "place_ids": "<string>"
            }
          ],
          "audience": {
            "genders": [
              "<string>"
            ],
            "age_groups": [
              "<string>"
            ]
          },
          "color_info": {
            "color_families": [
              "<string>"
            ],
            "colors": [
              {}
            ]
          },
          "sizes": [
            "<string>"
          ],
          "materials": [
            "<string>"
          ],
          "fit": "<string>",
          "dimensions": "<string>",
          "patterns": [
            "<string>"
          ],
          "promotions": [
            {
              "promotion_id": "<string>"
            }
          ],
          "breadcrumbList": {
            "context": "https://schema.org/",
            "type_": "<string>",
            "itemListElement": [
              {}
            ]
          },
          "organization": {
            "context": "<string>",
            "type": "<string>",
            "name": "<string>",
            "url": "<string>",
            "logo": "<string>",
            "contactPoint": {
              "type": "<string>",
              "telephone": "<string>",
              "email": "<string>",
              "contactType": "<string>",
              "address": {}
            },
            "sameAs": [
              "<string>"
            ]
          },
          "offers": {
            "type_": "<string>",
            "name": "<string>",
            "priceSpecification": {
              "price": 123,
              "priceCurrency": "<string>",
              "validFrom": "2023-11-07T05:31:56Z",
              "validThrough": "2023-11-07T05:31:56Z"
            },
            "sku": "<string>",
            "availability": "<string>",
            "availabilityStarts": "2023-11-07T05:31:56Z",
            "availabilityEnds": "2023-11-07T05:31:56Z",
            "itemCondition": "<string>",
            "seller": {
              "context": "<string>",
              "type": "<string>",
              "name": "<string>",
              "url": "<string>",
              "logo": "<string>",
              "contactPoint": {},
              "sameAs": [
                "<any>"
              ]
            },
            "inventoryLevel": {
              "value": 123,
              "unitCode": "<string>"
            },
            "eligibleQuantity": {
              "value": 123,
              "unitCode": "<string>"
            }
          },
          "extra_text": "<string>",
          "review": [
            {
              "type_": "<string>",
              "author": {
                "type_": "<any>",
                "name": "<any>"
              },
              "datePublished": "2023-12-25",
              "reviewBody": "<string>",
              "reviewRating": {
                "type": "<any>",
                "rating_count": "<any>",
                "average_rating": "<any>",
                "rating_histogram": "<any>"
              }
            }
          ],
          "three_d_model": [
            {
              "context": "<string>",
              "type_": "<string>",
              "contentUrl": "<string>",
              "encodingFormat": "<string>",
              "uploadDate": "2023-11-07T05:31:56Z",
              "name": "<string>",
              "author": "<string>",
              "license": "<string>",
              "datePublished": "2023-11-07T05:31:56Z",
              "creator": "<string>",
              "contentSize": "<string>",
              "material": "<string>",
              "embedUrl": "<string>",
              "thumbnailUrl": [
                "<any>"
              ],
              "isBasedOnUrl": "<string>",
              "interactionCount": 123,
              "encoding": [
                "<any>"
              ]
            }
          ]
        }
      ],
      "uuid": "<string>",
      "current_price": 123,
      "original_price": 123,
      "brand_name": "<string>"
    }
  ],
  "total_found": 123,
  "error": "<string>"
}

Body

application/json
​
text
string
required

The text is converted to a vector embedding and used to search for products in the e-commerce catalog with pre-computed product embeddings.

​
limit
integer
default:10

The maximum number of results to return from the search. The default is 10.

​
facets
Facet · object[] | null

The search results will be filtered by the specified facets.

​
price_min
number | null

The products will be filtered to have a price greater than or equal to the specified value.

​
price_max
number | null

The products will be filtered to have a price less than or equal to the specified value.

Response

Successful Response

​
products
SearchProduct · object[]
required

The list of product groups that match the input search query and filters.

​
total_found
integer
required

The total number of products returned by the search.

​
error
string | null

The error message if the search query is invalid or the search failed. The products field will be an empty list if the search fails and total_found will be 0.

⌘I