Docs
Ctrl+K Rechercher Alt+[Alt+] Guides
Obtenir une clé API

API · TikTok Shop

API TikTok Shop — filtres et paramètres de requête

Cette référence s'adresse aux intégrateurs qui appellent /api/v1/tiktok-shop/* avec un Clé API, ou les mêmes formes de chemin sous /api/tiktok-shop/... lorsqu'on est connecté session de navigation. Liste des routes HTTP et comportement général : Référence API.


Comment les paramètres sont-ils

Mécanisme Détails
Chaîne de requête Comme d'habitude pour GET.
POST JSON Pour les routes « explore » et « count » qui acceptent les requêtes POST, un objet JSON inclus dans le corps de la requête est fusionné avec les paramètres de requête (clés identiques à celles des tableaux ci-dessous). Utilisez cette méthode lorsque les ensembles de filtres sont volumineux (cela permet d'éviter l'erreur 414 « URI Too Long »).
Formulaire POST application/x-www-form-urlencoded Le corps est également intégré dans les paramètres.
Omis / vide Chaîne vide, null, ou la chaîne de caractères littérale « indéfini » sont supprimés et généralement ignorés.

Explorer et compter (catégories, boutiques, créateurs, vidéos, produits)

Cela correspond à :

Suffixe de route (sous /api/v1/tiktok-shop/) Objectif
catégories/découvrir, catégories/nombre Afficher ou filtrer les catégories / compter les occurrences
boutiques/découvrir, nombre de magasins Afficher ou rechercher des magasins / compter les résultats
Créateurs/Découvrir, nombre de créateurs Afficher la liste des créateurs ou effectuer une recherche / compter les occurrences
vidéos/découvrir, nombre de vidéos Afficher ou rechercher des vidéos / compter les résultats
produits/découvrir, nombre de produits Afficher ou rechercher des produits / compter les résultats

Pagination et tri (en mode exploration uniquement ; non pris en compte dans le décompte)

Paramètre Par défaut Remarques
page 1 Page entière.
limite 20 Format de la page.
après Curseur de jeu de touches opaque (paginate en avant).
inclure le total Si présent, transmis en amont.
saut de point de contrôle Si présent, transmis en amont.
trier Voir le tri par défaut par entité ci-dessous Upstream mappe les champs de tri spécifiques à une période.
commande desc Sens de tri.

