Создание таблиц размеров
Метод доступен для всех моделей.
Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке
- offers-and-cards-management — Управление товарами и карточками
- all-methods — Полное управление кабинетом
Создает таблицы размеров бизнеса. За один запрос можно создать до 10 таблиц, в которых суммарно не больше
5000 ячеек. Если таблиц или ячеек больше, запрос отклоняется с ошибкой BAD_REQUEST и ни одна таблица
не создается.
Таблица относится к размерной характеристике, а не к категории: она подбирается для всех категорий с той же размерной характеристикой.
Размерную характеристику категории возвращает метод подбора таблиц размеров
POST v2/businesses/{businessId}/size-tables/suggest в поле result.sizeParameterId, характеристику
существующей таблицы — метод POST v2/businesses/{businessId}/size-tables в поле sizeParameterId.
Если в запросе есть неизвестный идентификатор размерной характеристики, запрос отклоняется с ошибкой
UNKNOWN_SIZE_PARAMETER и ни одна таблица не создается.
Размерные сетки и обмеры, которые можно использовать в таблице, их значения и обязательные сетки
возвращает метод POST v2/businesses/{businessId}/size-tables/charts.
Как заполнить таблицу
Каждый элемент rows — строка таблицы: один размер во всех размерных сетках и обмерах. В values
передайте по одной ячейке на колонку: идентификатор сетки или обмера в sizeChartId или название
в sizeChartName и значение в sizeValueId, sizeValue или в обоих полях. Ячейку без значения можно не передавать или передать
с пустым sizeValue — она сохранится как «нет значения».
Требования к таблице:
- В таблице должна быть хотя бы одна обязательная размерная сетка (
required: true), иначе вернется ошибкаABSENT_MANDATORY_SIZE_CHART. Обмеры и сетки сrequired: falseэто требование не выполняют. - Каждую обязательную сетку, которая есть в таблице, заполните во всех строках, иначе вернется ошибка
EMPTY_CELL. - В каждой колонке должно быть хотя бы одно значение, кроме пустого и «нет значения», иначе вернется ошибка
NONE_COLUMN. Если заполнить колонку нечем, не передавайте ее ячейки. - Строки не должны совпадать, иначе вернется ошибка
DUPLICATE_ROWS. Допустимы ли повторы значений в колонке (DUPLICATE_SIZES,DUPLICATE_MEASURES), зависит от размерной характеристики.
Чем сохраненная таблица отличается от переданной
Метод POST v2/businesses/{businessId}/size-tables возвращает таблицу по колонкам: у каждого значения
есть номер строки rowIndex. Чтобы получить строки, сгруппируйте значения по rowIndex.
Сохраненная таблица может отличаться от переданной:
- строки и колонки идут в порядке, который задает Маркет, а
rowIndexне совпадает с номером строки в запросе; - в стандартных размерных сетках возвращаются текст значения из справочника и его
sizeValueId; - в обмерах запятые заменены точками:
42,5→42.5; - ячейки «нет значения» и непереданные ячейки не возвращаются;
- пробелы в начале и в конце названия и значений удалены.
Значения из ответа можно без изменений передать в метод обновления таблиц размеров
POST v2/businesses/{businessId}/size-tables/update: поля columnType и rowIndex в нем не учитываются.
Чтобы привязать таблицу к товару, передайте ее идентификатор в value характеристики с parameterId: 73979829
в запросе POST v2/businesses/{businessId}/offer-cards/update.
Когда таблица изменяется, новое содержимое применяется к привязанным товарам автоматически.
Повторный запрос создает таблицы еще раз
Метод не идемпотентен: каждый запрос создает новые таблицы, даже если такие же уже есть.
Если запрос завершился ошибкой с кодом 5xx, часть таблиц могла сохраниться. Получите таблицы бизнеса методом
POST v2/businesses/{businessId}/size-tables и только после этого повторите запрос для таблиц, которых там нет.
Количество таблиц у бизнеса ограничено — суммарно по всем размерным характеристикам. Удалить таблицу нельзя.
Если лимит исчерпан, таблица не создается и для нее возвращается ошибка LIMIT_TABLES. При одновременных
запросах лимит проверяется нестрого, и таблиц может создаться больше.
⚙️ Лимит без подписки: 5 запросов в минуту ⭐️ Лимит с подпиской Медиум: 10 запросов в минуту |
|---|
Request
POST
https://api.partner.market.yandex.ru/v2/businesses/{businessId}/size-tables/create
Path parameters
|
Name |
Description |
|
businessId |
Type: integer Идентификатор кабинета. Чтобы его узнать, воспользуйтесь запросом GET v2/campaigns. ℹ️ Что такое кабинет и магазин на Маркете Min value: |
Body
application/json
{
"sizeTables": [
{
"sizeParameterId": 1,
"sizeTableName": "example",
"rows": [
{
"values": [
null
]
}
]
}
]
}
|
Name |
Description |
|
sizeTables |
Type: CreateSizeTableDTO[] Таблицы размеров. Обрабатываются по порядку, каждая независимо от остальных. Суммарно во всех таблицах — не больше 5000 ячеек. Если ячеек больше, запрос не обрабатывается. Min items: Max items: Example
|
SizeTableCellDTO
Ячейка таблицы размеров: значение размера в размерной сетке или значение обмера.
Укажите колонку в sizeChartId, sizeChartName или в обоих полях, а значение — в sizeValueId, sizeValue
или в обоих полях. Ячейка, в которой нет ни sizeChartId, ни sizeChartName или ни sizeValueId,
ни sizeValue, — ошибка INVALID_REQUEST.
Колонка по sizeChartName ищется среди размерных сеток и обмеров размерной характеристики таблицы
из ответа метода POST v2/businesses/{businessId}/size-tables/charts: название сравнивается без учета регистра
и пробелов в начале и в конце. Если название совпадает с несколькими колонками или ни с одной, возвращается
ошибка UNKNOWN_SIZE_CHART. Переданный вместе с sizeChartId параметр sizeChartName должен совпадать
с названием этой колонки, иначе вернется ошибка INVALID_REQUEST.
Как обрабатывается значение:
- Если передан
sizeValueId, он должен быть из справочника этой размерной сетки (sizeValuesв ответе методаPOST v2/businesses/{businessId}/size-tables/charts). Сохраняется текст значения из справочника. Переданный вместе сsizeValueIdпараметрsizeValueдолжен совпадать с этим текстом без учета регистра и пробелов в начале и в конце. - Если передан только
sizeValue, из него удаляются пробелы в начале и в конце, а затем:- пустое значение сохраняется как «нет значения»;
- «нет значения» принимается в любой колонке и сохраняется как
—; - в колонке со справочником значение сравнивается со справочником без учета регистра — если совпадает ровно одно значение, сохраняется оно с текстом из справочника;
- в колонке без справочника сохраняется переданный текст не длиннее 20 символов, а в обмерах запятые
заменяются точками:
42,5→42.5.
Если значение не подходит колонке, возвращается ошибка INVALID_SIZE_VALUE.
Какие значения считаются «нет значения»
Значение целиком, без учета регистра: Нет, Пусто, Нет значения, Не соответствует, Нет подходящего,
Отсутствует, Неприменимо, Без значения или один либо несколько символов -, ‐, ‑, ‒, –, —, ―.
Знак минуса − к ним не относится.
В обязательной размерной сетке такое значение, как и пустое значение или непереданная ячейка, — ошибка EMPTY_CELL.
|
Name |
Description |
|
sizeChartId |
Type: integer Идентификатор размерной сетки или обмера из ответа метода Min value: |
|
sizeChartName |
Type: string Название размерной сетки или обмера из ответа метода Min length: Max length: Example: |
|
sizeValue |
Type: string Значение размера или обмера. В колонках без справочника — не длиннее 20 символов. Max length: Example: |
|
sizeValueId |
Type: integer Идентификатор значения из справочника размерной сетки. Справочник есть только у стандартных размерных сеток Маркета. Min value: |
Example
{
"sizeChartId": 1,
"sizeChartName": "example",
"sizeValueId": 1,
"sizeValue": "example"
}
SizeTableRowDTO
Строка таблицы размеров — один размер во всех размерных сетках и обмерах таблицы.
|
Name |
Description |
|
values |
Type: SizeTableCellDTO[] Ячейки строки в любом порядке. Каждая размерная сетка или обмер — не больше одного раза в строке,
иначе вернется ошибка Ячейку без значения можно не передавать или передать с пустым Min items: Max items: Example
|
Example
{
"values": [
{
"sizeChartId": 1,
"sizeChartName": "example",
"sizeValueId": 1,
"sizeValue": "example"
}
]
}
CreateSizeTableDTO
Новая таблица размеров.
|
Name |
Description |
|
rows |
Type: SizeTableRowDTO[] Строки таблицы: каждая описывает один размер. При сохранении порядок строк может измениться. Min items: Max items: Example
|
|
sizeParameterId |
Type: integer Идентификатор размерной характеристики, к которой относятся размеры из таблицы. Min value: |
|
sizeTableName |
Type: string Название таблицы размеров. Пробелы в начале и в конце удаляются. Название из одних пробелов —
ошибка Min length: Max length: Example: |
Example
{
"sizeParameterId": 1,
"sizeTableName": "example",
"rows": [
{
"values": [
{
"sizeChartId": 1,
"sizeChartName": "example",
"sizeValueId": 1,
"sizeValue": "example"
}
]
}
]
}
Responses
200 OK
Результаты создания таблиц в порядке запроса.
Если хотя бы одну таблицу не удалось создать, поле status принимает значение ERROR.
Остальные таблицы при этом обрабатываются и сохраняются.
Body
application/json
{
"status": "OK",
"result": {
"results": [
{
"sizeTableId": 0,
"sizeTableName": "example",
"errors": [
null
]
}
]
}
}
Type: object
All of 2 types
-
Type: ApiResponse
Стандартная обертка для ответов сервера.
Example
{ "status": "OK" } -
Type: object
result
Type: SaveSizeTablesResultDTO
Результаты сохранения таблиц размеров.
Example
{ "results": [ { "sizeTableId": 0, "sizeTableName": "example", "errors": [ { "code": "INVALID_REQUEST", "rowIndex": 0, "sizeChartId": 0, "sizeChartIds": [ null ], "sizeChartNames": [ null ], "rowIndices": [ null ] } ] } ] }Example
{ "result": { "results": [ { "sizeTableId": 0, "sizeTableName": "example", "errors": [ {} ] } ] } }
ApiResponseStatusType
Тип ответа. Возможные значения:
OK— ошибок нет.ERROR— при обработке запроса произошла ошибка.
Type: string
Enum: OK, ERROR
ApiResponse
Стандартная обертка для ответов сервера.
|
Name |
Description |
|
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
Example
{
"status": "OK"
}
SizeTableErrorCodeType
Код ошибки сохранения таблицы размеров:
INVALID_REQUEST— нарушена структура таблицы: название из одних пробелов, ячейка безsizeChartIdиsizeChartName(rowIndex), повтор колонки в строке, ячейка безsizeValueIdиsizeValueили ячейка, в которойsizeChartNameне совпадает с названием колонкиsizeChartId(rowIndex,sizeChartId).UNKNOWN_SIZE_CHART— размерных сеток или обмеров изsizeChartIdsнет среди доступных для размерной характеристики таблицы, а названиям изsizeChartNamesне нашлось ровно одной такой колонки.INVALID_SIZE_VALUE— значение не подходит колонке (rowIndex,sizeChartId).EMPTY_TABLE— в таблице нет ни одной ячейки. Для запросов, которые соответствуют схеме, не возвращается. Если в колонке только «нет значения», возвращаетсяNONE_COLUMN.EMPTY_CELL— не заполнена ячейка обязательной размерной сетки (rowIndex,sizeChartId).NONE_COLUMN— в колонках изsizeChartIdsнет ни одного значения, кроме «нет значения».DUPLICATE_ROWS— строки изrowIndicesсовпадают.DUPLICATE_SIZES— значения повторяются в размерных сетках изsizeChartIds. Зависит от размерной характеристики: для одних характеристик ошибка возвращается при повторах в любой сетке, для других — только если повторы есть во всех сетках таблицы.DUPLICATE_MEASURES— значения повторяются в обмерах изsizeChartIds. Зависит от размерной характеристики: для некоторых характеристик повторы в обмерах допускаются.ABSENT_MANDATORY_SIZE_CHART— в таблице нет обязательной размерной сетки.LIMIT_TABLES— у бизнеса уже максимальное количество таблиц. Только при создании.NOT_FOUND— таблицы нет. Только при обновлении.FORBIDDEN— это таблица Маркета (sizeTableType: STANDARD), ее нельзя изменить. Только при обновлении.CONCURRENT_MODIFICATION— таблицу изменили во время обработки запроса. Повторите запрос. Только при обновлении.INTERNAL_ERROR— внутренняя ошибка, таблица не сохранена.
Type: string
Enum: INVALID_REQUEST, UNKNOWN_SIZE_CHART, INVALID_SIZE_VALUE, EMPTY_TABLE, EMPTY_CELL, NONE_COLUMN, DUPLICATE_ROWS, DUPLICATE_SIZES, DUPLICATE_MEASURES, ABSENT_MANDATORY_SIZE_CHART, LIMIT_TABLES, NOT_FOUND, FORBIDDEN, CONCURRENT_MODIFICATION, INTERNAL_ERROR
SizeTableErrorDTO
Ошибка сохранения таблицы размеров. Место ошибки указывают поля rowIndex, sizeChartId, sizeChartIds,
sizeChartNames и rowIndices: какие из них возвращаются, зависит от кода ошибки.
|
Name |
Description |
|
code |
Type: SizeTableErrorCodeType Код ошибки сохранения таблицы размеров:
Enum: |
|
rowIndex |
Type: integer Номер строки с ошибкой в Min value: |
|
rowIndices |
Type: integer[] | null Номера совпадающих строк в Min items: Unique items: Example
|
|
sizeChartId |
Type: integer Идентификатор размерной сетки или обмера, в колонке которого ошибка. |
|
sizeChartIds |
Type: integer[] | null Идентификаторы размерных сеток и обмеров, в колонках которых ошибка. Min items: Unique items: Example
|
|
sizeChartNames |
Type: string[] | null Названия колонок из Min items: Unique items: Example
|
Example
{
"code": "INVALID_REQUEST",
"rowIndex": 0,
"sizeChartId": 0,
"sizeChartIds": [
0
],
"sizeChartNames": [
"example"
],
"rowIndices": [
0
]
}
SaveSizeTableResultDTO
Результат сохранения таблицы размеров. Если таблица сохранена, возвращаются sizeTableId и sizeTableName,
если нет — только errors.
|
Name |
Description |
|
errors |
Type: SizeTableErrorDTO[] | null Ошибки, из-за которых таблица не сохранена. Сначала проверяются структура таблицы, ее колонки и значения ячеек — ошибки Min items: Example
|
|
sizeTableId |
Type: integer Идентификатор сохраненной таблицы размеров. |
|
sizeTableName |
Type: string Название сохраненной таблицы размеров. Example: |
Example
{
"sizeTableId": 0,
"sizeTableName": "example",
"errors": [
{
"code": "INVALID_REQUEST",
"rowIndex": 0,
"sizeChartId": 0,
"sizeChartIds": [
0
],
"sizeChartNames": [
"example"
],
"rowIndices": [
0
]
}
]
}
SaveSizeTablesResultDTO
Результаты сохранения таблиц размеров.
|
Name |
Description |
|
results |
Type: SaveSizeTableResultDTO[] Результаты по таблицам из запроса в том же порядке: Example
|
Example
{
"results": [
{
"sizeTableId": 0,
"sizeTableName": "example",
"errors": [
{
"code": "INVALID_REQUEST",
"rowIndex": 0,
"sizeChartId": 0,
"sizeChartIds": [
null
],
"sizeChartNames": [
null
],
"rowIndices": [
null
]
}
]
}
]
}
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: |
|
message |
Type: string Описание ошибки. 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:
1Example
[ { "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" } ] }