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

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

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

Возвращает таблицы размеров по их идентификаторам. Идентификаторы возвращает метод подбора таблиц размеров. Если sizeTableIds не передан, возвращает все таблицы размеров, созданные бизнесом.

Сначала возвращаются созданные бизнесом, затем брендовые, затем стандартные таблицы; внутри каждой группы — по убыванию идентификатора.

Результаты возвращаются постранично. Для навигации используйте параметры pageToken и limit. В каждом следующем запросе передавайте тот же набор sizeTableIds, что и в первом: pageToken привязан к нему, и с другим набором запрос будет отклонен. Порядок идентификаторов значения не имеет.

Идентификаторы, по которым таблицу вернуть не удалось — такой таблицы нет или она принадлежит другому бизнесу, — возвращаются в notFoundSizeTableIds на первой странице.

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

Request

POST

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

Path parameters

Name

Description

businessId

Type: integer

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

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

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

Min value: 1

Query parameters

Name

Description

limit

Type: integer

Количество значений на одной странице.

Default: 25

Min value: 1

Max value: 100

pageToken

Type: string

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Передавайте значение выходного параметра nextPageToken, полученное при последнем запросе.

Example: ``

Body

application/json
{
  "sizeTableIds": [
    1
  ]
}

Name

Description

sizeTableIds

Type: integer[] | null

Идентификаторы таблиц размеров.

Если параметр не передан, возвращаются все таблицы, созданные бизнесом.

Min items: 1

Max items: 100

Unique items: true

Example
[
  1
]

Responses

200 OK

Таблицы размеров.

Body

application/json
{
  "status": "OK",
  "result": {
    "sizeTables": [
      {
        "sizeTableId": 0,
        "sizeTableName": "example",
        "sizeTableType": "CUSTOM",
        "sizeParameterId": 0,
        "editable": true,
        "key": {},
        "sizeCharts": [
          null
        ]
      }
    ],
    "notFoundSizeTableIds": [
      0
    ],
    "paging": {
      "nextPageToken": "example"
    }
  }
}

Type: object

All of 2 types
  • Type: ApiResponse

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

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

    result

    Type: GetSizeTablesResultDTO

    Таблицы размеров.

    Example
    {
      "sizeTables": [
        {
          "sizeTableId": 0,
          "sizeTableName": "example",
          "sizeTableType": "CUSTOM",
          "sizeParameterId": 0,
          "editable": true,
          "key": {
            "categoryId": 0,
            "vendorId": 0,
            "genderId": 0
          },
          "sizeCharts": [
            {
              "sizeChartId": 0,
              "sizeChartName": "example",
              "columnType": "SIZE_CHART",
              "sizes": [
                null
              ]
            }
          ]
        }
      ],
      "notFoundSizeTableIds": [
        0
      ],
      "paging": {
        "nextPageToken": "example"
      }
    }
    
    Example
    {
      "result": {
        "sizeTables": [
          {
            "sizeTableId": 0,
            "sizeTableName": "example",
            "sizeTableType": "CUSTOM",
            "sizeParameterId": 0,
            "editable": true,
            "key": {
              "categoryId": 0,
              "vendorId": 0,
              "genderId": 0
            },
            "sizeCharts": [
              {}
            ]
          }
        ],
        "notFoundSizeTableIds": [
          0
        ],
        "paging": {
          "nextPageToken": "example"
        }
      }
    }
    

ApiResponseStatusType

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

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

Type: string

Enum: OK, ERROR

ApiResponse

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

Name

Description

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

Example
{
  "status": "OK"
}

SizeTableType

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

  • CUSTOM — таблица, созданная бизнесом.
  • STANDARD — таблица Маркета: стандартная или подобранная под бренд.

Type: string

Enum: CUSTOM, STANDARD

SizeTableKeyDTO

Условия, по которым подобрана таблица.

Name

Description

categoryId

Type: integer

Идентификатор категории из запроса.

genderId

Type: integer

Идентификатор пола на Маркете.

vendorId

Type: integer

Идентификатор бренда на Маркете. Возвращается только для таблиц бренда.

Example
{
  "categoryId": 0,
  "vendorId": 0,
  "genderId": 0
}

SizeTableColumnType

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

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

Type: string

Enum: SIZE_CHART, MEASUREMENT

SizeValueDTO

Значение в ячейке таблицы размеров.

Name

Description

rowIndex

Type: integer

Номер строки таблицы, начиная с 0. Значения с одинаковым rowIndex в разных колонках описывают один размер.

Номера могут идти с пропусками, а порядок строк может не совпадать с порядком размеров. Собирайте строки по значению rowIndex, а не по позиции значения в sizes.

Min value: 0

sizeValue

Type: string

Значение размера или обмера.

Example: example

sizeValueId

Type: integer

Идентификатор значения размера. Возвращается, только если у колонки есть справочник значений — это стандартные размерные сетки Маркета.

В сетках, созданных бизнесом, брендовых сетках и обмерах значение задается только текстом.

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

