Search products using keyword

Search for products using publicly available data based on your search query.

Supported platform: TikTok Shop

POST /v1/shop/products/search

Basic auth

curl 'https://api.staging.insightiq.ai/v1/shop/products/search' \
  --request POST \
  --header 'Authorization: Basic YOUR_BASE64_CREDENTIALS' \
  --header 'Content-Type: application/json' \
  --data '{
  "work_platform_id": "work_platform_01JXY9AZK4KV",
  "keyword": "example"
}'

{
  "query": "example",
  "work_platform": {
    "id": "id_01JXY9AZK4KV",
    "name": "example",
    "logo_url": "https://example.com/logo"
  },
  "total_products": 1,
  "products": [
    {
      "product": {
        "id": "id_01JXY9AZK4KV",
        "title": "example",
        "image_url": "https://example.com/image"
      },
      "price": {
        "symbol_position": "example"
      },
      "skus": [
        {
          "id": "id_01JXY9AZK4KV",
          "price": {}
        }
      ],
      "sales": {
        "total_sold": 1
      },
      "seller": {
        "id": "id_01JXY9AZK4KV"
      },
      "url": "https://example.com",
      "reviews": {
        "rating": {
          "overall_score": "example"
        },
        "total_count": 1
      },
      "shop": {
        "name": "example",
        "logo_url": "https://example.com/logo"
      }
    }
  ]
}

Body

application/json

work_platform_id string required

UUID for the platform on which you want to fetch list of products using keyword.

keyword string

Keyword to fetch list of products.

Body

Responses