来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 Path: /product/202309/categories/{category_id}/rules
#§2 Method: [GET]
#§3 Function Description
Retrieve the additional requirements (beyond mandatory product attributes) for listing a product in a particular category based on your shop's location. Requirements may include product certifications, size charts, dimensions and more.
Use this API to determine the supporting information that you must prepare before listing a product.
Note: It must be a leaf category that corresponds to the category tree type specified in the category_version property.
§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 Path Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| category_id | string | Y | 600001 | The ID of the category. It must be a leaf category. |
§6 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. |
| category_version | string | N | v1 | Filter categories by the category tree version.Possible values based on region: |
- US, EU and SEA: v2, represents the 7-level category tree. Important: For US, EU and SEA shops, you must pass v2 when using this API.
- Other regions: v1, represents the 3-level category tree.Default: v1 | locale |string |N |es-MX |The BCP-47 locale codes for displaying category information. Default: The default locale of your shop. Possible values:
cs-CZde-ATde-BEde-DEel-GRen-GBen-IEen-USes-ESes-MXfr-FRfr-BEhu-HUid-IDit-ITja-JPms-MYnl-NLnl-BEpl-PLpt-BRpt-PTth-THvi-VNzh-CN|
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/product/202309/categories/600001/rules?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&category_version=v1&locale=es-MX
§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 | |
| ^product_certifications | []object | Certification related rules. | |
| As per TikTok Shop guidelines, certifications are required for certain restricted product categories. Refer to TikTok Shop Restricted Products Policy for information on product category restrictions. | |||
| If this is empty, it means certifications are not required for this category. | |||
| ^^id | string | 602362 | The ID to identify the type of certification required. |
| ^^name | string | SNI Certificate | The name of the certification type. |
| ^^is_required | bool | true | A flag to indicate if the certification is always required when creating or editing a product. |
- true: The certification is always required.
- false: The certification is not required, or required only if certain conditions are met. Refer to
requirement_conditionsfor the specific requirements. | ^^document_details |string |Upload a user manual or instructions in the official local language.\n\nWhere there are multiple items sold as a part of a bundle, please clearly indicate which specific product the certification pertains to in the uploaded file or image. |Details about the certification documents that you must submit, including the content, format, and any other guidelines. | ^^sample_image_url |string |https://p-boei18n.byted.org/tos-boei18n-i-jvtte31kaf/80b32f2896829eeb69d4b278c4f3aa75.jpg~tplv-jvtte31kaf-origin-jpeg.jpeg |The URL to view an image of the sample certification document. | ^^requirement_conditions |[]object | |A list of conditions that determine if the certification is required based on the seller's inputs for a product attribute. If any of the conditions is met, the certification is required; otherwise, it is optional.
For example, there's a condition that states that the "Safety Data Sheet (SDS) for flammable materials" certification is required if the seller selects the value "Yes" for the attribute "Flammable Liquid?". For more scenario-based guidance on using this parameter, refer to the Solution Guide - CAT-PRE-HAZMAT.
Applicable only if is_required=false. |
^^^condition_type |string |VALUE_ID_MATCH |The type of condition, such as matching values, or range comparisons.
Possible values:
- VALUE_ID_MATCH: The condition is true when the seller selects a value whose ID matches the one specified in this condition. | ^^^attribute_id |string |101610 |The ID of the product attribute that is being evaluated by the condition. | ^^^attribute_value_id |string |1024358 |The ID of the product attribute value that must match the seller's input for the condition to be true. | ^^expiration_date |object | |Certification expiration date related rules. | ^^^is_required |bool |true |A flag to indicate whether an expiration date is required for this certification. | ^size_chart |object | |Size chart related rules. | ^^is_supported |bool |true |A flag to indicate whether size charts are supported.
Note: If size charts are not supported, even if you provide a size chart when creating or editing a product, the size chart will not be saved. | ^^is_required |bool |true |A flag to indicate whether a size chart is required. | ^cod |object | |Cash on Delivery (COD) related rules. Applicable only for the following markets:
- Global sellers: MY, PH, SA, TH, VN
- Local sellers: ID, MY, PH, SA, TH, VN | ^^is_supported |bool |true |A flag to indicate whether COD is supported.
Note: If COD is not supported, but you set is_cod_allowed=true when creating or editing a product, the listing will fail. |
^package_dimension |object | |Package dimension related rules. |
^^is_required |bool |true |A flag to indicate whether package dimensions are required. |
^epr |object | |Extended Producer Responsibility (EPR) related rules. |
^^is_required |bool |false |A flag to indicate whether EPR is required. |
^responsible_person |object | |Responsible person (RP) related rules. Applicable only for the EU market. |
^^is_required |bool |false |A flag to indicate whether the responsible person information is required. |
^manufacturer |object | |Manufacturer related rules. Applicable only for the EU market. |
^^is_required |bool |false |A flag to indicate whether the manufacturer information is required. |
^allowed_special_product_types |[]string |"PRE_ORDER" |The list of special product types, excluding regular products, that your shop is allowed to list in this category.
Possible values based on the region:
US
PRE_ORDER: The product is not yet available or released. Fulfillment can be extended by specifying a release date.MADE_TO_ORDER: The product is produced only after the order is received. Fulfillment can be extended by specifying a duration.CUSTOM: The product requires a fulfillment timeline that exceeds the standard due to other factors. Fulfillment can be extended by specifying a duration.
UK and SEA
PRE_ORDER: The product is not yet available or released. Fulfillment can be extended by specifying a duration.
Note: This field is omitted if you lack the permission to list special product types. Contact your account manager for assistance if you wish to list such products. | ^fees |[]object | |Product fees related rules. | ^^type |string |PFAND |The type of fee. Possible values: PFAND | ^^is_required |bool |true |A flag to indicate whether information about the fee is required. |
§9 Response Sample
{"code":0,"data":{"product_certifications":[{"id":"602362","name":"SNI Certificate","is_required":true,"document_details":"Upload a user manual or instructions in the official local language.\\n\\nWhere there are multiple items sold as a part of a bundle, please clearly indicate which specific product the certification pertains to in the uploaded file or image.","sample_image_url":"https://p-boei18n.byted.org/tos-boei18n-i-jvtte31kaf/80b32f2896829eeb69d4b278c4f3aa75.jpg~tplv-jvtte31kaf-origin-jpeg.jpeg","requirement_conditions":[{"condition_type":"VALUE_ID_MATCH","attribute_id":"101610","attribute_value_id":"1024358"}],"expiration_date":{"is_required":true}}],"size_chart":{"is_supported":true,"is_required":true},"cod":{"is_supported":true},"package_dimension":{"is_required":true},"epr":{"is_required":false},"responsible_person":{"is_required":false},"manufacturer":{"is_required":false},"allowed_special_product_types":"\"PRE_ORDER\"","fees":[{"type":"PFAND","is_required":true}]},"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 |
|---|---|
| 12052023 | Category does not exist |
| 12052024 | Category is not final category |
| 12052217 | All region shops must use V2 categories. Check the documentation for further details. |
| 12052220 | This category is prohibited or unsupported on TikTok Shop. Select another category. |
| 12052223 | This category is restricted. To sell in this category, apply through the Qualification Center in Seller Center. |
| 12052226 | This category is restricted. To sell in this category, apply through the Qualification Center in Seller Center. |
| 12052230 | Category version and categoryID are not matched. |
| 12052446 | Category is not open in this market |
| 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |
