Получение информации о заполненности карточек магазина

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

marketSku

Type: MarketSku

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

Идентификатор карточки товара на Маркете.

Min value: 1

Example: 1

parameterId

Type: integer

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

Min value: 1

unitId

Type: integer

Идентификатор единицы измерения. Если вы не передали параметр unitId, используется единица измерения по умолчанию.

value

Type: string

Значение.

Для характеристик типа ENUM передавайте:

• вместе с valueId, если значение берете из справочника;
• без valueId, если значение собственное.

Example: example

valueId

Type: integer

Идентификатор значения.

• Обязательно указывайте идентификатор, если передаете значение из перечня допустимых значений, полученного от Маркета.
• Не указывайте для собственных значений.
• Только для характеристик типа ENUM.

type

Type: OfferCardRecommendationType

Рекомендация.

Рекомендация по дополнению или замене контента. Не возвращается для карточек, которые заполнены Маркетом или содержат бывшие в употреблении товары.

Часть рекомендаций относятся к основным параметрам, которые есть у товаров любых категорий. Другие — к тем характеристикам, которые есть у товара потому, что он относится к определенной категории.

1. Рекомендации, относящиеся к основным параметрам

Каждая такая рекомендация относится к единственному параметру. Чтобы заполнить этот параметр, пользуйтесь запросом POST v2/businesses/{businessId}/offer-mappings/update.

Рекомендации по заполнению параметров в updateOfferMappings:

• RECOGNIZED_VENDOR — напишите название производителя так, как его пишет сам производитель (параметр vendor).

• PICTURE_COUNT — добавьте изображения (параметр pictures). Требования

  Для рекомендации приходит процент ее выполнения.

• FIRST_PICTURE_SIZE— замените первое изображение более крупным (параметр pictures). Требования

• TITLE_LENGTH — измените название (параметр name). Составьте название по схеме: тип + бренд или производитель + модель + особенности, если есть (размер, вес, цвет). Требования

• DESCRIPTION_LENGTH — добавьте описание рекомендуемого размера (параметр description). Требования

• AVERAGE_PICTURE_SIZE — замените все изображения на изображения высокого качества (параметр pictures). Требования

• FIRST_VIDEO_LENGTH — добавьте первое видео рекомендуемой длины (параметр videos). Требования

• FIRST_VIDEO_SIZE — замените первое видео на видео высокого качества (параметр videos). Требования

• AVERAGE_VIDEO_SIZE — замените все видео на видео высокого качества (параметр videos). Требования

• VIDEO_COUNT — добавьте хотя бы одно видео (параметр videos). Требования

  Для рекомендации приходит процент ее выполнения.

2. Рекомендации, относящиеся к характеристикам по категориям

Каждая такая рекомендация предполагает заполнение одной или нескольких характеристик. Чтобы узнать, какие именно характеристики нужно заполнить, воспользуйтесь запросом POST v2/category/{categoryId}/parameters. Например, если вы получили рекомендацию MAIN, нужно заполнить характеристики, имеющие MAIN в массиве recommendationTypes.

Рекомендации:

• MAIN — заполните ключевые характеристики товара, которые используются в поиске и фильтрах.

  Для рекомендации приходит процент ее выполнения.

• ADDITIONAL — заполните дополнительные характеристики товара.

  Для рекомендации приходит процент ее выполнения.

• DISTINCTIVE — заполните характеристики, которыми отличаются друг от друга варианты товара.

  Для рекомендации приходит процент ее выполнения.

3. Устаревшие рекомендации

• HAS_VIDEO.
• FILTERABLE.
• HAS_DESCRIPTION.
• HAS_BARCODE.

Enum: HAS_VIDEO, RECOGNIZED_VENDOR, MAIN, ADDITIONAL, DISTINCTIVE, FILTERABLE, PICTURE_COUNT, HAS_DESCRIPTION, HAS_BARCODE, FIRST_PICTURE_SIZE, TITLE_LENGTH, DESCRIPTION_LENGTH, AVERAGE_PICTURE_SIZE, FIRST_VIDEO_SIZE, FIRST_VIDEO_LENGTH, AVERAGE_VIDEO_SIZE, VIDEO_COUNT

percent

Type: integer

Процент выполнения рекомендации.

Указывается для рекомендаций некоторых типов:

• PICTURE_COUNT.
• VIDEO_COUNT.
• MAIN.
• ADDITIONAL.
• DISTINCTIVE.

Min value: 0

Max value: 100

Exclusive max: true

remainingRatingPoints

Type: integer

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

Min value: 1

Max value: 100

comment

Type: string

Пояснение.

Example: example

message

Type: string

Тип ошибки.

Example: example

offerId

Type: ShopSku

Ваш SKU — идентификатор товара в вашей системе.

Правила использования SKU:

• У каждого товара SKU должен быть свой.

• Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

