API reference
TikTok Shop
- GET
/tik_tok_shop/affiliate/creator_activityActive, new, returning, retained and churned affiliate creators per week or month - GET
/tik_tok_shop/affiliate/creatorsThe shop's affiliate creators ranked by GMV over a date window - GET
/tik_tok_shop/affiliate/order_linesAffiliate order lines, one per order and SKU, newest first - GET
/tik_tok_shop/affiliate/summaryThe shop's affiliate totals over a date window - GET
/tik_tok_shop/analytics/channel_mixThe shop's GMV by sales channel: seller and affiliate video, LIVE and product card - GET
/tik_tok_shop/analytics/products/{productId}/performanceOne product's GMV, orders and items sold over time, by channel, with returns and ratings - GET
/tik_tok_shop/analytics/sku_performanceThe shop's SKUs with GMV, SKU orders and units sold for a window - GET
/tik_tok_shop/analytics/skus/{skuId}/performanceOne SKU's GMV, items sold and orders over time, by channel - GET
/tik_tok_shop/connection_healthWhether the shop is connected and its data is syncing, with the reasons when not - GET
/tik_tok_shop/conversations/group_countsHow many conversations sit in each of the shop's TikTok inbox groups - GET
/tik_tok_shop/creatorsOne row per creator with GMV, orders, commission and refunds for the range, by GMV - GET
/tik_tok_shop/creators/{openId}/marketplaceOne creator's Creator Marketplace profile for the last 30 days - POST
/tik_tok_shop/creators/discoverSearch TikTok's Creator Marketplace by filters, one page of creators - GET
/tik_tok_shop/creators/discover/filtersThe filters and sort orders Discover creators takes - POST
/tik_tok_shop/creators/lookupLook up to 200 creators by openId, oecId or username - GET
/tik_tok_shop/creators/profileOne creator as this shop sees them: ids, sales here, content, samples and showcase - GET
/tik_tok_shop/finance/orders/{orderId}/transactionsSettled revenue, fees, shipping and settlement for one order, per SKU - GET
/tik_tok_shop/finance/pnlProfit and loss for a date window from TikTok's settlement statements - GET
/tik_tok_shop/finance/reconciliationAffiliate orders in a window checked against what TikTok settled - GET
/tik_tok_shop/finance/statementsThe shop's daily settlement statements - GET
/tik_tok_shop/finance/statements/{statementId}/transactionsEvery transaction settled in one statement - GET
/tik_tok_shop/finance/unsettledOrders and adjustments TikTok has not settled yet - GET
/tik_tok_shop/finance/withdrawalsMoney moving in and out of the shop's TikTok balance - GET
/tik_tok_shop/livesOne row per LIVE with GMV and engagement for the range, by GMV - GET
/tik_tok_shop/outreach/recordsCreators the shop reached in TikTok's current outreach quota period - GET
/tik_tok_shop/product_creatorsOne row per creator with their GMV broken down by product for the range - GET
/tik_tok_shop/productsOne row per product, summed over tracked creators for the range, by GMV - GET
/tik_tok_shop/products/{productId}/contentsVideos and LIVEs that sold one product in a window, ranked by GMV - GET
/tik_tok_shop/products/catalogThe shop's products with SKUs, prices and inventory - GET
/tik_tok_shop/samples/funnelCounts per stage, conversion rates and time in stage for a cohort of sample requests - POST
/tik_tok_shop/samples/matchCheck pending sample requests against criteria (read only: nothing is approved) - GET
/tik_tok_shop/samples/outcomesWhere up to 100 sample applications ended up - GET
/tik_tok_shop/samples/vettingFacts for vetting up to 50 sample applicants: the application, marketplace facts and history with the shop - GET
/tik_tok_shop/shop_healthTikTok's Shop Performance Score overview - GET
/tik_tok_shop/shop_health/metricsEvery Shop Performance Score metric for the shop - GET
/tik_tok_shop/shop_health/metrics/{metricCode}TikTok's diagnosis of one Shop Performance Score metric - GET
/tik_tok_shop/shop_health/metrics/{metricCode}/problemsThe orders or chats that count against one Shop Performance Score metric - GET
/tik_tok_shop/shop_health/metrics/{metricCode}/top_itemsThe items behind one Shop Performance Score metric - GET
/tik_tok_shop/summary/weeklyOne week against the week before: GMV, orders, units, commission, creators, samples and content, with top movers - GET
/tik_tok_shop/target_collabsThe shop's target collaborations, one page per call - GET
/tik_tok_shop/target_collabs/{collaborationId}/promotion_detailsOne creator's results in one target collaboration, per product - GET
/tik_tok_shop/videosOne row per shoppable video with GMV, orders, views and refunds for the range, by GMV