Размерные сетки и обмеры для таблиц размеров

Метод доступен для всех моделей.

Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке

Возвращает размерные сетки и обмеры, из которых можно составить таблицу размеров для указанной размерной характеристики. Их идентификаторы передаются в sizeChartId ячеек в методах создания и обновления таблиц размеров POST v2/businesses/{businessId}/size-tables/create и POST v2/businesses/{businessId}/size-tables/update.

В список входят:

  • стандартные размерные сетки Маркета — значения в них выбираются из справочника sizeValues;
  • размерные сетки, значения в которых задаются текстом;
  • обмеры — значения в них тоже задаются текстом.

Брендовые размерные сетки в список не входят, и использовать их в своих таблицах нельзя: для них возвращается ошибка UNKNOWN_SIZE_CHART.

Обязательные размерные сетки отмечены required: true. В таблице должна быть хотя бы одна из них, а каждую обязательную сетку в таблице нужно заполнить во всех строках.

Для неизвестного идентификатора размерной характеристики возвращается ошибка UNKNOWN_SIZE_PARAMETER.

⚙️ Лимит: 100 запросов в минуту

Request

POST

https://api.partner.market.yandex.ru/v2/businesses/{businessId}/size-tables/charts

Path parameters

Name

Description

businessId

Type: integer

Идентификатор кабинета.

Чтобы его узнать, воспользуйтесь запросом GET v2/campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

Min value: 1

Body

application/json
{
  "sizeParameterId": 1
}

Name

Description

sizeParameterId

Type: integer

Идентификатор размерной характеристики.

Min value: 1

Responses

200 OK

Размерные сетки и обмеры размерной характеристики.

Body

application/json
{
  "status": "OK",
  "result": {
    "sizeParameterId": 0,
    "sizeCharts": [
      {
        "sizeChartId": 0,
        "sizeChartName": "example",
        "columnType": "SIZE_CHART",
        "required": true,
        "sizeValues": [
          null
        ]
      }
    ]
  }
}

Type: object

All of 2 types
  • Type: ApiResponse

    Стандартная обертка для ответов сервера.

    Example
    {
      "status": "OK"
    }
    
  • Type: object

    result

    Type: GetSizeChartsResultDTO

    Размерные сетки и обмеры размерной характеристики.

    Example
    {
      "sizeParameterId": 0,
      "sizeCharts": [
        {
          "sizeChartId": 0,
          "sizeChartName": "example",
          "columnType": "SIZE_CHART",
          "required": true,
          "sizeValues": [
            {
              "sizeValueId": 0,
              "sizeValue": "example"
            }
          ]
        }
      ]
    }
    
    Example
    {
      "result": {
        "sizeParameterId": 0,
        "sizeCharts": [
          {
            "sizeChartId": 0,
            "sizeChartName": "example",
            "columnType": "SIZE_CHART",
            "required": true,
            "sizeValues": [
              {}
            ]
          }
        ]
      }
    }
    

ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Type: string

Enum: OK, ERROR

ApiResponse

Стандартная обертка для ответов сервера.

Name

Description

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

Example
{
  "status": "OK"
}

SizeTableColumnType

Тип колонки таблицы размеров:

  • SIZE_CHART — размерная сетка, по которой определяется размер товара.
  • MEASUREMENT — обмер, например обхват груди или длина стопы. В определении размера товара не участвует.

Type: string

Enum: SIZE_CHART, MEASUREMENT

SizeChartValueDTO

Значение из справочника размерной сетки.

Name

Description

sizeValue

Type: string

Текст значения.

Example: example

sizeValueId

Type: integer

Идентификатор значения. Передавайте его в sizeValueId ячейки таблицы.

Example
{
  "sizeValueId": 0,
  "sizeValue": "example"
}

SizeChartInfoDTO

Размерная сетка или обмер, которые можно использовать как колонку таблицы размеров.

Name

Description

columnType

Type: SizeTableColumnType

Тип колонки таблицы размеров:

  • SIZE_CHART — размерная сетка, по которой определяется размер товара.
  • MEASUREMENT — обмер, например обхват груди или длина стопы. В определении размера товара не участвует.

Enum: SIZE_CHART, MEASUREMENT

required

Type: boolean

Обязательная ли размерная сетка. В таблице должна быть хотя бы одна обязательная сетка, а каждую обязательную сетку в таблице нужно заполнить во всех строках. У обмеров всегда false.

