快工助手跨境电商知识与商机助手

Get Affiliate Partner Campaign Product List

TikTok Shop 官方资料 · TikTok Shop Partner Center 开发者文档 · 适合开发者

stable本次发布有变化全部展示

来自 TikTok Shop 官方资料快照 ·

打开官方原文 ↗
  1. 当前资料结构化阅读页
  2. 固定快照已留存,可追溯
  3. 官方原文可核对
查看技术与溯源信息
平台 / profile
TikTok Shop / profile.tiktok.docs_api
语言
en-US
发布版本
cn-20260909-2
标签
zhuge/sourceplatform/tiktok_shopaudience/developercategory/api_doctopic/compliancetopic/developer

资料正文

§1 Path: /affiliate_partner/202405/campaigns/{campaign_id}/products

#

§2 Method: [GET]

#

§3 Function Description

This API offers the ability to list products submitted by sellers in an Affiliate Partner campaign.


#

§4 Common Parameters

For common parameters, refer to How to call TikTok Shop APIs - Common Parameters

Properties Location Type Require Sample Properties description
content-typeheaderstringYapplication/jsonAllowed type: application/json
category_asset_cipherquerystringYGCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3The partner identifier used in API requests. Retrieve this value by using the Get Authorized Category Assets API.
#

§5 Request Path Parameters

Properties Type Require Sample Properties description
campaign_idstringY7373988288167036678The ID of the campaign.
#

§6 Request Query Parameters

Properties Type Require Sample Properties description
app_keystringY38abcdEvery single app will have a unique key. Please use the specific key assigned to your app.
signstringY5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8cSignature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders.
timestampintY1623812664Unix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time.
category_asset_cipherstringYGCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3The partner identifier used in API requests. Retrieve this value by using the Get Authorized Category Assets API.
page_sizeintY10The number of results to be returned per page.
page_tokenstringNb2Zmc2V0PTAKAn opaque token used to retrieve the next page of a paginated result set. Retrieve this value from the result of the next_page_token from a previous response. It is not needed for the first page.
review_statusstringNPENDINGThe product review status. This an enumerated type with values:
  • PENDING
  • APPROVED
  • REJECTED
  • PENDING_CLOSED
  • CLOSED | product_name |string |N |sample |Filter the product list by product name. If value of product_name is contained in product.name, the product will be included in the response. | product_id |string |N |1730305356901683547 |Filter the product list by product ID. If value of product_id matches product.id, the product will be included in the response. | shop_name |string |N |Test Shop |Filter the product list by shop name. If value of shop_name is contained in product.shop_name, the product will be included in the response. | category_id |string |N |991496 |Filter the product list by category ID. If value of category_id matches product.category.id, or the product falls into the leaf category of the specified category, the product will be included in the response. |
#

§7 Request Sample

Query

https://open-api.tiktokglobalshop.com/affiliate_partner/202405/campaigns/7373988288167036678/products?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c&timestamp=1625484268&category_asset_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&page_size=10&page_token=b2Zmc2V0PTAK&review_status=PENDING&product_name=sample&product_id=1730305356901683547&shop_name=Test Shop&category_id=991496
#

§8 Response Parameters

