Fetch Shop and Products details

The POST /v1/shop/products/fetch endpoint supports two mutually exclusive request modes:

Shop mode – when shop_url is provided
→ Returns a list of products for a shop

Product mode – when product_url is provided
→ Returns full product details, shop details, reviews, and related content

Supported platform: TikTok Shop

POST /v1/shop/products/fetch

Basic auth

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

{
  "id": "id_01JXY9AZK4KV",
  "work_platform": {
    "id": "id_01JXY9AZK4KV",
    "name": "example",
    "logo_url": "https://example.com/logo"
  },
  "shop": {
    "name": "example",
    "logo_url": "https://example.com/logo",
    "global_sold_count": 1,
    "followers_count": 1,
    "video_count": 1,
    "rating": 1,
    "url": "https://example.com",
    "region": "example",
    "active_product_count": 1,
    "sub_scores": [
      {
        "percentage": 1
      }
    ],
    "creator_name": "example",
    "description": "example"
  },
  "products": [
    {
      "product": {
        "id": "id_01JXY9AZK4KV",
        "status": "example",
        "url": "https://example.com",
        "gmv": 1,
        "base": {
          "title": "example",
          "description_video": "example",
          "images": [
            {}
          ],
          "description_blocks": [
            {}
          ]
        },
        "specifications": [
          {}
        ],
        "sales": {
          "total_sold": 1
        },
        "price": {
          "currency_symbol": "example",
          "discount_percentage": "example"
        },
        "sale_properties": [
          {}
        ],
        "skus": [
          {}
        ],
        "sku_price_display": [
          {}
        ],
        "seller": [
          {}
        ]
      },
      "reviews": {
        "total_count": 1,
        "rating": {
          "overall_score": 1,
          "breakdown": {}
        }
      }
    }
  ],
  "related_contents": [
    {
      "content_id": "content_01JXY9AZK4KV",
      "title": "example",
      "thumbnail_url": "https://example.com/thumbnail",
      "content_media_url": "https://example.com/content-media",
      "creator_name": "example",
      "creator_image_url": "https://example.com/creator-image",
      "url": "https://example.com",
      "creator_profile_url": "https://example.com/creator-profile"
    }
  ],
  "categories": [
    {
      "name": "example"
    }
  ],
  "sale_region": "example",
  "meta": [
    {
      "mode": "example"
    }
  ]
}

Body

application/json

value object

Body

Responses