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

Search Goods Info

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

资料正文

§2 Method: [POST]

#

§3 Function Description

This API is used to retrieve a list of goods belonging to the merchant that meet the specified conditions. It returns detailed information about the goods, including their IDs, names, and other attributes, such as the goods-SKU relationship, dimensions, and weight as verified by the warehouse.


#

§4 Common Parameters

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

Properties Location Type Require Sample Properties description
shop_cipherquerystringYGCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3Use this property to pass shop information in requesting the API. Failure in passing the correct value when requesting the API for cross-border shops will return incorrect response.
Get by API Get Authorization Shop
content-typeheaderstringYapplication/jsonAllowed type: application/json
#

§5 Request Query Parameters

Properties Type Require Sample Properties description
page_sizeintY50The number of results to be returned per page.
Valid range: [1-100].
page_tokenstringNcGFnZV9udW1iZXI9Mg==An 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.
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.
timestampstringY1623812664Unix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time.
#

§6 Request Body Parameters

Properties Type Require Sample Properties description
goods_ids[]stringN["256080616234"]Identifier for goods generated by Fulfilled by TikTok system, maximum length 100. Filter the goods information to display only those with specific goods IDs.
Note: When goods_ids, reference_codes, sku_ids, or product_ids include two or more values, the result will return the intersection of the goods information. For example, if the input includes both goods_ids and sku_ids, it will return only the goods that meet both the goods_ids and sku_ids criteria. If requested with all criteria empty, it will return a page_size number of goods defined by the merchant, sorted by creation time, with the latest first.
product_ids[]stringN["256990616123"]Identifier for product generated by TikTok Shop system, maximum length 100. Filter the goods information to display only those with specific product IDs.
reference_codes[]stringN["SELLERSKU 123456"]Identifier for goods defined by merchant, maximum length 100. Filter the goods information to display only those with specific reference codes.
sku_ids[]stringN["256086568895"]Identifier for Stock Keeping Unit (SKU) generated by TikTok Shop system, maximum length 100. Filter the goods information to display only those with specific SKU IDs.
#

§7 Request Sample

Query

https://open-api.tiktokglobalshop.com/fbt/202607/goods/search?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c&timestamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&page_size=50&page_token=cGFnZV9udW1iZXI9Mg==

Body

{"goods_ids":["256080616234"],"product_ids":["256990616123"],"reference_codes":["SELLERSKU 123456"],"sku_ids":["256086568895"]}
#