sizeChartId

Type: integer

Идентификатор размерной сетки или обмера. Передавайте его в sizeChartId ячейки таблицы.

sizeChartName

Type: string

Название размерной сетки или обмера.

Example: example

sizeValues

Type: SizeChartValueDTO[]

Справочник значений размерной сетки. Заполнен только у стандартных размерных сеток Маркета: в ячейке такой колонки передавайте значение из справочника.

Если список пустой, значение задается текстом.

Example
[
  {
    "sizeValueId": 0,
    "sizeValue": "example"
  }
]
Example
{
  "sizeChartId": 0,
  "sizeChartName": "example",
  "columnType": "SIZE_CHART",
  "required": true,
  "sizeValues": [
    {
      "sizeValueId": 0,
      "sizeValue": "example"
    }
  ]
}

GetSizeChartsResultDTO

Размерные сетки и обмеры размерной характеристики.

Name

Description

sizeCharts

Type: SizeChartInfoDTO[]

Размерные сетки и обмеры, которые можно использовать в таблицах размеров: сначала сетки, затем обмеры.

Example
[
  {
    "sizeChartId": 0,
    "sizeChartName": "example",
    "columnType": "SIZE_CHART",
    "required": true,
    "sizeValues": [
      {
        "sizeValueId": 0,
        "sizeValue": "example"
      }
    ]
  }
]

sizeParameterId

Type: integer

Идентификатор размерной характеристики из запроса.

Example
{
  "sizeParameterId": 0,
  "sizeCharts": [
    {
      "sizeChartId": 0,
      "sizeChartName": "example",
      "columnType": "SIZE_CHART",
      "required": true,
      "sizeValues": [
        {
          "sizeValueId": 0,
          "sizeValue": "example"
        }
      ]
    }
  ]
}

400 Bad Request

Запрос содержит неправильные данные. Подробнее об ошибке

Коды ошибок:

  • BAD_REQUEST — запрос не соответствует описанию метода.
  • UNKNOWN_SIZE_PARAMETER — sizeParameterId не из списка допустимых значений.

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type
  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

    Example
    {
      "status": "OK",
      "errors": [
        {
          "code": "example",
          "message": "example"
        }
      ]
    }
    

ApiErrorDTO

Общий формат ошибки.

Name

Description

code

Type: string

Код ошибки.

Example: example

message

Type: string

Описание ошибки.

Example: example

Example
{
  "code": "example",
  "message": "example"
}

ApiErrorResponse

Стандартная обертка для ошибок сервера.

Type: object

All of 2 types
  • Type: ApiResponse

    Стандартная обертка для ответов сервера.

    Example
    {
      "status": "OK"
    }
    
  • Type: object

    errors

    Type: ApiErrorDTO[] | null

    Список ошибок.

    Min items: 1

    Example
    [
      {
        "code": "example",
        "message": "example"
      }
    ]
    
    Example
    {
      "errors": [
        {
          "code": "example",
          "message": "example"
        }
      ]
    }
    
Example
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

401 Unauthorized

В запросе не указаны данные для авторизации. Подробнее об ошибке

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type
  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

    Example
    {
      "status": "OK",
      "errors": [
        {
          "code": "example",
          "message": "example"
        }
      ]
    }
    

403 Forbidden

Данные для авторизации неверны или доступ к ресурсу запрещен. Подробнее об ошибке

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type
  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

    Example
    {
      "status": "OK",
      "errors": [
        {
          "code": "example",
          "message": "example"
        }
      ]
    }
    

404 Not Found

Запрашиваемый ресурс не найден. Подробнее об ошибке

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type
  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

    Example
    {
      "status": "OK",
      "errors": [
        {
          "code": "example",
          "message": "example"
        }
      ]
    }
    

420 Method Failure

Превышено ограничение на доступ к ресурсу. Подробнее об ошибке

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type
  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

    Example
    {
      "status": "OK",
      "errors": [
        {
          "code": "example",
          "message": "example"
        }
      ]
    }
    

500 Internal Server Error

Внутренняя ошибка Маркета. Подробнее об ошибке

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type
  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

    Example
    {
      "status": "OK",
      "errors": [
        {
          "code": "example",
          "message": "example"
        }
      ]
    }