stable全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /product/202407/sizecharts/search
#§2 Method: [POST]
#§3 Function Description
Retrieve size charts that a seller has created.
§4 Common Parameters
For common parameters, refer to How to call TikTok Shop APIs - Common Parameters
| Properties | Location | Type | Require | Sample | Properties description |
|---|---|---|---|---|---|
| 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. |
| page_size | int | Y | 10 | The number of results to be returned per page. |
| Valid range: [1-100] | ||||
| page_token | string | N | b2Zmc2V0PTAK | 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. |
| locales | []string | N | en-US,es-ES | The BCP-47 locale codes for displaying the size charts. |
| Default: The default locale of your shop. | ||||
| Possible values: |
- de-DE
- en-GB
- en-IE
- en-US
- es-ES
- es-MX
- fr-FR
- id-ID
- it-IT
- ja-JP
- ms-MY
- pt-BR
- th-TH
- vi-VN
- zh-CN |
§6 Request Body Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| ids | []string | N | ["7362027385890244398"] | Filter size charts by size chart template IDs. |
| Max: 50 IDs | ||||
| keyword | string | N | size chart | Filter size charts by size chart template name or by key words in the template name. |
If both ids and keyword are provided, ids takes priority. |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/product/202407/sizecharts/search?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&page_size=10&page_token=b2Zmc2V0PTAK&locales=en-US,es-ES
Body
{"ids":["7362027385890244398"],"keyword":"size chart"}
§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 | |
| ^size_chart | []object | The list of size charts that meet the query conditions. | |
| ^^template_id | string | 7362027385890244398 | The size chart template ID. |
| ^^template_name | string | size chart | The size chart template name. |
| ^^images | []object | The list of images included in a size chart. | |
| ^^^uri | string | tos-maliva-i-o3syd03w52-us/c668cdf70b7f483c94dbe | The URI to identify the image in API requests and responses. |
| ^^^url | string | https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/6c8519a3663a4d728c4e3c131dc914b4~tplv-o3syd03w52-resize-jpeg:300:300.jpeg?from=522366036 | The URL to access and view the image. |
| ^^^locale | string | en-US | The language of the size chart image. |
| ^^related_category_ids | []string | 601739,601740 | Leaf category IDs applicable to this size chart. |
| ^^size_chart_datas | []object | Localized structured size chart data. Each item contains a locale and the structured data for that locale. | |
| ^^^locale | string | en-US | The language of the size chart table. |
| ^^^size_chart_data | object | Structured size chart data for the specified locale. | |
| ^^^^table | object | Structured table containing headers and rows. | |
| ^^^^^headers | []object | Ordered header definitions. | |
| ^^^^^^name | string | Bust (cm) | Header display name. |
| ^^^^^^id | string | size_chart_size_system_size | Standard size-system ID or measurement key. |
| ^^^^^rows | []object | Rows of the size chart. | |
| ^^^^^^cells | []object | Cells aligned by index with table.headers. | |
| ^^^^^^^value | string | M | Cell value. |
| ^^^^description | string | Use body measurements. | Additional size chart description. |
| ^^^^is_one_size | bool | false | Whether this is a one-size chart. |
| ^^^^measurement_type | string | BODY_MEASUREMENTS | Possible values: GENERIC_MEASUREMENTS: generic measurements; BODY_MEASUREMENTS: shopper body measurements; PRODUCT_MEASUREMENTS: finished-product measurements. |
| ^^^^unit_system | string | METRIC | Possible values: METRIC: metric units; IMPERIAL: imperial units. |
| ^^^^size_types | []string | size_chart_size_type_regular | Possible values include: size_chart_common_size_type: Common; size_chart_size_type_regular: Regular; size_chart_size_type_juniors: Juniors; size_chart_size_type_plus: Plus; size_chart_size_type_big&tall: Big & Tall; size_chart_size_type_petite: Petite. Available values depend on the category. |
| ^next_page_token | string | b2Zmc2V0PTAK | 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_count | int | 100 | The number of size charts that meet the query conditions. |
§9 Response Sample
{"code":0,"data":{"size_chart":[{"template_id":"7362027385890244398","template_name":"size chart","images":[{"uri":"tos-maliva-i-o3syd03w52-us/c668cdf70b7f483c94dbe","url":"https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/6c8519a3663a4d728c4e3c131dc914b4~tplv-o3syd03w52-resize-jpeg:300:300.jpeg?from=522366036","locale":"en-US"}],"related_category_ids":"601739,601740","size_chart_datas":[{"locale":"en-US","size_chart_data":{"table":{"headers":[{"name":"Bust (cm)","id":"size_chart_size_system_size"}],"rows":[{"cells":[{"value":"M"}]}]},"description":"Use body measurements.","is_one_size":false,"measurement_type":"BODY_MEASUREMENTS","unit_system":"METRIC","size_types":"size_chart_size_type_regular"}}]}],"next_page_token":"b2Zmc2V0PTAK","total_count":100},"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 |
|---|---|
| 12019108 | page number is invalid |
| 12019109 | page size is invalid |
| 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |