DataNavoAPI / APIS / TIKTOK

TikTok Shop product search

TikTok Shop product search: inspect inputs, product fields, pagination and limits, then run a local simulated request.

LOCAL SIMULATIONAll displayed records are fictional fixtures. Live APIs, payments and external email are disabled.中文版 ↗
01

What this capability does

TikTok Shop product search uses /v1/tiktok/shop/products/search; GET returns data.items with product objects.

This is a local simulation. Program-generated samples are not live platform data and do not establish provider availability.

  • Capability: tiktok.shop.products.search
  • Pagination: no cursor pagination; do not repeatedly request another page.
02

Input contract

Inspect meanings, examples and conditional rules for the selected method. view and fields control the response without changing the TEST unit price.

  • Only send fields defined for this method; unknown fields are rejected before execution.
MethodFieldTypeRequirementMeaningEnum or boundExample
GETquerystringRequiredSearch terms—"yoga mat"
GETviewstringOptional / conditionalHow much of each item: compact (the most used fields, long text cut short), standard, or full (adds `ext`).["compact","standard","full"]—
GETfieldsarrayOptional / conditionalReturn only these fields of each item, by path (`author.name`).maxItems: 64—
03

Try it locally

Use demo to inspect the fields, then explicitly select simulated with a customer test key to exercise settlement. Never put a customer key in a URL.

json
{
  "capability": "tiktok.shop.products.search",
  "method": "GET",
  "params": {
    "query": "yoga mat"
  }
}
04

Output fields and interpretation

The product object permits missing or null values; do not replace missing measurements with zero. This table shows the main structure; the object reference covers nested fields.

FieldTypeMeaningSource scope
idstring | nullID; pass it unchanged to the endpoints that get the product and list its reviewsTikTok
urlstring | nullLink that opens the productTikTok
titlestring | nullTitle of the productTikTok
descriptionstring | nullThe text of the product's description (standard view and up)TikTok
pricestring | nullCurrent price; the lowest one when its variants are priced differentlyTikTok
original_pricestring | nullThe price before the discount; null when there is none (standard view and up)TikTok
currencystring | nullCurrency of the prices, an ISO 4217 codeTikTok
imagesarray | nullAddresses of the product's pictures (standard view and up)TikTok
ratingnumber | nullBuyers' rating, out of 5TikTok
metricsobject | nullProduct countsTikTok
metrics.soldinteger | nullUnits soldTikTok
metrics.reviewsinteger | nullReviewsTikTok
shopobject | nullThe shop that sells itTikTok
shop.idstring | nullShop IDTikTok
shop.namestring | nullName of the shopTikTok
approximatearray | nullWhich numbers of this item are approximate or lower bounds; absent when all are exactTikTok
approximate[].fieldstring | nullPath of the field, such as metrics.viewsTikTok
approximate[].kindstring | nullApproximate, or a lower boundTikTok
extobject—TikTok
ext.page_pricestring | nullThe price the product's page shows (its lowest variant), in currency. Recorded higher than the same product's price in its shop's list and in the search by about a shipping fee (30.99 on the page, 25 in the list, a fee of 5.99); what a buyer pays is what the checkout says (full view)TikTok
ext.shipping_feestring | nullThe standard shipping fee the product's page shows, in currency (full view)TikTok
ext.shop_ratingnumber | nullThe shop's rating, out of 5 (full view)TikTok
ext.shop_followersinteger | nullFollowers of the shop (full view)TikTok
ext.shop_productsinteger | nullProducts the shop has on sale (full view)TikTok
05

Unavailable fields

These published contract notes describe the capability boundary; fixtures do not establish live availability.

FieldReason
descriptioncapability
metrics.reviewscapability
06

Limits and checks

A successful request does not establish full coverage. Preserve the request ID, observation time, parameters and cursor, and inspect the returned items before analysis.

Local simulation uses TEST credits only. Real provider calls, real payments and external email are disabled. Historical reference-site prices are not DataNavoAPI prices.

  • Verify media URLs, counts and optional fields individually.
TRY THE CONTRACT

Clear inputs. Inspectable output.

Each click runs a local fixture. Advanced JSON inputs are checked against the selected method. Editing does not execute a request.

Copying does not execute. CLI quote is read-only and needs a local customer TEST key. Configure MCP in demo mode first. GET and POST batches both return only fictional local fixtures.

Download contract example (no execution) ↗

For TEST budgets, Key scopes or failure scenarios, open the account console. Customer sandbox ↗