Search Size Charts

POST

/product/202407/sizecharts/search

Retrieve size charts that a seller has created.

Authorizations

accessToken

Parameters

Query Parameters

page_size

required

integer format: int64

>= 1 <= 100

The number of results to be returned per page. Valid range: [1-100]

page_token

string

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

Array<string>

Allowed 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

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

Request Body

application/json

object

ids

Filter size charts by size chart template IDs. Max: 50 IDs

Array<string>

keyword

Filter size charts by size chart template name or by key words in the template name. Keyword searches do not return PRODUCT_SCOPED size charts because they do not have a template name. If both ids and keyword are provided, ids takes priority.

string

size_chart_mode

Filter size charts by usage mode. Possible values: REUSABLE_TEMPLATE: A size chart template that can be reused across multiple products. PRODUCT_SCOPED: A size chart created for and used by a single product. If omitted, the existing search behavior is preserved.

string

Allowed values: REUSABLE_TEMPLATE PRODUCT_SCOPED

Example

{
  "ids": [
    "7362027385890244398"
  ],
  "keyword": "size chart",
  "size_chart_mode": "REUSABLE_TEMPLATE"
}

Responses

200

Success

application/json

object

code

Status code; 0 means success.

integer format: int64

message

Success or failure message.

string

request_id

Request log ID.

string

data

object

size_chart

The list of size charts that meet the query conditions.

Array<object>

object

template_id

The size chart template ID.

string

template_name

The size chart template name.

string

images

The list of images included in a size chart.

Array<object>

object

uri

The URI to identify the image in API requests and responses.

string

url

The URL to access and view the image.

string

locale

The language of the size chart image.

string

related_category_ids

Leaf category IDs applicable to this size chart.

Array<string>

size_chart_datas

Localized structured size chart data. Each item contains a locale and the structured data for that locale.

Array<object>

object

locale

The language of the size chart table.

string

size_chart_data

Structured size chart data for the specified locale.

object

table

Structured table containing headers and rows.

object

headers

Ordered header definitions.

Array<object>

object

name

Header display name.

string

Standard size-system ID or measurement key.

string

rows

Rows of the size chart.

Array<object>

object

cells

Cells aligned by index with table.headers.

Array<object>

object

value

Cell value.

string

description

Additional size chart description.

string

is_one_size

Whether this is a one-size chart.

boolean

measurement_type

Possible values: GENERIC_MEASUREMENTS: generic measurements; BODY_MEASUREMENTS: shopper body measurements; PRODUCT_MEASUREMENTS: finished-product measurements.

string

Allowed values: GENERIC_MEASUREMENTS BODY_MEASUREMENTS PRODUCT_MEASUREMENTS

unit_system

Possible values: METRIC: metric units; IMPERIAL: imperial units.

string

Allowed values: METRIC IMPERIAL

size_types

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.

Array<string>

size_chart_mode

string

Allowed values: REUSABLE_TEMPLATE PRODUCT_SCOPED

next_page_token

An opaque token used to retrieve the next page of a paginated result set. If this value is non-empty, pass it in the page_token parameter of the next request. An empty value means there are no more results.

string

total_count

The number of size charts that meet the query conditions.

integer format: int64

Example

{
  "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"
              ]
            }
          }
        ],
        "size_chart_mode": "REUSABLE_TEMPLATE"
      }
    ],
    "next_page_token": "cGFnZV9udW1iZXI9Mg==",
    "total_count": 100
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}

Search Size Charts

Authorizations

Parameters

Query Parameters

Request Body

Example

Responses

200

Example

Start here

SDKs

OpenAPI