§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
^next_page_tokenstringcGFnZV9udW1iZXI9Mg==An opaque token used to retrieve the next page of a paginated result set. Provide this value in the page_token parameter of your request if the current response does not return all the results.
^total_countint123The total number of goods that meet the query conditions.
^goods[]objectA list of detailed information for Fulfilled by TikTok goods.
^^idstring86533997569The identifier for goods generated by Fulfilled by TikTok system.
^^namestringwater1.0The goods name.
^^barcodes[]objectA list of detailed information for goods barcodes.
^^^codestring014673829105The printable barcode for the goods.
^^^typestringUPCThe barcode type.
Possible values:
  • UPC
  • EAN
  • GTIN
  • ASIN OR FNSKU
  • MERCHANT SKU ID
  • FBT SPECIFIC BARCODE | ^^reference_code |string |abc32323 |The identifier for goods defined by merchant. | ^^image_url |string |https://p-boei18n.byted.org/tos-boei18n-i-0euhj0x6u9/beec7f914a044902a0c5dc929b97d064~tplv-k3ldphp9j8-origin-jpeg.jpeg? |The goods image url. | ^^merchant_declaration_info |object | |The dimension and weight info input by merchant. | ^^^weight |object | |The goods weight. | ^^^^value |string |1.122 |Weight value, up to three decimal places. | ^^^^unit |string |GRAM |Weight unit. Possible values:
  • MILLIGRAM
  • GRAM
  • KILOGRAM
  • POUND
  • OUNCE | ^^^dimension |object | |The goods dimension. | ^^^^width |string |1.122 |Width value, up to three decimal places. | ^^^^length |string |2.122 |Length value, up to three decimal places. | ^^^^height |string |3.122 |Height value, up to three decimal places. | ^^^^unit |string |CENTIMETER |Dimension unit. Possible values:
  • MILLIMETER
  • CENTIMETER
  • METER
  • FOOT
  • INCH
  • MICROMETER | ^^warehouse_confirmation_info |object | |The dimension and weight information verified by warehouse when first inbound. | ^^^weight |object | |The goods weight. | ^^^^value |string |1 |Weight value verified by warehouse, up to three decimal places. | ^^^^unit |string |GRAM |Weight unit. Possible values:
  • MILLIGRAM
  • GRAM
  • KILOGRAM
  • POUND
  • OUNCE | ^^^dimension |object | |The goods dimension. | ^^^^width |string |1 |Width value verified by warehouse, up to three decimal places. | ^^^^length |string |2.5 |Length value verified by warehouse, up to three decimal places. | ^^^^height |string |3 |Height value verified by warehouse, up to three decimal places. | ^^^^unit |string |CENTIMETER |Dimension unit. Possible values:
  • MILLIMETER
  • CENTIMETER
  • METER
  • FOOT
  • INCH
  • MICRO | ^^skus |[]object | |A list of Stock Keeping Units (SKUs) infomation matched with current FBT goods. | ^^^id |string |1729439634328225260 |The identifier for SKU generated by TikTok Shop system. | ^^^name |string |Testcase SKU |The SKU name. | ^^^image_url |string |https://p-boei18n.byted.org/tos-boei18n-i-0euhj0x6u9/beec7f914a044902a0c5dc929b97d064~tplv-jvtte31kaf-origin-jpeg.jpeg?from=522366036 |The TikTok Shop SKU image url. | ^^^product |object | |The TikTok Shop product matched with current Fulfilled by TikTok goods. | ^^^^id |string |1729439631253210604 |The identifier for product generated by TikTok Shop system. | ^^^^name |string |Testcase_xd2.0_test_goods |The TikTok Shop product name. | ^^^^image_url |string |https://p-boei18n.byted.org/tos-boei18n-i-0euhj0x6u9/fc303cec3f9b4e54a247bc8583892a4d~tplv-k3ldphp9j8-origin-jpeg.jpeg?from=3498640996 |The Tiktok Shop product image url. | ^^^regions |[]string |["US"] |The regions where the SKU is being sold, represented by region codes in the two-character ISO 3166-1 alpha-2 format. | ^^^matched |bool |true |A flag indicating whether the Fulfilled by TikTok goods is matched with the TikTok Shop SKU. True: Matched. False: Not matched. | ^^lot_expiration_info |object | |The goods lot control and expiration managment information. | ^^^is_lot_control |bool |true |A flag indicating whether the goods is under lot control. True: Under lot control. False: Not under lot control. Note: Lot code and expiration date management information is mandatory for these product categories according to Fulfilled by TikTok guidelines. | ^^^is_expiration_management |bool |true |A flag indicating whether the goods is under expiration managment. True: Under expiration managment. False: Not under expiration managment. | ^^^shelf_life_days |int |12 |The goods shelf life days input by merchant, represent the total number of days the product remains usable or sellable from the time it is manufactured until its expiration. | ^^^inbound_cutoff_days |int |90 |The goods inbound cutoff days before expiration, represent the time period before the product's expiration when the warehouse will no longer accept inbound shipments. | ^^^expiration_alert_days |int |60 |The goods alert days before expired, represent the period of time before platform send expiration reminder alerts to the merchant. | ^^^sales_cutoff_days |int |20 |The goods sales cut off days before expired, represent the period of time before expiration in which the goods will no longer be available for sale. | ^^^handling_method |string |DISPOSE |The handling method for expired inventory. Possible values:
  • TURN_INTO_DEFECTIVE_INVENTORY
  • RETURN_TO_SUPPLIER
  • DISPOSE | ^^is_hazmat |bool |false |whether is hazmat goods | ^^hazmat_info |object | |Hazmat information for the goods. | ^^^hazmat_type |string |MAGNETIZED |hazardous goods type Possible values: -MAGNETIZED -BATTERY -FLAMMABLE_LIQUID -AEROSOLS | ^^^battery_extra_info |object | |Additional battery information for hazmat goods. | ^^^^battery_type |string |LITHIUM_ION |Battery type Possible values: LITHIUM_ION LITHIUM_METAL OTHER | ^^^^battery_packaging_type |string |STANDALONE |Battery packaging type,possible values: -STANDALONE -IN_EQUIPMENT -WITH_EQUIPMENT | ^^^^total_battery_weight |string |1 |Total battery weight in the unit specified by total_battery_weight_unit. | ^^^^total_battery_weight_unit |string |GRAM |Unit for total_battery_weight. Possible value: GRAM. | ^^^^total_battery_capacity |string |1 |Total battery capacity in the unit specified by total_battery_capacity_unit. | ^^^^battery_count_per_package |string |2 |per package battery count | ^^^^is_need_un_38_3_test |bool |false |UN38.3 testing ensures that batteries meet specific safety criteria. Please send the report in the field if it's not included in the MSDS. | ^^^^un_38_3_test_file_url |string |https://example.com/fbt/msds-report.pdf |UN38.3 testing file URL | ^^^^total_battery_capacity_unit |string |WATTHOUR |Unit for total_battery_capacity, such as WATTHOUR. | ^^^flammable_liquids_extra_info |object | |flammable liquids info | ^^^^flammable_liquids_type |string |PAINT |Flammable liquid type, possible values -PAINT -PERFUMERY -ALCOHOLIC -OTHER | ^^^^flammable_liquids_volume |string |1 |Volume of flammable liquid in the unit specified by volume_unit. | ^^^^volume_unit |string |MILLILITERS |Unit for flammable_liquids_volume, such as MILLILITERS. | ^^^aerosol_extra_info |object | |aerosol info | ^^^^volume |string |1 |aeroslo volume | ^^^^volume_unit |string |MILLILITERS |aeroslo volume unit | ^^^dg_class |string |CLASS_2 |Hazmat class Possible values: -CLASS_2 -CLASS_3 -CLASS_9 | ^^^dg_uncode |string |UN1266 |UN number or UN ID is a 4-digit number that identifies hazardous substances possible values -UN2807 -UN3480 -UN3090 -UN3481 -UN3091 -UN1263 -UN1266 -UN3065 -OTHER | ^^^msds_file_url |string |https://example.com/fbt/msds-report.pdf |Material safety data sheet of the hazmat goods to support review the goods' safety compliance in FBT | ^^sioc_approval_status |string |SIOC_APPROVAL_STATUS_APPROVE |- SIOC_APPROVAL_STATUS_APPROVE
  • SIOC_APPROVAL_STATUS_REJECT
  • SIOC_APPROVAL_STATUS_UNDER_REVIEW | ^^hazmat_approval_status |string |APPROVAL_STATUS_UNDER_REVIEW |- APPROVAL_STATUS_UNDER_REVIEW
  • APPROVAL_STATUS_FULFILLABLE
  • APPROVAL_STATUS_UNFULFILLABLE | ^^bulky_item_attribute |object | |bulky item info | ^^^is_bulky_item |bool |false |whether the goods is_bulky_item | ^^^is_bulky_item_accessories |bool |false |whether the goods is bulky accessories | ^^goods_safety_attributes |object | |safety attribute info | ^^^is_fragile |bool |false |whether fragile | ^^^is_liquid |bool |false |whether liquid | ^^^is_sharp |bool |false |whether sharp | ^^is_sioc |bool |false |whether sioc | ^^sioc_attribute |object | |sioc info | ^^^sioc_files |[]object | |sioc files | ^^^^sioc_certification_url |string |https://p-boei18n.byted.org/tos-boei18n-i-0euhj0x6u9/beec7f914a044902a0c5dc929b97d064~tplv-k3ldphp9j8-origin-jpeg.jpeg? |sico attachment url | ^^^^sioc_file_type |string |PHOTO |sioc attachment type:
  • PHOTO
  • DOCUMENT
  • DROP_TEST_VIDEO |
