Skip to content
TikTok Shop Partner API

Overview

TikTok Shop Partner API 2026.10.19

Section titled “TikTok Shop Partner API 2026.10.19”

Generated from the TikTok Shop Partner Center documentation (https://partner.tiktokshop.com/docv2). Do not edit by hand.

More information

Information

  • OpenAPI version: 3.1.0

Operations

Section titled “Operations”
POST
/affiliate_creator/202405/open_collaborations/products/search
GET
/affiliate_creator/202405/showcases/products
POST
/affiliate_creator/202405/showcases/products/add
POST
/affiliate_creator/202405/target_collaborations/search
POST
/affiliate_creator/202409/sample_applications/fulfillments/search
DELETE
/affiliate_creator/202409/showcases/products
POST
/affiliate_creator/202409/showcases/products/top
POST
/affiliate_creator/202410/orders/search
POST
/affiliate_creator/202412/sample_applications/search
POST
/affiliate_creator/202412/sample_applications/single_query
GET
/affiliate_creator/202412/samples/labels
POST
/affiliate_creator/202504/affiliate_sharing_links/publisher/{publisher_id}/generate_batch
POST
/affiliate_creator/202505/affiliate_sharing_links/general_publishers/generate_batch
POST
/affiliate_creator/202505/orders/trace/search
POST
/affiliate_creator/202505/videos/video_files
GET
/affiliate_creator/202508/profiles
POST
/affiliate_creator/202509/open_collaborations/products
GET
/affiliate_creator/202509/shop_products
GET
/affiliate_creator/202509/videos/{video_id}/status
POST
/affiliate_creator/202511/photos/photo_files
POST
/affiliate_creator/202511/videos/precheck_task
GET
/affiliate_creator/202601/videos/precheck_tasks/{task_id}
POST
/affiliate_creator/202603/videos
GET
/affiliate_creator/202606/toko_product_mappers
POST
/affiliate_creator/202607/map_toko_product
POST
/affiliate_creator/202610/photos
GET
/affiliate_partner/202405/campaigns
POST
/affiliate_partner/202405/campaigns
GET
/affiliate_partner/202405/campaigns/{campaign_id}
POST
/affiliate_partner/202405/campaigns/{campaign_id}/partial_edit
GET
/affiliate_partner/202405/campaigns/{campaign_id}/products
POST
/affiliate_partner/202405/campaigns/{campaign_id}/products/{product_id}/promotion_link/generate
POST
/affiliate_partner/202405/campaigns/{campaign_id}/products/{product_id}/review
POST
/affiliate_partner/202405/campaigns/{campaign_id}/publish
GET
/affiliate_partner/202501/campaigns/{campaign_id}/products/performance
POST
/affiliate_partner/202505/campaigns/{campaign_id}/products/promotion_links/generate_batch
GET
/affiliate_partner/202508/campaigns/{campaign_id}/products/{product_id}/creator/{creator_temp_id}/content/statistics
GET
/affiliate_partner/202508/campaigns/{campaign_id}/products/{product_id}/creator/{creator_temp_id}/content/statistics/sample/status
GET
/affiliate_partner/202508/campaigns/{campaign_id}/products/{product_id}/performance
POST
/affiliate_partner/202603/cap_order/search
POST
/affiliate_partner/202603/orders/search
POST
/affiliate_seller/202405/open_collaboration_settings
POST
/affiliate_seller/202405/open_collaborations/products/search
POST
/affiliate_seller/202405/products/{product_id}/promotion_link/generate
GET
/affiliate_seller/202409/open_collaboration_settings
DELETE
/affiliate_seller/202409/open_collaborations/products/{product_id}
POST
/affiliate_seller/202409/sample_applications/{application_id}/fulfillments/search
DELETE
/affiliate_seller/202409/target_collaborations/{target_collaboration_id}
GET
/affiliate_seller/202410/open_collaborations/sample_rules
POST
/affiliate_seller/202410/open_collaborations/sample_rules
POST
/affiliate_seller/202410/orders/search
GET
/affiliate_seller/202412/conversation/{conversation_id}/messages
GET
/affiliate_seller/202412/conversations
GET
/affiliate_seller/202412/conversations/messages/list/newest
POST
/affiliate_seller/202412/conversations/{conversation_id}/messages
POST
/affiliate_seller/202412/conversatons/read
POST
/affiliate_seller/202412/open_collaborations
POST
/affiliate_seller/202412/open_collaborations/search
POST
/affiliate_seller/202507/sample_applications/{application_id}/review
POST
/affiliate_seller/202508/conversations
GET
/affiliate_seller/202508/open_collaborations/creator_content_details
POST
/affiliate_seller/202508/open_collaborations/{open_collaboration_id}/remove_creator
POST
/affiliate_seller/202508/sample_applications/search
POST
/affiliate_seller/202508/target_collaborations
POST
/affiliate_seller/202508/target_collaborations/search
GET
/affiliate_seller/202508/target_collaborations/{target_collaboration_id}
PUT
/affiliate_seller/202508/target_collaborations/{target_collaboration_id}
POST
/affiliate_seller/202509/target_collaboration/{target_collaboration_id}/link
POST
/affiliate_seller/202511/images/upload
GET
/affiliate_seller/202512/sample_applications/deeplink
POST
/affiliate_seller/202603/compass/offline_task
GET
/affiliate_seller/202603/compass/offline_tasks
GET
/affiliate_seller/202603/compass/offline_tasks/{task_id}/file
POST
/affiliate_seller/202605/target_collaborations/conflicts/check
POST
/affiliate_seller/202605/target_collaborations/conflicts/resolve
GET
/affiliate_seller/202607/creator_outreach/quota
GET
/affiliate_seller/202608/conversations/group_counts
POST
/affiliate_seller/202608/conversations/{conversation_id}/status
POST
/affiliate_seller/202608/creator_outreach/records/query
POST
/affiliate_seller/202608/marketplace_creators/search
POST
/affiliate_seller/202608/marketplace_creators/search/filter
GET
/affiliate_seller/202608/marketplace_creators/{creator_user_id}
POST
/affiliate_seller/202608/media/upload
POST
/affiliate_seller/202608/target_collaborations/creator_promotion_details/query
POST
/affiliate_seller/202610/creator_outreach/eligibility/check
GET
/analytics/202403/videos/performances
GET
/analytics/202502/live_rooms/{live_room_id}/core_stats
GET
/analytics/202502/live_rooms/{live_room_id}/gmv_trend_performances
GET
/analytics/202502/live_rooms/{live_room_id}/interactive_trend_performances
GET
/analytics/202502/live_rooms/{live_room_id}/product_stats
GET
/analytics/202502/live_rooms/{live_room_id}/traffic_performances
GET
/analytics/202502/live_rooms/{live_room_id}/user_portraits
GET
/analytics/202502/live_rooms/{live_room_id}/view_trend_performances
GET
/analytics/202509/shop_products/{product_id}/performance
GET
/analytics/202509/shop_skus/performance
GET
/analytics/202509/shop_skus/{sku_id}/performance
GET
/analytics/202509/shop_videos/{video_id}/performance
GET
/analytics/202509/shop_videos/{video_id}/products/performance
GET
/analytics/202510/shop/performance/{date}/performance_per_hour
GET
/analytics/202510/shop_lives/{live_id}/performance_per_minutes
GET
/analytics/202511/creators/bestselling
GET
/analytics/202511/lives/bestselling
GET
/analytics/202511/products/bestselling
GET
/analytics/202511/videos/bestselling
GET
/analytics/202512/shop/{live_id}/products_performance
GET
/analytics/202605/shop_products/performance
GET
/analytics/202605/shop_videos/performance
GET
/analytics/202606/shop_performances/metrics
GET
/analytics/202606/shop_performances/metrics/{metric_code}/diagnosis
GET
/analytics/202606/shop_performances/metrics/{metric_code}/problem_details
GET
/analytics/202606/shop_performances/metrics/{metric_code}/top_items
GET
/analytics/202606/shop_performances/overview
GET
/analytics/202609/shop/performance
GET
/analytics/202609/shop_lives/overview_performance
GET
/analytics/202609/shop_lives/performance
GET
/analytics/202609/shop_videos/batch_performance
GET
/analytics/202609/shop_videos/overview_performance
GET
/authorization/202309/shops
GET
/authorization/202405/category_assets
POST
/customer_engagement/202412/engagement_tasks
GET
/customer_engagement/202412/message_templates
POST
/customer_engagement/202412/messages
POST
/customer_engagement/202412/performances
POST
/customer_engagement/202502/engagement_tasks/custom
GET
/customer_engagement/202502/permissions
GET
/customer_service/202309/agents/settings
PUT
/customer_service/202309/agents/settings
GET
/customer_service/202309/conversations
POST
/customer_service/202309/conversations
GET
/customer_service/202309/conversations/{conversation_id}/messages
POST
/customer_service/202309/conversations/{conversation_id}/messages/read
POST
/customer_service/202309/images/upload
GET
/customer_service/202407/performance
GET
/customer_service/202601/conversations/{conversation_id}
POST
/customer_service/202602/sessions/search
POST
/customer_service/202605/conversations/{conversation_id}/sessions/{session_id}/end
POST
/customer_service/202606/conversations/{conversation_id}/messages
GET
/event/202309/webhooks
PUT
/event/202309/webhooks
DELETE
/event/202309/webhooks
GET
/finance/202309/statements
GET
/finance/202309/withdrawals
GET
/finance/202501/orders/{order_id}/statement_transactions
GET
/finance/202501/statements/{statement_id}/statement_transactions
GET
/finance/202507/orders/unsettled
GET
/finance/202605/payments
GET
/finance/202609/account_balances
GET
/finance/202609/account_transactions
POST
/fbt/202408/inventory/search
GET
/fbt/202408/warehouses
GET
/fbt/202409/merchants/onboarded_regions
POST
/fbt/202410/inventory_records/search
POST
/fbt/202601/mcf/goods/inventory/search
GET
/fbt/202601/mcf_outbound_orders
POST
/fbt/202601/mcf_outbound_orders/cancel
GET
/fbt/202601/merchants/mcf_status
POST
/fbt/202602/create_update_inbound_plan
POST
/fbt/202602/inbound_method_detail
GET
/fbt/202602/inbound_orders
POST
/fbt/202602/inbound_orders/cancel
POST
/fbt/202602/inbound_orders/label_print
POST
/fbt/202602/inbound_orders/tracking_update
POST
/fbt/202602/list_available_inbound_method
POST
/fbt/202603/confirm_inbound_method
POST
/fbt/202603/goods/hazmat_and_expiration_info/search
POST
/fbt/202603/goods/update_goods_sku_relation
POST
/fbt/202603/ship_inbound_order
POST
/fbt/202607/goods/create_goods
POST
/fbt/202607/goods/search
POST
/fbt/202607/goods/update_goods_info
POST
/fbt/202607/mcf_outbound_orders
GET
/fulfillment/202309/combinable_packages/search
POST
/fulfillment/202309/files/upload
POST
/fulfillment/202309/images/upload
GET
/fulfillment/202309/orders/split_attributes
POST
/fulfillment/202309/orders/{order_id}/shipping_info/update
POST
/fulfillment/202309/orders/{order_id}/shipping_services/query
POST
/fulfillment/202309/orders/{order_id}/split
GET
/fulfillment/202309/orders/{order_id}/tracking
POST
/fulfillment/202309/packages/combine
POST
/fulfillment/202309/packages/deliver
POST
/fulfillment/202309/packages/search
POST
/fulfillment/202309/packages/ship
GET
/fulfillment/202309/packages/{package_id}
GET
/fulfillment/202309/packages/{package_id}/handover_time_slots
POST
/fulfillment/202309/packages/{package_id}/ship
GET
/fulfillment/202309/packages/{package_id}/shipping_documents
POST
/fulfillment/202309/packages/{package_id}/uncombine
POST
/fulfillment/202407/bundles
POST
/fulfillment/202502/invoice/upload
GET
/fulfillment/202508/tts_tracking_validation
POST
/fulfillment/202510/first_mile_bundle
POST
/fulfillment/202512/packages
POST
/fulfillment/202601/redeem_info/callback
POST
/fulfillment/202606/pod_details/get
POST
/fulfillment/202607/orders/customs_info/query
POST
/fulfillment/202607/orders/customs_info/submit
POST
/fulfillment/202609/order/sof/track/update
POST
/fulfillment/202610/orders/{order_id}/packages
POST
/fulfillment/202610/packages/{package_id}/shipping_info/update
GET
/logistics/202309/delivery_options/{delivery_option_id}/shipping_providers
GET
/logistics/202309/global_warehouses
GET
/logistics/202309/warehouses
GET
/logistics/202309/warehouses/{warehouse_id}/delivery_options
GET
/logistics/202510/seller_templates
GET
/logistics/202604/orders/{order_id}/tracking
GET
/logistics/202606/seller_template/template_exist
POST
/order/202309/orders/search
POST
/order/202406/orders/external_order_search
POST
/order/202406/orders/external_orders
GET
/order/202406/orders/{order_id}/external_orders
GET
/order/202407/orders/{order_id}/price_detail
GET
/order/202507/orders
POST
/order/202605/orders/blind_box_result/callback
POST
/order/202606/pod_details/search
GET
/product/202309/brands
POST
/product/202309/brands
GET
/product/202309/categories
POST
/product/202309/categories/recommend
GET
/product/202309/categories/{category_id}/attributes
GET
/product/202309/categories/{category_id}/global_attributes
GET
/product/202309/categories/{category_id}/global_rules
GET
/product/202309/categories/{category_id}/rules
POST
/product/202309/files/upload
GET
/product/202309/global_categories
POST
/product/202309/global_categories/recommend
POST
/product/202309/global_products
DELETE
/product/202309/global_products
GET
/product/202309/global_products/{global_product_id}
PUT
/product/202309/global_products/{global_product_id}
POST
/product/202309/global_products/{global_product_id}/inventory/update
POST
/product/202309/global_products/{global_product_id}/publish
POST
/product/202309/images/upload
POST
/product/202309/inventory/search
POST
/product/202309/products
DELETE
/product/202309/products
POST
/product/202309/products/activate
POST
/product/202309/products/deactivate
POST
/product/202309/products/listing_check
POST
/product/202309/products/recover
GET
/product/202309/products/{product_id}
POST
/product/202309/products/{product_id}/inventory/update
POST
/product/202309/products/{product_id}/prices/update
POST
/product/202312/global_products/search
GET
/product/202312/prerequisites
POST
/product/202404/images/optimize
GET
/product/202405/products/diagnoses
GET
/product/202405/products/seo_words
GET
/product/202405/products/suggestions
POST
/product/202407/products/category_upgrade_task
POST
/product/202407/sizecharts/search
POST
/product/202409/compliance/manufacturers
POST
/product/202409/compliance/manufacturers/{manufacturer_id}/partial_edit
POST
/product/202409/compliance/responsible_persons
POST
/product/202409/compliance/responsible_persons/{responsible_person_id}/partial_edit
POST
/product/202411/products/diagnose_optimize
POST
/product/202501/compliance/manufacturers/search
POST
/product/202501/compliance/responsible_persons/search
POST
/product/202502/products/search
POST
/product/202505/images/translation_tasks
GET
/product/202506/images/translation_tasks
GET
/product/202507/global_listing_rules
POST
/product/202507/products/{product_id}/global_replicate
GET
/product/202507/products/{product_id}/replicated_products
PUT
/product/202509/global_products/{global_product_id}/partial_edit
PUT
/product/202509/products/{product_id}
POST
/product/202509/products/{product_id}/partial_edit
POST
/product/202601/compliance/auditing/research
POST
/product/202602/packages/recommend
POST
/product/202604/appeals/submit
POST
/product/202604/opportunities/query
GET
/product/202604/opportunities/submissions
GET
/product/202604/opportunities/{opportunity_id}
POST
/product/202604/opportunities/{opportunity_id}/submit
POST
/product/202604/products/gpa_upgrade_task
POST
/product/202606/skpps/search
GET
/product/202606/skpps/sum
GET
/product/202606/skpps/{product_id}
POST
/product/202608/inventory/operation/settings
POST
/product/202609/brands/suggest
POST
/product/202609/products/package/predict
POST
/product/202609/products/properties/recommend
POST
/product/202609/products/{product_id}/strikethrough_price/submit
POST
/product/202610/size_charts
POST
/product/202610/size_charts/edit
POST
/promotion/202309/activities
POST
/promotion/202309/activities/search
GET
/promotion/202309/activities/{activity_id}
PUT
/promotion/202309/activities/{activity_id}
POST
/promotion/202309/activities/{activity_id}/deactivate
PUT
/promotion/202309/activities/{activity_id}/products
DELETE
/promotion/202309/activities/{activity_id}/products
POST
/promotion/202406/coupons/search
GET
/promotion/202406/coupons/{coupon_id}
POST
/promotion/202607/activities/{activity_id}/republish
POST
/return_refund/202309/cancellations/{cancel_id}/approve
POST
/return_refund/202309/cancellations/{cancel_id}/reject
GET
/return_refund/202309/reject_reasons
POST
/return_refund/202309/returns/{return_id}/approve
GET
/return_refund/202309/returns/{return_id}/records
POST
/return_refund/202405/returns/shipping_documents
GET
/return_refund/202601/decision_eligibility
POST
/return_refund/202602/cancellations
POST
/return_refund/202602/cancellations/search
GET
/return_refund/202602/orders/{order_id}/aftersale_eligibility
POST
/return_refund/202602/refunds/calculate
POST
/return_refund/202602/returns
POST
/return_refund/202602/returns/search
POST
/return_refund/202603/aftersales/search
POST
/return_refund/202604/rma/search
POST
/return_refund/202606/returns/{return_id}/reject
GET
/return_refund/202606/review_decision
POST
/return_refund/202609/aftersales/review
GET
/seller/202309/permissions
GET
/seller/202309/shops
GET
/seller/202601/shop_groups
POST
/supply_chain/202309/packages/sync
POST
/open/202512/file/init
POST
(63) Activity change WEBHOOK
POST
(39) Activity status change WEBHOOK
POST
(64) Aftersales Request Status Update WEBHOOK
POST
(66) Appeal Completed WEBHOOK
POST
(11) Cancellation status change WEBHOOK
POST
(42) Combined listing change WEBHOOK
POST
(20) Creator deauthorization WEBHOOK
POST
(24) FBT inventory update WEBHOOK
POST
(22) FBT merchant onboarding WEBHOOK
POST
(58) Get FBT MCF Order Status WEBHOOK
POST
(52) Global listing method change WEBHOOK
POST
(51) Global replication status change WEBHOOK
POST
(23) Goods match WEBHOOK
POST
(46) Image translation completed WEBHOOK
POST
(21) Inbound FBT order status change WEBHOOK
POST
(71) Inventory Changed By Shop WEBHOOK
POST
(27) Inventory status change WEBHOOK
POST
(36) Invoice status change WEBHOOK
POST
(13) New conversation WEBHOOK
POST
(14) New message WEBHOOK
POST
(33) New message listener WEBHOOK
POST
(25) Opportunity matching status change WEBHOOK
POST
(1) Order status change WEBHOOK
POST
(4) Package update WEBHOOK
POST
(37) Product audit status change WEBHOOK
POST
(18) Product category change WEBHOOK
POST
(16) Product creation WEBHOOK
POST
(15) Product information change WEBHOOK
POST
(62) Product Package Recommended WEBHOOK
POST
(5) Product status change WEBHOOK
POST
(3) Recipient address update WEBHOOK
POST
(67) Refund Success WEBHOOK
POST
(12) Return status change WEBHOOK
POST
(65) RMA Status Update WEBHOOK
POST
(56) Sample Application Status Change WEBHOOK
POST
(6) Seller deauthorization WEBHOOK
POST
(17) Shoppable content posting WEBHOOK
POST
(59) Shoppable Video Precheck Tasks Result WEBHOOK
POST
(19) Size chart change WEBHOOK
POST
(50) SKU status change WEBHOOK
POST
(38) Strikethrough price expired WEBHOOK
POST
(35) Tokopedia mirror status change WEBHOOK
POST
(7) Upcoming authorization expiration WEBHOOK
POST
(55) Video Precheck Result WEBHOOK

Authentication

Section titled “Authentication”

accessToken

Section titled “accessToken”

Access token obtained through the TikTok Shop authorization flow.

Security scheme type: apiKey

Header parameter name: x-tts-access-token

webhookSignature

Section titled “webhookSignature”

Sent by TikTok Shop with every webhook: the lowercase hexadecimal HMAC-SHA256 of app_key followed by the raw request body, keyed with the app secret. Not a bearer token. Verify it against the raw body before parsing.

Security scheme type: apiKey

Header parameter name: Authorization

DocsSDKsAPI Reference

Start here

Getting StartedConceptsAuthorizationWebhooksErrors

SDKs

Choose an SDK

OpenAPI

The spec