来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 Path: /fbt/202607/goods/create_goods
#§2 Method: [POST]
#§3 Function Description
Create FBT goods records, including SKU linkage, dimensions, hazmat details, shelf-life attributes, and return address information.
§4 Common Parameters
For common parameters, refer to How to call TikTok Shop APIs - Common Parameters
| Properties | Location | Type | Require | Sample | Properties description |
|---|---|---|---|---|---|
| shop_cipher | query | string | Y | GCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3 | Use 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-type | header | string | Y | application/json | Allowed type: application/json |
§5 Request Query Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| app_key | string | Y | 38abcd | Every single app will have a unique key. Please use the specific key assigned to your app. |
| sign | string | Y | 5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c | Signature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders. |
| timestamp | int | Y | 1623812664 | Unix 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 |
|---|---|---|---|---|
| create_goods_dto_list | []object | Y | List of goods records to create. | |
| ^tts_sku_id | string | Y | 723456789012345678 | Identifier for Stock Keeping Unit (SKU) generated by TikTok Shop system |
| ^create_goods_type | string | Y | CREATE_AND_BIND | Type of create-goods operation. Current supported value: CREATE_AND_BIND. |
| ^goods_name | string | Y | Wireless Charging Cable | Name of the goods. |
| ^goods_image_url | string | Y | https://example.com/fbt/goods-image.jpg | Image URL for the goods. |
| ^reference_code | string | N | ABDK999d | reference code |
| ^barcode_infos | []object | N | List of barcode entries for the goods. | |
| ^^barcode_type | string | N | UPC | Type of barcode provided for the goods, such as UPC. |
| ^^barcode_value | string | N | 698888200121 | Barcode value for the goods. |
| ^return_handling_method | string | Y | RESTOCK_SELLABLE_DISPOSE_UNSELLABLE | The return handling method applied when enabling the FBT customer return service, the default value will be Restock sellable, Dispose unsellable |
Possible values:
- RESTOCK_SELLABLE_DISPOSE_UNSELLABLE
- DISPOSAL_WITHOUT_INSPECTION
- RETURN_WITHOUT_INSPECTION
- RESTOCK_SELLABLE_RETURN_UNSELLABLE |
^dimension_and_weight_base_info |object |Y | |dimension and weight info | ^^weight_value |string |Y |500 |Weight of the goods in the specified weight_unit. | ^^length_value |string |Y |2 |Length of the goods in the specified dimension_unit. | ^^width_value |string |Y |2 |Width of the goods in the specified dimension_unit. | ^^height_value |string |Y |3 |Height of the goods in the specified dimension_unit. | ^^weight_unit |string |Y |GRAM |Weight unit. Possible values: MILLIGRAM (mg), GRAM (g), KILOGRAM (kg), POUND (lb), OUNCE (oz). | ^^dimension_unit |string |Y |CENTIMETER |Dimension unit. Possible values: MILLIMETER (mm), CENTIMETER (cm), METER (m), FOOT (ft), INCH (in). | ^is_hazmat |bool |Y |false |whether is hazmat goods | ^hazmat_info |object |N | |Hazmat information for the goods. | ^^hazmat_type |string |Y |BATTERY |hazardous goods type Possible values: -MAGNETIZED -BATTERY -FLAMMABLE_LIQUID -AEROSOLS | ^^battery_extra_info |object |N | |Additional battery information for hazmat goods. | ^^^battery_type |string |Y |LITHIUM_ION |Battery type Possible values: LITHIUM_ION LITHIUM_METAL OTHER | ^^^battery_packaging_type |string |Y |STANDALONE |Battery packaging type,possible values: -STANDALONE -IN_EQUIPMENT -WITH_EQUIPMENT | ^^^total_battery_weight |string |Y |10 |Total battery weight in the unit specified by total_battery_weight_unit. | ^^^total_battery_weight_unit |string |Y |GRAM |Unit for total_battery_weight. Possible value: GRAM. | ^^^total_battery_capacity |string |Y |2 |Total battery capacity in the unit specified by total_battery_capacity_unit. | ^^^total_battery_capacity_unit |string |Y |WATTHOUR |Unit for total_battery_capacity, such as WATTHOUR. | ^^^is_need_un_38_3_test |bool |Y |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 |N |https://example.com/fbt/un38-3-test-report.pdf |UN38.3 testing file URL | ^^^battery_count_per_package |string |N |3 |per package battery count | ^^flammable_liquids_extra_info |object |N | |flammable liquids info | ^^^flammable_liquids_type |string |Y |PAINT |Flammable liquid type, possible values -Paints -Perfumery products -Alcohols -Other | ^^^flammable_liquids_volume |string |Y |1 |Volume of flammable liquid in the unit specified by volume_unit. | ^^^volume_unit |string |N |MILLILITERS |Unit for flammable_liquids_volume, such as MILLILITERS. | ^^dg_class |string |Y |CLASS_2 |Hazmat class Possible values: -CLASS_2 -CLASS_3 -CLASS_9 | ^^dg_uncode |string |Y |UN3480 |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 |Y |https://example.com/fbt/msds-report.pdf |Material safety data sheet of the hazmat goods to support review the goods' safety compliance in FBT | ^^aerosol_extra_info |object |N | |Aerosol info | ^^^volume |string |N |1 |aeroslo volume | ^^^volume_unit |string |N |MILLILITERS |aeroslo volume unit | ^is_lot_code |bool |Y |false |whether is expiration management goods | ^is_expiration_management |bool |Y |false |whether is shelf life goods | ^shelf_life_attribute_info |object |N | |Shelf-life attributes for the goods. | ^^shelf_life |int |N |90 |The goods shelf life (days) | ^^inbound_cutoff_days |int |Y |100 |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 |Y |90 |The goods alert days before expired, represent the period of time before platform send expiration reminder alerts to the merchant. | ^^sales_cutoff_days |int |Y |80 |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_expired_goods |string |N |DISPOSE |The handling method for expired inventory. Possible values: STORE_UNITS RETURN_TO_SELLER DISPOSE | ^is_sioc |bool |N |false |A flag indicating whether the goods is under sioc | ^sioc_attribute |object |N | |sioc info | ^^sioc_files |[]object |N | |Sioc files | ^^^sioc_certification_url |string |N |https://p-boei18n.byted.org/tos-boei18n-i-0euhj0x6u9/beec7f914a044902a0c5dc929b97d064~tplv-k3ldphp9j8-origin-jpeg.jpeg? |sico attachment url | ^^^sioc_file_type |string |N |PHOTO |sioc attachment type:
- PHOTO
- DOCUMENT
- DROP_TEST_VIDEO | ^bulky_item_attribute |object |N | |bulky item info | ^^is_bulky_item_accessories |bool |N |false |whether the goods is bulky accessories | ^goods_safety_attributes |object |N | |safety attribute info | ^^is_fragile |bool |N |false |where fragile | ^^is_liquid |bool |N |false |where fragile | ^^is_sharp |bool |N |false |where sharp |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/fbt/202607/goods/create_goods?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY
Body
{"create_goods_dto_list":[{"tts_sku_id":"723456789012345678","create_goods_type":"CREATE_AND_BIND","goods_name":"Wireless Charging Cable","goods_image_url":"https://example.com/fbt/goods-image.jpg","reference_code":"ABDK999d","barcode_infos":[{"barcode_type":"UPC","barcode_value":"698888200121"}],"return_handling_method":"RESTOCK_SELLABLE_DISPOSE_UNSELLABLE","dimension_and_weight_base_info":{"weight_value":"500","length_value":"2","width_value":"2","height_value":"3","weight_unit":"GRAM","dimension_unit":"CENTIMETER"},"is_hazmat":false,"hazmat_info":{"hazmat_type":"BATTERY","battery_extra_info":{"battery_type":"LITHIUM_ION","battery_packaging_type":"STANDALONE","total_battery_weight":"10","total_battery_weight_unit":"GRAM","total_battery_capacity":"2","total_battery_capacity_unit":"WATTHOUR","is_need_un_38_3_test":false,"un_38_3_test_file_url":"https://example.com/fbt/un38-3-test-report.pdf","battery_count_per_package":"3"},"flammable_liquids_extra_info":{"flammable_liquids_type":"PAINT","flammable_liquids_volume":"1","volume_unit":"MILLILITERS"},"dg_class":"CLASS_2","dg_uncode":"UN3480","msds_file_url":"https://example.com/fbt/msds-report.pdf","aerosol_extra_info":{"volume":"1","volume_unit":"MILLILITERS"}},"is_lot_code":false,"is_expiration_management":false,"shelf_life_attribute_info":{"shelf_life":90,"inbound_cutoff_days":100,"expiration_alert_days":90,"sales_cutoff_days":80,"handling_method_expired_goods":"DISPOSE"},"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"}]},"bulky_item_attribute":{"is_bulky_item_accessories":false},"goods_safety_attributes":{"is_fragile":false,"is_liquid":false,"is_sharp":false}}]}
§8 Response Parameters
| Properties | Type | Sample | Properties description |
|---|---|---|---|
| code | int | 0 | The success or failure status code returned in API response. |
| message | string | Success | The success or failure messages returned in API response. Reasons of failure will be described in the message. |
| request_id | string | 202203070749000101890810281E8C70B7 | Request log |
| data | object | Specific return information | |
| ^create_result_info | object | Goods creation result information. | |
| ^^create_result_list | []object | List of goods creation results. | |
| ^^^tts_sku_id | string | 723456789012345678 | Identifier for the SKU generated by TikTok Shop system. |
| ^^^is_success | bool | false | Whether the goods creation succeeded. |
| ^^^tts_goods_id | string | 9988776655 | Identifier for goods generated by Fulfilled by TikTok system |
| ^^^fail_reason | string | Goods creation failed. | Reasons of failure will be described in the message. |
§9 Response Sample
{"code":0,"data":{"create_result_info":{"create_result_list":[{"tts_sku_id":"723456789012345678","is_success":false,"tts_goods_id":"9988776655","fail_reason":"Goods creation failed."}]}},"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 |
|---|
