Skip to main content

Shop Products

Immutable Catalog Entry

This descriptor comes from the active versioned Portal catalog.

READscrape-creators.scrape_creators_tiktok_shop_get_v1_tiktok_shop_products
  • Contract tier: legacy
  • Risk: read
  • Catalog version: scrape-creators-2026.07.12.1
  • Descriptor hash: ab2fc831f9bbe9566b9e13afa945f7573c22e1b948506b6b7d3063714d0778e0

Use this when you need ScrapeCreators TikTok Shop data from GET /v1/tiktok/shop/products for Shop Products. Lists all products from a specific TikTok Shop store by its URL. Returns an array of product objects each with title, cover images, url, price info, sold_count, review_count, and rating. Paginate with cursor from the previous response; filter by region; use sort_by=top for best-selling products or sort_by=new_releases for newest products. Returns the ScrapeCreators response in the standard MCP envelope with ok/data/error/meta. This is read-only. Requires the portal grant header and a ScrapeCreators BYOK API key.

Request Body​

{
  "jsonrpc": "2.0",
  "id": "scrape-creators-scrape-creators-tiktok-shop-get-v1-tiktok-shop-products-example",
  "method": "tools/call",
  "params": {
    "name": "scrape-creators.scrape_creators_tiktok_shop_get_v1_tiktok_shop_products",
    "arguments": {
      "url": "",
      "body": "",
      "cursor": "",
      "params": "",
      "region": "US",
      "compact": "",
      "sort_by": "top",
      "max_items": "",
      "include_raw": false,
      "path_params": ""
    }
  }
}

Arguments Schema​

{
  "type": "object",
  "properties": {
    "url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Url",
      "default": null,
      "description": "The TikTok Shop store URL."
    },
    "body": {
      "anyOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "array",
          "items": {}
        },
        {
          "type": "null"
        }
      ],
      "title": "Body",
      "default": null,
      "description": "JSON request body for provider endpoints that accept one."
    },
    "cursor": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Cursor",
      "default": null,
      "description": "Cursor parameter from the previous response to retrieve the next page of products. Omit for the first page."
    },
    "params": {
      "anyOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "null"
        }
      ],
      "title": "Params",
      "default": null,
      "description": "Optional advanced query parameter object. Prefer the documented top-level parameters when available."
    },
    "region": {
      "enum": [
        "US",
        "GB",
        "DE",
        "FR",
        "IT",
        "ID",
        "MY",
        "MX",
        "PH",
        "SG",
        "ES",
        "TH",
        "VN",
        "BR",
        "JP",
        "IE"
      ],
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Region",
      "default": null,
      "description": "Region to get shop products from. Defaults to US if not provided."
    },
    "compact": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Compact",
      "default": null,
      "description": "When true, trims large list payloads before returning them to the agent."
    },
    "sort_by": {
      "enum": [
        "top",
        "new_releases"
      ],
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Sort By",
      "default": null,
      "description": "Sort products by best-selling items (`top`) or newest products (`new_releases`). Defaults to `top`."
    },
    "max_items": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Max Items",
      "default": null,
      "description": "Maximum number of list items to return when compacting provider responses."
    },
    "include_raw": {
      "type": "boolean",
      "title": "Include Raw",
      "default": false,
      "description": "When true, returns both compact normalized data and the raw provider payload; this can be large."
    },
    "path_params": {
      "anyOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "null"
        }
      ],
      "title": "Path Params",
      "default": null,
      "description": "Path template values for endpoints that expose path placeholders."
    },
    "cache_ttl_seconds": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Cache Ttl Seconds",
      "default": null,
      "description": "Optional cache lifetime for idempotent GET requests."
    },
    "confirm_high_cost": {
      "type": "boolean",
      "title": "Confirm High Cost",
      "default": false,
      "description": "Set true only when intentionally running a high-credit or write-intent request."
    }
  },
  "additionalProperties": false
}

Output Schema​

{
  "type": "object",
  "required": [
    "ok",
    "data",
    "error",
    "meta"
  ],
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Whether the local or provider operation completed successfully."
    },
    "data": {
      "anyOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "array",
          "items": {}
        },
        {
          "type": "string"
        },
        {
          "type": "number"
        },
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "description": "Bounded operation result when ok is true."
    },
    "meta": {
      "type": "object",
      "description": "Safe request, pagination, cache, and timing metadata.",
      "additionalProperties": true
    },
    "error": {
      "anyOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "null"
        }
      ],
      "description": "Safe structured error when ok is false."
    }
  },
  "description": "Scrape Creators MCP normalized response envelope.",
  "additionalProperties": false
}

Code Examples​

curl -X POST 'https://portal.madpanda3d.com/api/mcp' \
  -H 'Authorization: Bearer mad_live_***' \
  -H 'Content-Type: application/json' \
  -d '{
  "jsonrpc": "2.0",
  "id": "scrape-creators-scrape-creators-tiktok-shop-get-v1-tiktok-shop-products-example",
  "method": "tools/call",
  "params": {
    "name": "scrape-creators.scrape_creators_tiktok_shop_get_v1_tiktok_shop_products",
    "arguments": {
      "url": "",
      "body": "",
      "cursor": "",
      "params": "",
      "region": "US",
      "compact": "",
      "sort_by": "top",
      "max_items": "",
      "include_raw": false,
      "path_params": ""
    }
  }
}'

Example Responses​

{
  "ok": true,
  "message": "Tool scrape-creators.scrape_creators_tiktok_shop_get_v1_tiktok_shop_products executed successfully.",
  "note": "Response shape varies by MCP tool. Inspect live responses for exact fields."
}