SKU товара можно изменить в кабинете продавца на Маркете. О том, как это сделать, читайте в Справке Маркета для продавцов.

Что такое SKU и как его назначать

Min length: 1

Max length: 255

Pattern: ^(?=.*\S.*)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$

Example: example

averageContentRating

Type: integer

Средний рейтинг карточки у товаров той категории, которая указана в marketCategoryId.

Возвращается, только если параметр withRecommendations имеет значение true.

cardStatus

Type: OfferCardStatusType

Статус карточки.

Статус карточки товара:

• HAS_CARD_CAN_NOT_UPDATE — Карточка Маркета.
• HAS_CARD_CAN_UPDATE — Можно дополнить.
• HAS_CARD_CAN_UPDATE_ERRORS — Изменения не приняты.
• HAS_CARD_CAN_UPDATE_PROCESSING — Изменения на проверке.
• NO_CARD_NEED_CONTENT — Создайте карточку.
• NO_CARD_MARKET_WILL_CREATE — Создаст Маркет.
• NO_CARD_ERRORS — Не создана из-за ошибки.
• NO_CARD_PROCESSING — Проверяем данные.
• NO_CARD_ADD_TO_CAMPAIGN — Разместите товар в магазине.

Enum: HAS_CARD_CAN_NOT_UPDATE, HAS_CARD_CAN_UPDATE, HAS_CARD_CAN_UPDATE_ERRORS, HAS_CARD_CAN_UPDATE_PROCESSING, NO_CARD_NEED_CONTENT, NO_CARD_MARKET_WILL_CREATE, NO_CARD_ERRORS, NO_CARD_PROCESSING, NO_CARD_ADD_TO_CAMPAIGN

contentRating

Type: integer

Рейтинг карточки.

contentRatingStatus

Type: OfferCardContentStatusType

Статус вычисления рейтинга карточки и рекомендаций.

Статус вычисления рейтинга карточки товара и рекомендаций:

• UPDATING — рейтинг обновляется.
• ACTUAL — рейтинг актуальный.

Enum: UPDATING, ACTUAL

errors

Type: OfferErrorDTO[] | null

Ошибки в контенте, препятствующие размещению товара на витрине.

Min items: 1

[
  {
    "message": "example",
    "comment": "example"
  }
]

groupId

Type: string

Идентификатор группы товаров.

У товаров, которые объединены в одну группу, будет одинаковый идентификатор.

Как объединить товары на карточке

Example: example

mapping

Type: GetMappingDTO

Основная информация о карточке товара.

Информация о товарах в каталоге.

{
  "marketSku": 1,
  "marketSkuName": "example",
  "marketModelId": 0,
  "marketModelName": "example",
  "marketCategoryId": 0,
  "marketCategoryName": "example"
}

parameterValues

Type: ParameterValueDTO[] | null

Список характеристик с их значениями.

Min items: 1

[
  {
    "parameterId": 1,
    "unitId": 0,
    "valueId": 0,
    "value": "example"
  }
]

recommendations

Type: OfferCardRecommendationDTO[] | null

Список рекомендаций к заполнению карточки.

Возвращается, только если параметр withRecommendations имеет значение true.

Рекомендации Маркета помогают заполнять карточку так, чтобы покупателям было проще найти ваш товар и решиться на покупку.

Min items: 1

[
  {
    "type": "HAS_VIDEO",
    "percent": 0,
    "remainingRatingPoints": 1
  }
]

warnings

Type: OfferErrorDTO[] | null

Связанные с контентом предупреждения, не препятствующие размещению товара на витрине.

Min items: 1

[
  {
    "message": "example",
    "comment": "example"
  }
]

nextPageToken

Type: string

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

Example: example

offerCards

Type: OfferCardDTO[]

Страница списка товаров с информацией о состоянии карточек.

[
  {
    "offerId": "example",
    "mapping": {
      "marketSku": 1,
      "marketSkuName": "example",
      "marketModelId": 0,
      "marketModelName": "example",
      "marketCategoryId": 0,
      "marketCategoryName": "example"
    },
    "parameterValues": [
      {
        "parameterId": 1,
        "unitId": 0,
        "valueId": 0,
        "value": "example"
      }
    ],
    "cardStatus": "HAS_CARD_CAN_NOT_UPDATE",
    "contentRating": 0,
    "averageContentRating": 0,
    "contentRatingStatus": "UPDATING",
    "recommendations": [
      {
        "type": "HAS_VIDEO",
        "percent": 0,
        "remainingRatingPoints": 1
      }
    ],
    "groupId": "example",
    "errors": [
      {
        "message": "example",
        "comment": "example"
      }
    ],
    "warnings": [
      null
    ]
  }
]

paging

Type: ForwardScrollingPagerDTO

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

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

{
  "nextPageToken": "example"
}

code

Type: string

Код ошибки.

Example: example

message

Type: string

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

Example: example