#

§9 Response Sample

{"code":0,"data":{"next_page_token":"cGFnZV9udW1iZXI9Mg==","total_count":123,"goods":[{"id":"86533997569","name":"water1.0","barcodes":[{"code":"014673829105","type":"UPC"}],"reference_code":"abc32323","image_url":"https://p-boei18n.byted.org/tos-boei18n-i-0euhj0x6u9/beec7f914a044902a0c5dc929b97d064~tplv-k3ldphp9j8-origin-jpeg.jpeg?","merchant_declaration_info":{"weight":{"value":"1.122","unit":"GRAM"},"dimension":{"width":"1.122","length":"2.122","height":"3.122","unit":"CENTIMETER"}},"warehouse_confirmation_info":{"weight":{"value":"1","unit":"GRAM"},"dimension":{"width":"1","length":"2.5","height":"3","unit":"CENTIMETER"}},"skus":[{"id":"1729439634328225260","name":"Testcase SKU","image_url":"https://p-boei18n.byted.org/tos-boei18n-i-0euhj0x6u9/beec7f914a044902a0c5dc929b97d064~tplv-jvtte31kaf-origin-jpeg.jpeg?from=522366036","product":{"id":"1729439631253210604","name":"Testcase_xd2.0_test_goods","image_url":"https://p-boei18n.byted.org/tos-boei18n-i-0euhj0x6u9/fc303cec3f9b4e54a247bc8583892a4d~tplv-k3ldphp9j8-origin-jpeg.jpeg?from=3498640996"},"regions":["US"],"matched":true}],"lot_expiration_info":{"is_lot_control":true,"is_expiration_management":true,"shelf_life_days":12,"inbound_cutoff_days":90,"expiration_alert_days":60,"sales_cutoff_days":20,"handling_method":"DISPOSE"},"is_hazmat":false,"hazmat_info":{"hazmat_type":"MAGNETIZED","battery_extra_info":{"battery_type":"LITHIUM_ION","battery_packaging_type":"STANDALONE","total_battery_weight":"1","total_battery_weight_unit":"GRAM","total_battery_capacity":"1","battery_count_per_package":"2","is_need_un_38_3_test":false,"un_38_3_test_file_url":"https://example.com/fbt/msds-report.pdf","total_battery_capacity_unit":"WATTHOUR"},"flammable_liquids_extra_info":{"flammable_liquids_type":"PAINT","flammable_liquids_volume":"1","volume_unit":"MILLILITERS"},"aerosol_extra_info":{"volume":"1","volume_unit":"MILLILITERS"},"dg_class":"CLASS_2\n","dg_uncode":"UN1266","msds_file_url":"https://example.com/fbt/msds-report.pdf"},"sioc_approval_status":"SIOC_APPROVAL_STATUS_APPROVE","hazmat_approval_status":"APPROVAL_STATUS_UNDER_REVIEW","bulky_item_attribute":{"is_bulky_item":false,"is_bulky_item_accessories":false},"goods_safety_attributes":{"is_fragile":false,"is_liquid":false,"is_sharp":false},"is_sioc":false,"sioc_attribute":{"sioc_files":[{"sioc_certification_url":"https://p-boei18n.byted.org/tos-boei18n-i-0euhj0x6u9/beec7f914a044902a0c5dc929b97d064~tplv-k3ldphp9j8-origin-jpeg.jpeg?","sioc_file_type":"PHOTO"}]}}]},"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
#