Returns the top products for NRR, NBFR, or AHT, or the top logistics providers for OTDR. Shop Performance Score (SPS) reflects a shop’s performance across key operational and service metrics on TikTok Shop. By integrating the read-only SPS APIs, ISVs can retrieve a shop’s score, tier, benefits, and metric benchmarks, diagnose performance gaps, and drill down to the products, logistics providers, aftersales types, orders, or chats associated with specific issues. This enables ISVs to embed actionable performance insights into their solutions, helping merchants identify problem areas faster and take targeted actions to improve shop performance. Available only for US-region shops. Use case guide: Click here
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Metric code that selects the returned top-items list:
- NRR: products with negative reviews (
nrr_top_product_items). - NBFR: products with returns or refunds (
nbfr_top_product_items). - OTDR: logistics providers and their on-time delivery performance (
otdr_logistics_items). - AHT: products and their aftersales handling details (
aht_aftersales_type_items).
Query Parameters
Section titled “Query Parameters”Identifies the shop. Obtain it from the Get Authorized Shops API.
BCP 47 locale code used to localize response text. If omitted, the default locale is resolved from the request context.
Responses
Section titled “Responses”Success
object
Status code; 0 means success.
Success or failure message.
Request log ID.
object
Top product items for AHT, with fields for average handle duration and the top aftersales type.
object
Average handle duration in hours.
Product ID.
Product name.
Total number of return orders.
Top aftersales type returned by TikTok Shop aftersales classification.
Number of orders associated with the top aftersales type.
Product image URL.
Stable metric code selected in the request. One of: NRR, NBFR, OTDR, or AHT.
NBFR top product items.
object
Product ID.
Product name.
Number of return or refund orders.
Number of orders associated with the top return or refund reason.
Top return or refund reasons.
Product image URL.
NRR top product items.
object
Total number of delivered orders.
Product image URL.
Number of orders with negative reviews.
Product ID.
Product name.
Top negative review reasons.
OTDR logistics provider items.
object
Total number of delivered orders.
Logistics provider name.
Number of orders delivered on time.
On-time delivery rate as a ratio from 0 to 1.
Number of items in the metric-specific list returned by this response.
Example
{ "code": 0, "data": { "aht_aftersales_type_items": [ { "handle_duration_hours": "18.5", "product_id": "1729592969712207011", "product_name": "Smart Watch", "return_order_count": 30, "top_aftersales_type_name": "Only Refund", "top_type_order_count": 20, "image_url": "https://example.com/product.jpg" } ], "metric_code": "NRR", "nbfr_top_product_items": [ { "product_id": "1729592969712207010", "product_name": "Cotton T-Shirt", "return_order_count": 8, "top_reason_order_count": 5, "top_return_reasons": [ "Item doesn't match description" ], "image_url": "https://example.com/product.jpg" } ], "nrr_top_product_items": [ { "delivered_order_count": 300, "image_url": "https://example.com/product.jpg", "negative_order_count": 12, "product_id": "1729592969712207008", "product_name": "Wireless Headphones", "top_review_reasons": [ "Item doesn't match description" ] } ], "otdr_logistics_items": [ { "delivered_order_count": 1000, "logistics_provider": "TikTok Shipping", "on_time_deliver_order_count": 947, "on_time_deliver_rate": "0.947" } ], "total_count": 120 }, "message": "Success", "request_id": "202203070749000101890810281E8C70B7"}