Properties Type Sample Properties description
codeint0The success or failure status code returned in API response.
messagestringSuccessThe success or failure messages returned in API response. Reasons of failure will be described in the message.
request_idstring202203070749000101890810281E8C70B7Request log
dataobjectSpecific return information
^products[]objectThe list of products.
^^idstring1729442777527587334The product identifier.
^^review_statusstringPENDINGThe product review status. This an enumerated type with values:
  • PENDING
  • APPROVED
  • REJECTED
  • PENDING_CLOSED
  • CLOSED | ^^name |string |test case number 4 test case number 4 |The product name. | ^^main_image_url |string |https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/fa0387fa5a204dcfa44d5be75877a163~tplv-o3syd03w52-origin-webp.webp?from=3478900499 |The product image URL. | ^^lowest_price |object | |The lowest original price of all SKUs of this product. | ^^^currency |string |USD |The currency in the sales region. | ^^^amount |string |1.1 |The lowest price amount. | ^^highest_price |object | |The highest original price of all SKUs of this product. | ^^^currency |string |USD |The currency code for the region in which the product is sold. | ^^^amount |string |12.21 |The highest price amount. | ^^inventory |int |89 |The number of in-stock units of all SKUs for this product. | ^^shop_name |string |my_shop |The TikTok Shop name. | ^^total_commission_rate |int |6600 |The total commission rate in hundredths of a percent (0.01%) units. | ^^creator_commission_rate |int |1000 |The creator commission rate in hundredths of a percent (0.01%) units. | ^^partner_commission_rate |int |5600 |The partner commission rate in hundredths of a percent (0.01%) units. | ^^open_collaboration_commission_rate |int |1000 |The product open collaboration commission rate in hundredths of a percent (0.01%) units. | ^^is_available |bool |true |Set to true if a product URL is available. Set to false if no product URL is available. | ^^product_sales |int |10 |The total number of units sold of this product for this campaign. | ^^category |object | |The leaf category to which this product is associated. | ^^^id |string |12222 |The category identifier. | ^^^name |string |COMPUTER |The category name. | ^^sample_quota |int |12 |The total amount of sample inventory available for allocation to creators by the seller. | ^^sku_information_list |[]object | |A list of Stock Keeping Units (SKUs) used to identify distinct variants of the product. | ^^^sku_name |string |factory product |The name of the sku | ^^^sku_id |string |1729666531097281876 |The id of the sku | ^^^inventory |object | |SKU inventory details. | ^^^^available_quantity |string |80 |The total SKU quantity available in the warehouse. | ^^^base_price |object | |the base price of the sku | ^^^^region_code |string |MY |the region code of the sku | ^^^^currency |string |MYR |The currency of the SKU price. Possible values based on the region:
  • BRL: Brazil
  • EUR: France, Germany, Ireland, Italy, Spain
  • GBP: United Kingdom
  • IDR: Indonesia
  • JPY: Japan
  • MXN: Mexico
  • MYR: Malaysia
  • PHP: Philippines
  • SGD: Singapore
  • THB: Thailand
  • USD: United States
  • VND: Vietnam | ^^^^list_price |string |162.34 |The SKU's list price information that has been verified to be legitimate by the audit team. This is equivalent to the manufacturer's suggested retail price (MSRP), or the recommended retail price (RRP). | ^^^^sale_price |string |162.34 |The SKU's selling price, inclusive of tax. Applicable only for cross-border sellers from China. | ^^^^localized_dutiable_price |string |141.58 |localized dutiable price | ^^^region_prices |[]object | |region prices | ^^^^region_code |string |MY |the region code of the sku | ^^^^currency |string |MYR |The currency of the SKU price. Possible values based on the region:
  • BRL: Brazil
  • EUR: France, Germany, Ireland, Italy, Spain
  • GBP: United Kingdom
  • IDR: Indonesia
  • JPY: Japan
  • MXN: Mexico
  • MYR: Malaysia
  • PHP: Philippines
  • SGD: Singapore
  • THB: Thailand
  • USD: United States
  • VND: Vietnam | ^^^^list_price |string |162.34 |The SKU's list price information that has been verified to be legitimate by the audit team. This is equivalent to the manufacturer's suggested retail price (MSRP), or the recommended retail price (RRP). | ^^^^sale_price |string |162.34 |The SKU's selling price, inclusive of tax. Applicable only for cross-border sellers from China. | ^^^^localized_dutiable_price |string |141.58 |localized dutiable price | ^^^properties |[]object | |The properties of the sku | ^^^^name |string |Spesifikasi |the name of the property | ^^^^value_name |string |lalai |the name of the value | ^^product_description |string | This is an example product description. |Return product description | ^next_page_token |string |absdfV231as2V0PTAK |An opaque token used to retrieve the next page of a paginated result set. | ^total_count |int |1570 |The total number of products in the list. |
#

§9 Response Sample

{"code":0,"data":{"products":[{"id":"1729442777527587334","review_status":"PENDING","name":"test case number 4 test case number 4","main_image_url":"https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/fa0387fa5a204dcfa44d5be75877a163~tplv-o3syd03w52-origin-webp.webp?from=3478900499","lowest_price":{"currency":"USD","amount":"1.1"},"highest_price":{"currency":"USD","amount":"12.21"},"inventory":89,"shop_name":"my_shop","total_commission_rate":6600,"creator_commission_rate":1000,"partner_commission_rate":5600,"open_collaboration_commission_rate":1000,"is_available":true,"product_sales":10,"category":{"id":"12222","name":"COMPUTER"},"sample_quota":12,"sku_information_list":[{"sku_name":"factory product","sku_id":"1729666531097281876","inventory":{"available_quantity":"80"},"base_price":{"region_code":"MY","currency":"MYR","list_price":"162.34","sale_price":"162.34","localized_dutiable_price":"141.58"},"region_prices":[{"region_code":"MY","currency":"MYR","list_price":"162.34","sale_price":"162.34","localized_dutiable_price":"141.58"}],"properties":[{"name":"Spesifikasi","value_name":"lalai"}]}],"product_description":"\u003cp\u003eThis is an example product description.\u003c/p\u003e"}],"next_page_token":"absdfV231as2V0PTAK","total_count":1570},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}
#

§10 Error Code

For common error codes, refer to How to call TikTok Shop APIs - Common Error Code

Code Message
16032001nvalid parameter Creator and Seller, please ensure Region mismatch.
16032005Campaign not found
16032007Permission denied
36009003Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support.
#