Query size charts in batch
GET https://{handle}.myshopline.com/admin/openapi/v20250601/sizecharts.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
.Query the product size data in batch maintained in the size chart app.
Query Parameters
- page_num integerThe page number where the queried data is located. If not provided, it defaults to the first page.Example:
1
- page_size integerThe number of size chart entries per page.Default value:20Value range:1-20Example:
20
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
Response
- 200
- 401
- 429
For more information about status codes, see Http status code.
Response Headers
traceId
traceId
Response Body
dataobject
Response data.has_next booleanIndicates whether there is more data available on the next page.true
:has data on next pagefalse
: no next page data
page_num integerCurrent page number.Example:1
page_size integerThe number of size chart entries per page.Example:20
size_chartsobject[]
A list of size chart data.applicable_attribute_list arrayA list of applicable variant attribute for size charts,which will be mounted on these variant attributes for display.Example:size
applicable_product_type stringMethod type for matching the size chart with products.ALL
:apply to all productsSPECIFIC
:apply to specific productsCOLLECTION
:apply to specific product collection
Example:ALL
collection_list arrayWhen theapplicable_product_type
is set toCOLLECTION
, use this field to get a list of collection IDs that matching the size chart.Example:12260895952237462871473144
contentsobject[]
Size Data List.cross_table_contentobject
Cross Table Data.column_title stringColumn Title of cross table.Example:weight
column_unitobject
The size unit of the columns in the cross table.convert_unit stringConversion Unit, the unit must belong to the unit type in theunit_type
parameter and must be different from the value ofdefault_unit
.Example:kg
default_unit stringDefault Unit, the unit must belong to the unit type specified in theunit_type
parameter.Example:lb
unit_type stringThe unit types supported by cross tables and the specific measurement units within each 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.Example:1 lb = 0.45 kg,1 feet = 30.48 cm
row_title stringRow Title of cross_table.Example:high
row_unitobject
The size unit of the rows in the cross table.convert_unit stringRow Column Conversion Unit, the unit must belong to the unit type in theunit_type
parameter and must be different from the value ofdefault_unit
.Example:feet
default_unit stringDefault Unit, the unit must belong to the unit type specified in theunit_type
parameter.Example:cm
unit_type stringThe unit types supported by cross tables and the specific measurement units within each 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[]
Cross Table Body, where an array represents the data for one row of the table. Each element in the array represents the data for a cell in the table.row_data arrayCross Table Row Data, where each element in the array represents a cell in a row of data.Example:XS,64
table_contentobject
Table Data.country_sizeobject
The country size data represents the names of sizes in different countries within this table.country_size_dataobject[]
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 stringCountry Name.Example:US
data arrayAn array representing the names of different sizes in the current country within the table.Example:78,89
cover_attribute booleanOverride Size value Text or not,Whentrue
is passed, the country size names will be used to display the size attribute values on the page.●true
:Override●false
:not Overridestatus booleanCountry size function Switch.●true
:trun on this function●false
:trun off this functionExample:true
remark stringTable remark.Example:1inch=2.54cm
size_dataobject[]
Table data body, an array represents a row of data in the table, the first array is the table header, each element in the array corresponds to the cell data in the table.row_data arrayArray representation of table row data, where each element in the array represents a cell.Example:XS,64
unitobject
The size unit of table.convert_unit stringConversion Unit, the unit provided must belong to the unit type specified in theunit_type
parameter and must be different from the value passed indefault_unit
.Example:in
default_unit stringDefault Unit, the unit must belong to the unit type specified in theunit_type
parameter.Example:cm
unit_type stringThe unit types supported by table and the specific measurement units within each 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[]
Tabular data body where one tab component can contain up to 5 tab columns, each tab column can include up to 10 size data entities, and tabs can be nested within tabs up to 2 levels deep.tab_contentobject[]
Size data of tab columns.cross_table_contentobject
Cross Table Data.column_title stringColumn Title of cross table.Example:weight
column_unitobject
The size unit of the columns in the cross table.convert_unit stringConversion Unit, the unit must belong to the unit type in theunit_type
parameter and must be different from the value ofdefault_unit
.Example:kg
default_unit stringDefault Unit, the unit must belong to the unit type specified in theunit_type
parameter.Example:lb
unit_type stringThe unit types supported by cross tables and the specific measurement units within each 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 remark stringCross Table Remark.row_title stringRow Title of cross_table.Example:high
row_unitobject
The size unit of the rows in the cross table.convert_unit stringRow Column Conversion Unit, the unit must belong to the unit type in theunit_type
parameter and must be different from the value ofdefault_unit
.Example:feet
default_unit stringDefault Unit, the unit must belong to the unit type specified in theunit_type
parameter.Example:cm
unit_type stringThe unit types supported by cross tables and the specific measurement units within each 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[]
Cross Table Body, where an array represents the data for one row of the table. Each element in the array represents the data for a cell in the table.row_data arrayCross Table Row Data, where each element in the array represents a cell in a row of data.Example:XS,64
table_contentobject
Table Data.country_sizeobject
The country size data represents the names of sizes in different countries within this table.country_size_dataobject[]
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 stringCountry Name.data arrayAn array representing the names of different sizes in the current country within the table.Example: ``cover_attribute booleanOverride Size value Text or not,Whentrue
is passed, the country size names will be used to display the size attribute values on the page.●true
:Override●false
:not Overridestatus booleanCountry size function Switch.●true
:trun on this function●false
:trun off this functionremark stringTable remark.size_dataobject[]
Table data body, an array represents a row of data in the table, the first array is the table header, each element in the array corresponds to the cell data in the table.row_data arrayArray representation of table row data, where each element in the array represents a cell.Example: ``unitobject
The size unit of table.convert_unit stringConversion Unit, the unit provided must belong to the unit type specified in theunit_type
parameter and must be different from the value passed indefault_unit
.default_unit stringDefault Unit, the unit must belong to the unit type specified in theunit_type
parameter.unit_type stringThe unit types supported by table and the specific measurement units within each 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 tabsobject[]
Secondary tab data , where there can be up to 5 secondary tab columns, each column can contain up to 10 size data entities.tab_contentobject[]
Size data of secondary tab columns.cross_table_contentobject
Cross Table Data.column_title stringColumn Title of cross table.column_unitobject
The size unit of the columns in the cross table.convert_unit stringConversion Unit, the unit must belong to the unit type in theunit_type
parameter and must be different from the value ofdefault_unit
.Example:kg
default_unit stringDefault Unit, the unit must belong to the unit type specified in theunit_type
parameter.Example:lb
unit_type stringThe unit types supported by cross tables and the specific measurement units within each 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 remark stringCross Table Remark.row_title stringRow Title of cross_table.row_unitobject
The size unit of the rows in the cross table.convert_unit stringRow Column Conversion Unit, the unit must belong to the unit type in theunit_type
parameter and must be different from the value ofdefault_unit
.Example:feet
default_unit stringDefault Unit, the unit must belong to the unit type specified in theunit_type
parameter.Example:cm
unit_type stringThe unit types supported by cross tables and the specific measurement units within each 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[]
Cross Table Body, where an array represents the data for one row of the table. Each element in the array represents the data for a cell in the table.row_data arrayCross Table Row Data, where each element in the array represents a cell in a row of data.Example:XS,64
table_contentobject
Table Data.country_sizeobject
The country size data represents the names of sizes in different countries within this table.country_size_dataobject[]
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 stringCountry Name.data arrayAn array representing the names of different sizes in the current country within the table.Example: ``cover_attribute booleanOverride Size value Text or not,Whentrue
is passed, the country size names will be used to display the size attribute values on the page.●true
:Override●false
:not Overridestatus booleanCountry size function Switch.●true
:trun on this function●false
:trun off this functionremark stringTable remark.size_dataobject[]
Table data body, an array represents a row of data in the table, the first array is the table header, each element in the array corresponds to the cell data in the table.row_data arrayArray representation of table row data, where each element in the array represents a cell.Example: ``unitobject
The size unit of table.convert_unit stringConversion Unit, the unit provided must belong to the unit type specified in theunit_type
parameter and must be different from the value passed indefault_unit
.default_unit stringDefault Unit, the unit must belong to the unit type specified in theunit_type
parameter.unit_type stringThe unit types supported by table and the specific measurement units within each 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 text stringText Type Content.title stringTitle of size chart table.type stringEnumaration of supported content types in a secondary tab column.Enum Value Description SIZE_CHART Table Type CROSS_SIZE_CHART Cross Table Type IMAGE Image Type TEXT Text Type url stringImage Type Content.tab_name stringThe name of secondary tab column.text stringText Type Content.title stringTitle of size chart table.type stringEnumaration of supported content types in a tab column.Enum Value Description SIZE_CHART Table Type CROSS_SIZE_CHART Cross Table Type IMAGE Image Type TEXT Text Type TAB Secondary Tab Type url stringImage Type Content.tab_name stringThe name of tab column.text stringText Type Content.Example:My SizeChart
title stringTitle of size chart table.Example:My SizeChart
type stringEnumaration of supported content types in a size chart.Enum Value Description SIZE_CHART Table Type CROSS_SIZE_CHART Cross Table Type IMAGE Image Type TEXT Text Type TAB Tab Type Example:SIZE_CHART
url stringImage Type Content.Example:https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png
create_time stringSize Chart Creation Timestamp (East Asia Time)Example:2024-08-23T16:04:42.527+08:00
language_scope stringThe method type that the size chart used to match language.- ALL :All languages(default).
- SPECIFIC :specific languages,When
language_scope
=SPECIFIC
, thelanguages
cannot be empty and must specify the supportedlanguages
.
languages arrayWhenlanguage_scope
=SPECIFIC
, retrieve the list of language codes that match the size chart from this field.The supported language enums are as follows.- pt-pt: Portuguese (Portugal)
- tr: Turkish
- zh-hans-cn: Simplified Chinese (Mainland China)
- vi: Vietnamese
- sv: Swedish
- zh-hant-tw: Traditional Chinese
- th: Thai
- ar: Arabic
- pl: Polish
- ro: Romanian
- sk: Slovak
- ko: Korean
- lv: Latvian
- ms: Malay
- pt: Portuguese (Brazil)
- it: Italian
- ja: Japanese
- lt: Lithuanian
- sl: Slovenian
- nb: Norwegian Bokmål
- ru: Russian
- nl: Dutch
- en: English
- id: Indonesian
- et: Estonian
- bg: Bulgarian
- hi: Hindi
- cs: Czech
- es: Spanish
- fr: French
- fi: Finnish
- da: Danish
- el: Greek
- de: German
- hr: Croatian
- hu: Hungarian
Example: ``product_list arrayWhenapplicable_product_type
is set toSPECIFIC
, this field represents a list of product IDs for matching the size chart, limited to returning only the first 100 product IDs order by the time of addition.Example:16064649853088531841170520
size_chart_id stringa unique id of Size Chart .Example:13266288837293171311580520
status booleanPublish Status of size chart.Enum Value Description true
Publish this sizechart false
Not publish this sizechart title stringSize chart title.Example:My SizeChart
update_time stringLast Update Timestamp (UTC+8).Example:2024-08-23T16:04:42.527+08:00
total longNumber of size charts on the current page.Example:1
API Explorer
Debugger
Examples
Was this article helpful to you?