Définition de la portée des catégories (explorer et compter, quand a_une_hiérarchie_de_catégories (si c'est vrai)

Paramètre Remarques
identifiants de catégorie Séparés par des virgules ou sous forme de tableau ; fusionnés avec les identifiants de niveau ci-dessous.
id_catégorie_l1, id_catégorie_l2, id_catégorie_l3 Identifiant unique ; plusieurs pseudonymes identifiants_catégorie_l1, identifiants_catégorie_l2, identifiants de catégorie de niveau 3 sont également acceptés.
exclure_ids_catégories Liste séparée par des virgules à exclure.

Valeurs par

Paramètre Par défaut
pays ÉTATS-UNIS

spécifiques à une entité

Chaque entité met à disposition un ensemble de filtres autorisés. Les requêtes utilisent les noms de paramètres canoniques; les alias acceptent des noms alternatifs (de même valeur).

Catégories — tri par défaut: origine_des_recettes

Filtres
pays, niveau, identifiants de catégorie, nom, période, chiffre d'affaires minimum, chiffre d'affaires maximal, chiffre d'affaires minimum par magasin, chiffre d'affaires maximal par boutique, min_top_3_shop_ratio, max_top_3_shop_ratio, min_top_10_ratio_boutique, max_top_10_shop_ratio, nombre_min_de_boutiques, nombre_max_de_boutiques, nombre_min_de_vidéos, nombre_max_de_vidéos

Alias : chiffre d'affaires minimumchiffre d'affaires minimum sur 30 jours; chiffre d'affaires maximalchiffre_d'affaires_max_sur_30_jours.

Magasins — tri par défaut: chiffre d'affaires

Filtres
pays, nom, période, identifiants de catégorie, chiffre d'affaires minimum, chiffre d'affaires maximal, taux_de_croissance_minimal_du_chiffre_d'affaires, taux_de_croissance_maximal_du_chiffre_d'affaires, taux_de_croissance_min_des_ventes, taux_de_croissance_maximal_des_ventes, vu pour la première fois, note_minimale, note_max, type de vendeur, nombre_min_de_produits, nombre_max_de_produits, prix_moyen_min_par_unité, prix_moyen_max_par_unité, nombre_min_de_créateurs, nombre_maximal_de_créateurs, nombre_min_de_vidéos, nombre_max_de_vidéos, pourcentage_de_canaux_gérés_en_interne, pourcentage_de_stratégies_gérées_en_interne

Alias : chiffre d'affaires minimummin_gmv_30j; chiffre d'affaires maximalmax_gmv_30j; taux_de_croissance_minimal_du_chiffre_d'affairestaux_de_croissance_du_GMV_sur_30_jours; taux_de_croissance_maximal_du_chiffre_d'affairestaux_de_croissance_du_GMV_sur_30_jours; prix_moyen_min_par_unitéprix_moyen_min; prix_moyen_max_par_unitéprix_moyen_max.

Créateurs — tri par défaut: chiffre d'affaires

Filtres
pays, nom, période, identifiants de catégorie, chiffre d'affaires minimum, chiffre d'affaires maximal, taux_de_croissance_minimal_du_chiffre_d'affaires, taux_de_croissance_maximal_du_chiffre_d'affaires, taux_de_croissance_min_des_abonnés, taux_de_croissance_max_des_abonnés, taux_de_croissance_min_des_vues, taux_de_croissance_max_des_vues, nombre_min_d'abonnés, nombre_max_d'abonnés, nombre_min_de_vues, nombre_max_de_vues, vérifié, nombre_min_de_produits, nombre_max_de_produits, nombre_min_de_vidéos, nombre_max_de_vidéos

Alias : chiffre d'affaires minimummin_gmv_30j; chiffre d'affaires maximalmax_gmv_30j.

Vidéos — tri par défaut: chiffre d'affaires

Filtres
pays, nom, période, identifiants de catégorie, chiffre d'affaires minimum, chiffre d'affaires maximal, taux_de_croissance_minimal_du_chiffre_d'affaires, taux_de_croissance_maximal_du_chiffre_d'affaires, taux_de_croissance_min_des_vues, taux_de_croissance_max_des_vues, taux_de_croissance_min_des_likes, taux_de_croissance_max_des_likes, taux_de_croissance_min_des_actions, taux_de_croissance_max_des_actions, nombre_min_de_vues, nombre_max_de_vues, durée minimale, durée_max, ROAS minimal, max_ROAS, dépense_publicitaire_minimale, dépense_max_en_publicité, nombre_min_de_likes, nombre_max_de_likes, nombre_min_d'abonnés_du_créateur, nombre_maximal_d'abonnés_du_créateur, date_de_publication, is_ad, est-affilié, est-ce de l'autopromotion ?, is_ai_ugc, évolution_du_chiffre_d'affaires

Produits — tri par défaut: chiffre d'affaires

Filtres
pays, nom, période, identifiants de catégorie, chiffre d'affaires minimum, chiffre d'affaires maximal, taux_de_croissance_minimal_du_chiffre_d'affaires, taux_de_croissance_maximal_du_chiffre_d'affaires, taux_de_croissance_min_des_ventes, taux_de_croissance_maximal_des_ventes, nombre_min_d'articles_vendus, nombre_maximal_d'articles_vendus, nombre_min_de_ventes, nombre_max_d'unités_vendues, prix_moyen_min_par_unité, prix_moyen_max_par_unité, taux_de_commission_min, taux_de_commission_maximal, note_min_produit, score_max_du_produit, nombre_min_d'avis_sur_le_produit, nombre_max_d'avis_sur_un_produit, nombre_min_de_créateurs, nombre_maximal_de_créateurs, date_min_de_lancement_du_produit, date_maximale_de_lancement_du_produit, taux_de_conversion_min_du_créateur, max_creator_conversion_ratio, vu pour la première fois, prix_min, prix_max

Alias : nombre_min_d'articles_vendusnombre_min_vendu; nombre_maximal_d'articles_vendusnombre maximal de ventes.

Autorisé trier valeurs

Les clés de tri sont pas détaillées dans ce document ; le service d'analyse en amont associe des clés de tri génériques à des champs spécifiques à une période. Traiter trier sous forme de chaîne opaque alignée sur l'interface utilisateur du filtre de l'application web, ou en inspectant les requêtes réseau depuis le tableau de bord pour cette même entité.

réservés au tableau de bord

Ne vous fiez pas aux indicateurs de requête du tableau de bord non documentés pour le comptage. Pour les intégrations API, envoyez uniquement les filtres décrits ci-dessus et suivez les instructions de la section « Crédits et facturation ».


GET /api/v1/tiktok-shop/products

Paramètres de requête (tous facultatifs sauf « auth ») :

Paramètre Par défaut
page 0
limite 20
trier description_vente
catégorie, prix_min, prix_max, chiffre d'affaires minimum, chiffre d'affaires maximal, note_minimale, date_de_début, date_to, rechercher, pays

GET /api/v1/tiktok-shop/search (Rechercher des produits)

Paramètre Obligatoire
q Oui (chaîne de recherche)
page Non (0 (par défaut)
limite Non (20 (par défaut)
catégorie Non

GETtrending (getTrendingProducts)

Paramètre Par défaut
limite 10
période 7 jours
catégorie

GET /api/v1/tiktok-shop/shop-details / boutiques/détails (Obtenir les détails de la boutique)

Paramètre Obligatoire
id Oui — identifiant du magasin

GET /api/v1/tiktok-shop/suggestions (suggestions)

Paramètre Obligatoire Remarques
type Oui L'un des suivants : catégories, magasins, créateurs, produits, vidéos.
q Oui Nom partiel ; si le champ est vide, aucune suggestion n'est affichée.
limite Non 1–20, par défaut 10.
pays Non Par défaut ÉTATS-UNIS.

Hiérarchie et statiques#

Chemin Paramètres
catégories/hiérarchie, catégories/couches pays (par défaut ÉTATS-UNIS).
catégories/résumé, catégories/historique, … Principalement OBTENIR paramètres de requête (pays, identifiants, période, …) ; consultez l'onglet « Réseau » de l'application pour connaître la structure exacte de chaque itinéraire.

Pour PUBLICATION véhicules sur les itinéraires de service (détails de la boutique, détails du produit, etc.), chaque route a sa propre structure JSON — capturez une requête depuis le tableau de bord pour l'onglet qui vous intéresse, puis relancez-la sur /api/v1/tiktok-shop/... avec votre clé API.


Outils MCP (mêmes données que dans « Explorer »)

Si vous utilisez Protocole de contexte de modèle (Claude Desktop, etc.), les outils TikTok génèrent le mêmes charges utiles « explore » et « count » l'API HTTP accepte — même logique de filtrage conformément au présent document, le cas échéant (mot-clé, pays, page, taille par rapport à HTTP limite, les limites de chiffre d'affaires ou de prix des produits, …).

Outil MCP Cartes vers
rechercher_des_produits_sur_TikTok produits/découvrir
rechercher_sur_TikTok_Shops boutiques/découvrir
rechercher_des_créateurs_sur_TikTok Créateurs/Découvrir
rechercher_des_vidéos_sur_TikTok vidéos/découvrir
nombre_d'entités_TikTok Compte les résultats correspondant aux mêmes filtres que ceux utilisés dans le découvrir critères d'évaluation.
Parcourir les catégories TikTok, liste_catégorie_top_TikTok, suggestion automatique_TikTok Hiérarchie des catégories / Niveaux / Résumé / Historique / Éléments apparentés / Classements / Suggestions
récupérer_produit_tiktok, get_tiktok_shop, get_tiktok_creator, récupérer_vidéo_TikTok Détails et segments de données (métriques, historique, listes, stratégie) — voir la documentation des outils MCP
get_tiktok_trending_products C'est la même chose que GETtrending (section ci-dessous)
générique C'est la même chose que GET /api/v1/tiktok-shop/credits

Noms complets des arguments : MCP · Référence des outils.


Où chercher

Préoccupation Localisation
Liste des routes (chemins + verbes) Référence API — Section TikTok Shop
Filtres et corps (ce document) Tableaux ci-dessus
Détails de l'entité (corps JSON) Informations sur TikTok Shop
ce](/docs/api) — Section TikTok Shop
Filtres et corps (ce document) Tableaux ci-dessus + captures réseau intégrées à l'application pour les cas particuliers