SizeChartDTO

Колонка таблицы размеров — размерная сетка или обмер.

Name

Description

columnType

Type: SizeTableColumnType

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

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

Enum: SIZE_CHART, MEASUREMENT

sizeChartId

Type: integer

Идентификатор размерной сетки или обмера. У сеток и обмеров общее пространство идентификаторов.

sizeChartName

Type: string

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

Example: example

sizes

Type: SizeValueDTO[]

Значения колонки в порядке строк таблицы. Пустые ячейки не возвращаются.

Example
[
  {
    "sizeValueId": 0,
    "sizeValue": "example",
    "rowIndex": 0
  }
]
Example
{
  "sizeChartId": 0,
  "sizeChartName": "example",
  "columnType": "SIZE_CHART",
  "sizes": [
    {
      "sizeValueId": 0,
      "sizeValue": "example",
      "rowIndex": 0
    }
  ]
}

SizeTableDTO

Таблица размеров.

Name

Description

editable

Type: boolean

Может ли бизнес редактировать таблицу: true — для таблиц, созданных бизнесом, false — для таблиц Маркета.

sizeCharts

Type: SizeChartDTO[]

Колонки таблицы: размерные сетки и обмеры. Колонки без значений не возвращаются.

Example
[
  {
    "sizeChartId": 0,
    "sizeChartName": "example",
    "columnType": "SIZE_CHART",
    "sizes": [
      {
        "sizeValueId": 0,
        "sizeValue": "example",
        "rowIndex": 0
      }
    ]
  }
]

sizeParameterId

Type: integer

Идентификатор размерной характеристики, к которой относятся размеры из таблицы.

sizeTableId

Type: integer

Идентификатор таблицы размеров.

sizeTableName

Type: string

Название таблицы размеров.

Example: example

sizeTableType

Type: SizeTableType

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

  • CUSTOM — таблица, созданная бизнесом.
  • STANDARD — таблица Маркета: стандартная или подобранная под бренд.

Enum: CUSTOM, STANDARD

key

Type: SizeTableKeyDTO

Условия подбора таблицы. Возвращаются, только если таблица подобрана по категории.

Условия, по которым подобрана таблица.

Example
{
  "categoryId": 0,
  "vendorId": 0,
  "genderId": 0
}
Example
{
  "sizeTableId": 0,
  "sizeTableName": "example",
  "sizeTableType": "CUSTOM",
  "sizeParameterId": 0,
  "editable": true,
  "key": {
    "categoryId": 0,
    "vendorId": 0,
    "genderId": 0
  },
  "sizeCharts": [
    {
      "sizeChartId": 0,
      "sizeChartName": "example",
      "columnType": "SIZE_CHART",
      "sizes": [
        {
          "sizeValueId": 0,
          "sizeValue": "example",
          "rowIndex": 0
        }
      ]
    }
  ]
}

PackagingForwardScrollingPagerDTO

Идентификатор следующей страницы.

Name

Description

nextPageToken

Type: string

Идентификатор следующей страницы результатов.

Example: example

Example
{
  "nextPageToken": "example"
}

GetSizeTablesResultDTO

Таблицы размеров.

Name

Description

notFoundSizeTableIds

Type: integer[]

Идентификаторы из запроса, по которым таблицу вернуть не удалось: такой таблицы нет или она принадлежит другому бизнесу.

Заполняется только на первой странице. На следующих страницах и в запросе без sizeTableIds список пустой.

Unique items: true

Example
[
  0
]

paging

Type: PackagingForwardScrollingPagerDTO

Идентификатор следующей страницы.

Example
{
  "nextPageToken": "example"
}

sizeTables

Type: SizeTableDTO[]

Таблицы размеров: сначала созданные бизнесом, затем брендовые, затем стандартные; внутри каждой группы — по убыванию идентификатора.

Example
[
  {
    "sizeTableId": 0,
    "sizeTableName": "example",
    "sizeTableType": "CUSTOM",
    "sizeParameterId": 0,
    "editable": true,
    "key": {
      "categoryId": 0,
      "vendorId": 0,
      "genderId": 0
    },
    "sizeCharts": [
      {
        "sizeChartId": 0,
        "sizeChartName": "example",
        "columnType": "SIZE_CHART",
        "sizes": [
          {}
        ]
      }
    ]
  }
]
Example
{
  "sizeTables": [
    {
      "sizeTableId": 0,
      "sizeTableName": "example",
      "sizeTableType": "CUSTOM",
      "sizeParameterId": 0,
      "editable": true,
      "key": {
        "categoryId": 0,
        "vendorId": 0,
        "genderId": 0
      },
      "sizeCharts": [
        {
          "sizeChartId": 0,
          "sizeChartName": "example",
          "columnType": "SIZE_CHART",
          "sizes": [
            null
          ]
        }
      ]
    }
  ],
  "notFoundSizeTableIds": [
    0
  ],
  "paging": {
    "nextPageToken": "example"
  }
}

400 Bad Request

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

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"
        }
      ]
    }