Create a size chart
POST https://{handle}.myshopline.com/admin/openapi/v20250601/sizechart.json
handle
: The store's unique identifier, which is the prefix of the store's domain name. For example, if a store's domain name is open001.myshopline.com
, the store handle is open001
.Create a size chart to introduce the size information of your products to your customers.
Request Headers
- Content-Type requiredThe value of this field is fixed to
application/json; charset=utf-8
- Authorization string requiredThe access token for the API. Please refer to App authorization to obtain the access token, and then put the obtained access token into the API request header in Bearer Token.Example:
Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw
Request Body
reqobject
Request parameters.applicable_attribute_list array requiredA list of product attributes applicable to the size chart, where each attribute can be used to describe product characteristics, such assize
.Maximum length per string: 255Maximum size: 50Example:size
applicable_product_type stringSpecify the scope of products to which the size chart applies. Valid values are:ALL
:apply to all productsSPECIFIC
:apply to specific productsCOLLECTION
:apply to specific product collection
Default value:ALL
Example:ALL
collection_list arrayWhen theapplicable_product_type
is set toCOLLECTION
, use this field to pass in a list of collection IDs to which the size chart applies.Maximum size : 50Example:12260895952237462871473144
contentsobject[] required
Size data list, to be processed sequentially from the first item, with any items beyond the first 10 being truncated.Maximum size: 10cross_table_contentobject
Cross table data that commonly used to display specific sizes suitable for different body parameters. For example, a height of 170cm and a weight of 70kg are suitable for size L.column_title stringThe column title in a cross table that indicates the size information represented by the column data. For example,weight
denotes that the column data represents weight data.Default value:weight
Maximum length:20Example:weight
column_unitobject
The size unit of the column's data in the cross table.convert_unit stringThe optional display unit for the size data. Customers can switch between the default unit (default_unit
) and this unit to display sizes. Refer to the table in theunit_type
description for valid values of this field. You need to set a supported unit based on the specifiedunit_type
.Default value:kg
.Example:kg
default_unit stringThe default display unit for the size data. Refer to the table in theunit_type
description for valid values of this field. You need to set a supported unit based on the specifiedunit_type
.Default value:lb
.Example:lb
unit_type stringThe unit types supported by cross tables.Valid values are:LENGTH
: lengthWEIGHT
(default value): weightBULK
: volume
The following table shows the specific measurement units supported by each unit type.Unit Type Unit Type Description Supported Unit Supported Unit Description LENGTH Length feet Feet LENGTH Length m Meters LENGTH Length cm Centimeters LENGTH Length mm Millimeters LENGTH Length in Inches WEIGHT Weight (Default) lb Pounds WEIGHT Weight (Default) oz Ounces WEIGHT Weight (Default) kg Kilograms WEIGHT Weight (Default) g Grams WEIGHT Weight (Default) mg Milligrams BULK Volume us_gal Gallon (US) BULK Volume uk_gal Gallon (UK) BULK Volume oz_us Fluid Ounce (US) BULK Volume oz_uk Fluid Ounce (UK) BULK Volume ml Milliliters BULK Volume l Liters Example:WEIGHT
remark stringCross table remark.Maximum length:255Example:1 lb = 0.45 kg,1 feet = 30.48 cm
row_title stringThe row title in a cross table that explains the size information represented by the row data. For example,height
denotes that the row data represents height data.Default value:height
Maximum length: 20Example:height
row_unitobject
The size unit of the rows in the cross table.convert_unit stringThe optional display unit for the size data. Customers can switch between the default unit (default_unit
) and this unit to display sizes. Refer to the table in theunit_type
description for valid values of this field. You need to set a supported unit based on the specifiedunit_type
.Default value:feet
.Example:feet
default_unit stringThe default display unit for the size data. Refer to the table in theunit_type
description for valid values of this field. You need to set a supported unit based on the specifiedunit_type
.Default value:cm
.Example:cm
unit_type stringThe unit types supported by cross tables .Valid values are:LENGTH
: lengthWEIGHT
(default value): weightBULK
: volume
The following table shows the specific measurement units supported by each unit type.Unit Type Unit Type Description Supported Unit Supported Unit Description LENGTH Length feet Feet LENGTH Length m Meters LENGTH Length cm Centimeters LENGTH Length mm Millimeters LENGTH Length in Inches WEIGHT Weight (Default) lb Pounds WEIGHT Weight (Default) oz Ounces WEIGHT Weight (Default) kg Kilograms WEIGHT Weight (Default) g Grams WEIGHT Weight (Default) mg Milligrams BULK Volume us_gal Gallon (US) BULK Volume uk_gal Gallon (UK) BULK Volume oz_us Fluid Ounce (US) BULK Volume oz_uk Fluid Ounce (UK) BULK Volume ml Milliliters BULK Volume l Liters Example:LENGTH
size_dataobject[] required
A list of cross table data, where the first element represents the table header. Each element in the array corresponds to a row of data in the table.Maximum size: 50row_data array requiredA list of cross table row data, where each element in the array represents data within a cell.Maximum size: 50Maximum length per string: 19Example:XS,64
table_contentobject
Table data that commonly used to display size data in tabular form. For example, the shoulder width for size S is 60, and the waist circumference is 55.country_sizeobject
The country size data, representing size names in different countries.country_size_dataobject[] required
The country size data, where the first element of the array represents the country, and the other elements represent the names of different sizes in that country.country string requiredCountry name.Maximum length: 19Example:United States
data array requiredA list of names for different sizes in a country.Maximum size: 21Maximum length per string: 19Example:78,89
cover_attribute booleanWhether to usecountry_size_data
to override the default size values.●true
:override●false
:not overrideDefault value:false
status booleanWhether to turn on the country size switch.●true
:turn on the switch.●false
:turn off the switch.Default value:false
Example:true
remark stringTable remark.Maximum length: 255Example:1inch=2.54cm
size_dataobject[] required
A list of cross table data, where the first element represents the table header. Each element in the array corresponds to a row of data in the table.Maximum size: 50row_data array requiredA list of cross table row data, where each element in the array represents data within a cell.Maximum size: 50Maximum length per string: 19Example:XS,64
unitobject
The unit of measurement used for the size data in the table.convert_unit stringThe optional display unit for the size data. Customers can switch between the default unit (default_unit
) and this unit to display sizes. Refer to the table in theunit_type
description for valid values of this field. You need to set a supported unit based on the specifiedunit_type
.Default value:in
.Example:in
default_unit stringThe default display unit for the size data. Refer to the table in theunit_type
description for valid values of this field. You need to set a supported unit based on the specifiedunit_type
.Default value:cm
.Example:cm
unit_type stringThe unit types supported by table .Valid values are:LENGTH
: lengthWEIGHT
(default value): weightBULK
: volume
The following table shows the specific measurement units supported by each unit type.Unit Type Unit Type Description Supported Unit Supported Unit Description LENGTH Length feet Feet LENGTH Length m Meters LENGTH Length cm Centimeters LENGTH Length mm Millimeters LENGTH Length in Inches WEIGHT Weight (Default) lb Pounds WEIGHT Weight (Default) oz Ounces WEIGHT Weight (Default) kg Kilograms WEIGHT Weight (Default) g Grams WEIGHT Weight (Default) mg Milligrams BULK Volume us_gal Gallon (US) BULK Volume uk_gal Gallon (UK) BULK Volume oz_us Fluid Ounce (US) BULK Volume oz_uk Fluid Ounce (UK) BULK Volume ml Milliliters BULK Volume l Liters Example:LENGTH
tabsobject[]
A list of tab data that allows for multiple tab columns with various types of size data content within each tab.Maximum size : 5tab_contentobject[]
A list of tab column data.Maximum size: 10cross_table_contentobject
Cross table data that commonly used to display specific sizes suitable for different body parameters. For example, a height of 170cm and a weight of 70kg are suitable for size L.column_title stringThe column title in a cross table that indicates the size information represented by the column data. For example,weight
denotes that the column data represents weight data.Default value:weight
Maximum length:20Example:weight
column_unitobject
The size unit of the columns in the cross table.convert_unit stringThe optional display unit for the size data. Customers can switch between the default unit (default_unit
) and this unit to display sizes. Refer to the table in theunit_type
description for valid values of this field. You need to set a supported unit based on the specifiedunit_type
.Default value:kg
.Example:kg
default_unit stringThe default display unit for the size data. Refer to the table in theunit_type
description for valid values of this field. You need to set a supported unit based on the specifiedunit_type
.Default value:lb
.Example:lb
unit_type stringThe unit types supported by cross tables.Valid values are:LENGTH
: lengthWEIGHT
(default value): weightBULK
: volume
The following table shows the specific measurement units supported by each unit type.Unit Type Unit Type Description Supported Unit Supported Unit Description LENGTH Length feet Feet LENGTH Length m Meters LENGTH Length cm Centimeters LENGTH Length mm Millimeters LENGTH Length in Inches WEIGHT Weight (Default) lb Pounds WEIGHT Weight (Default) oz Ounces WEIGHT Weight (Default) kg Kilograms WEIGHT Weight (Default) g Grams WEIGHT Weight (Default) mg Milligrams BULK Volume us_gal Gallon (US) BULK Volume uk_gal Gallon (UK) BULK Volume oz_us Fluid Ounce (US) BULK Volume oz_uk Fluid Ounce (UK) BULK Volume ml Milliliters BULK Volume l Liters Example:WEIGHT
remark stringCross table remark.Maximum length:255Example:1 lb = 0.45 kg,1 feet = 30.48 cm
row_title stringThe row title in a cross table that explains the size information represented by the row data. For example,height
denotes that the row data represents height data.Default value:height
Maximum length: 20Example:height
row_unitobject
The size unit of the rows in the cross table.convert_unit stringThe optional display unit for the size data. Customers can switch between the default unit (default_unit
) and this unit to display sizes. Refer to the table in theunit_type
description for valid values of this field. You need to set a supported unit based on the specifiedunit_type
.Default value:feet
.Example:feet
default_unit stringThe default display unit for the size data. Refer to the table in theunit_type
description for valid values of this field. You need to set a supported unit based on the specifiedunit_type
.Default value:cm
.Example:cm
unit_type stringThe unit types supported by cross tables.Valid values are:LENGTH
: lengthWEIGHT
(default value): weightBULK
: volume
The following table shows the specific measurement units supported by each unit type.Unit Type Unit Type Description Supported Unit Supported Unit Description LENGTH Length feet Feet LENGTH Length m Meters LENGTH Length cm Centimeters LENGTH Length mm Millimeters LENGTH Length in Inches WEIGHT Weight (Default) lb Pounds WEIGHT Weight (Default) oz Ounces WEIGHT Weight (Default) kg Kilograms WEIGHT Weight (Default) g Grams WEIGHT Weight (Default) mg Milligrams BULK Volume us_gal Gallon (US) BULK Volume uk_gal Gallon (UK) BULK Volume oz_us Fluid Ounce (US) BULK Volume oz_uk Fluid Ounce (UK) BULK Volume ml Milliliters BULK Volume l Liters Example:LENGTH
size_dataobject[] required
A list of table data, where the first element represents the table header. Each element in the array corresponds to a row of data in the table.Maximum size: 50row_data array requiredA list of cross table row data, where each element in the array represents data within a cell.Maximum size: 50Maximum length per string: 19Example:XS,64
table_contentobject
Table data that commonly used to display size data in tabular form. For example, the shoulder width for size S is 60, and the waist circumference is 55.country_sizeobject
The country size data, representing size names in different countries.country_size_dataobject[] required
The country size data, where the first element of the array represents the country, and the other elements represent the names of different sizes in that country.country string requiredCountry name.Maximum length:19Example:US
data array requiredA list of names for different sizes in a country.Maximum size: 21Maximum length per string: 19Example:78,89
cover_attribute booleanWhether to usecountry_size_data
to override the default size values.●true
:override●false
:not overrideDefault value:false
status booleanWhether to turn on the country size switch.●true
:turn on the switch●false
:turn off the switch.Default value:false
Example:true
remark stringTable remark.Maximum length: 255Example:1inch=2.54cm
size_dataobject[] required
A list of table data, where the first element represents the table header. Each element in the array corresponds to a row of data in the table.Maximum size: 50row_data array requiredA list of cross table row data, where each element in the array represents data within a cell.Maximum size: 50Maximum length per string: 19Example:XS,64
unitobject
The unit of measurement used for the size data in the table.convert_unit stringThe optional display unit for the size data. Customers can switch between the default unit (default_unit
) and this unit to display sizes. Refer to the table in theunit_type
description for valid values of this field. You need to set a supported unit based on the specifiedunit_type
.Default value:in
.Example:in
default_unit stringThe default display unit for the size data. Refer to the table in theunit_type
description for valid values of this field. You need to set a supported unit based on the specifiedunit_type
.Default value:cm
.Example:cm
unit_type stringThe unit types supported by table .Valid values are:LENGTH
: lengthWEIGHT
(default value): weightBULK
: volume
The following table shows the specific measurement units supported by each unit type.Unit Type Unit Type Description Supported Unit Supported Unit Description LENGTH Length feet Feet LENGTH Length m Meters LENGTH Length cm Centimeters LENGTH Length mm Millimeters LENGTH Length in Inches WEIGHT Weight (Default) lb Pounds WEIGHT Weight (Default) oz Ounces WEIGHT Weight (Default) kg Kilograms WEIGHT Weight (Default) g Grams WEIGHT Weight (Default) mg Milligrams BULK Volume us_gal Gallon (US) BULK Volume uk_gal Gallon (UK) BULK Volume oz_us Fluid Ounce (US) BULK Volume oz_uk Fluid Ounce (UK) BULK Volume ml Milliliters BULK Volume l Liters Example:LENGTH
tabsobject[]
Secondary tab data structure where tabs can be nested under tabs to create a second-level tab effect, with a maximum nesting level of 2.Maximum size : 5tab_contentobject[]
A list of tab column data.Maximum size: 10cross_table_contentobject
Cross table data that commonly used to display specific sizes suitable for different body parameters. For example, a height of 170cm and a weight of 70kg are suitable for size L.column_title stringThe column title in a cross table that indicates the size information represented by the column data. For example,weight
denotes that the column data represents weight data.Default value:weight
Maximum length:20Example:weight
column_unitobject
The size unit of the columns in the cross table.convert_unit stringThe optional display unit for the size data. Customers can switch between the default unit (default_unit
) and this unit to display sizes. Refer to the table in theunit_type
description for valid values of this field. You need to set a supported unit based on the specifiedunit_type
.Default value:kg
.Example:kg
default_unit stringThe default display unit for the size data. Refer to the table in theunit_type
description for valid values of this field. You need to set a supported unit based on the specifiedunit_type
.Default value:lb
.Example:lb
unit_type stringThe unit types supported by cross tables .Valid values are:LENGTH
: lengthWEIGHT
(default value): weightBULK
: volume
The following table shows the specific measurement units supported by each unit type.Unit Type Unit Type Description Supported Unit Supported Unit Description LENGTH Length feet Feet LENGTH Length m Meters LENGTH Length cm Centimeters LENGTH Length mm Millimeters LENGTH Length in Inches WEIGHT Weight (Default) lb Pounds WEIGHT Weight (Default) oz Ounces WEIGHT Weight (Default) kg Kilograms WEIGHT Weight (Default) g Grams WEIGHT Weight (Default) mg Milligrams BULK Volume us_gal Gallon (US) BULK Volume uk_gal Gallon (UK) BULK Volume oz_us Fluid Ounce (US) BULK Volume oz_uk Fluid Ounce (UK) BULK Volume ml Milliliters BULK Volume l Liters Example:WEIGHT
remark stringCross table remark.Maximum length:255Example:1 lb = 0.45 kg,1 feet = 30.48 cm
row_title stringThe row title in a cross table that explains the size information represented by the row data. For example,high
denotes that the row data represents height data.Default value:high
Maximum length: 20Example:height
row_unitobject
The size unit of the rows in the cross table.convert_unit stringThe optional display unit for the size data. Customers can switch between the default unit (default_unit
) and this unit to display sizes. Refer to the table in theunit_type
description for valid values of this field. You need to set a supported unit based on the specifiedunit_type
.Default value:feet
.Example:feet
default_unit stringThe default display unit for the size data. Refer to the table in theunit_type
description for valid values of this field. You need to set a supported unit based on the specifiedunit_type
.Default value:cm
.Example:cm
unit_type stringThe unit types supported by cross tables.Valid values are:LENGTH
: lengthWEIGHT
(default value): weightBULK
: volume
The following table shows the specific measurement units supported by each unit type.Unit Type Unit Type Description Supported Unit Supported Unit Description LENGTH Length feet Feet LENGTH Length m Meters LENGTH Length cm Centimeters LENGTH Length mm Millimeters LENGTH Length in Inches WEIGHT Weight (Default) lb Pounds WEIGHT Weight (Default) oz Ounces WEIGHT Weight (Default) kg Kilograms WEIGHT Weight (Default) g Grams WEIGHT Weight (Default) mg Milligrams BULK Volume us_gal Gallon (US) BULK Volume uk_gal Gallon (UK) BULK Volume oz_us Fluid Ounce (US) BULK Volume oz_uk Fluid Ounce (UK) BULK Volume ml Milliliters BULK Volume l Liters Example:LENGTH
size_dataobject[] required
A list of table data, where the first element represents the table header. Each element in the array corresponds to a row of data in the table.Maximum size: 50row_data array requiredA list of cross table row data, where each element in the array represents data within a cell.Maximum size: 50Maximum length per string: 19Example:XS,64
table_contentobject
Table data that commonly used to display size data in tabular form. For example, the shoulder width for size S is 60, and the waist circumference is 55.country_sizeobject
The country size data, representing size names in different countries.country_size_dataobject[] required
The country size data, where the first element of the array represents the country, and the other elements represent the names of different sizes in that country.country string requiredCountry name.Maximum length:19Example:US
data array requiredA list of names for different sizes in a country.Maximum size: 21Maximum length per string: 19Example:78,89
cover_attribute booleanWhether to usecountry_size_data
to override the default size values.●true
:override●false
:not overrideDefault value:false
status booleanWhether to turn on the country size switch.●true
:turn on the switch.●false
:turn off the switch.Default value:false
Example:true
remark stringTable remark.Maximum length: 255Example:1inch=2.54cm
size_dataobject[] required
A list of table data, where the first element represents the table header. Each element in the array corresponds to a row of data in the table.Maximum size: 50row_data array requiredA list of cross table row data, where each element in the array represents data within a cell.Maximum size: 50Maximum length per string: 19Example:XS,64
unitobject
The unit of measurement used for the size data in the table.convert_unit stringThe optional display unit for the size data. Customers can switch between the default unit (default_unit
) and this unit to display sizes. Refer to the table in theunit_type
description for valid values of this field. You need to set a supported unit based on the specifiedunit_type
.Default value:in
.Example:in
default_unit stringThe default display unit for the size data. Refer to the table in theunit_type
description for valid values of this field. You need to set a supported unit based on the specifiedunit_type
.Default value:cm
.Example:cm
unit_type stringThe unit types supported by table.Valid values are:LENGTH
: lengthWEIGHT
(default value): weightBULK
: volume
The following table shows the specific measurement units supported by each unit type.Unit Type Unit Type Description Supported Unit Supported Unit Description LENGTH Length feet Feet LENGTH Length m Meters LENGTH Length cm Centimeters LENGTH Length mm Millimeters LENGTH Length in Inches WEIGHT Weight (Default) lb Pounds WEIGHT Weight (Default) oz Ounces WEIGHT Weight (Default) kg Kilograms WEIGHT Weight (Default) g Grams WEIGHT Weight (Default) mg Milligrams BULK Volume us_gal Gallon (US) BULK Volume uk_gal Gallon (UK) BULK Volume oz_us Fluid Ounce (US) BULK Volume oz_uk Fluid Ounce (UK) BULK Volume ml Milliliters BULK Volume l Liters Example:LENGTH
text stringThe text content under the tab.Example:My SizeChart
title stringSize chart title. If the title exceeds the maximum length, it will be truncated.Maximum length: 50type string requiredEnumaration of supported content types in secondary tab. Valid values are:SIZE_CHART
: indicates a tableCROSS_SIZE_CHART
: indicates a cross tableIMAGE
: indicates an imageTEXT
: indicates text
url stringThe image under the tab, represented by a URL. Specify this field when the value oftype
isIMAGE
.tab_name string requiredThe name of tab column. Maximum length : 50text stringThe text content under the tab.Example:My SizeChart
title stringSize chart title. If the title exceeds the maximum length, it will be truncated.Maximum length: 50Example:Size Chart
type string requiredThe content type in the tab. Valid values are:SIZE_CHART
: indicates a tableCROSS_SIZE_CHART
: indicates a cross tableIMAGE
: indicates an imageTEXT
: indicates textTAB
: indicates a tab
Example:SIZE_CHART
url stringThe image under the tab, represented by a URL. Specify this field when the value oftype
isIMAGE
.Example:https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png
tab_name string requiredThe name of tab column.Maximum length : 50text stringThe text content.Example:My SizeChart
title stringSize chart title. If the title exceeds the maximum length, it will be truncated.Maximum length: 50Example:Size Chart
type string requiredEnumaration of supported content types in a size chart. Valid values are:SIZE_CHART
: indicates a tableCROSS_SIZE_CHART
: indicates a cross tableIMAGE
: indicates an imageTEXT
: indicates textTAB
: indicates a tab
Example:SIZE_CHART
url stringThe image content , represented by a URL. Specify this field when the value oftype
isIMAGE
.Example:https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png
language_scope stringSpecify the scope of languages to which the size chart applies. Valid values are:ALL
: apply to all languagesSPECIFIC
: apply to specific languages
Default value:ALL
Example:ALL
languages arrayWhenlanguage_scope
is set toSPECIFIC
, use this field to pass an array of language codes to which the size chart applies.pt-pt
: Portuguese (Portugal)tr
: Turkishzh-hans-cn
: Simplified Chinese (Mainland China)vi
: Vietnamesesv
: Swedishzh-hant-tw
: Traditional Chineseth
: Thaiar
: Arabicpl
: Polishro
: Romaniansk
: Slovakko
: Koreanlv
: Latvianms
: Malaypt
: Portuguese (Brazil)it
: Italianja
: Japaneselt
: Lithuaniansl
: Sloveniannb
: Norwegian Bokmålru
: Russiannl
: Dutchen
: Englishid
: Indonesianet
: Estonianbg
: Bulgarianhi
: Hindics
: Czeches
: Spanishfr
: Frenchfi
: Finnishda
: Danishel
: Greekde
: Germanhr
: Croatianhu
: Hungarian
Example:EN,CN
product_list arrayWhenapplicable_product_type
is set toSPECIFIC
, use this field to pass in a list of product IDs to which the size chart applies.Maximum size: 100Example:16064649853088531841170520
status booleanWhether to publish the size chart.true
: publishfalse
: not publish
Default value:false
title string requiredSize chart title. It will be truncated if it exceeds the maximum length.Maximum length:100Example:My SizeChart
Response
- 200
- 401
- 429
For more information about status codes, see Http status code.
Response Headers
traceId
traceId
Response Body
dataobject
Response data.size_chart_id stringSize chart ID.Example:13266288837293171311580520
API Explorer
Debugger
Examples
Was this article helpful to you?
Error loading component.