Списки характеристик товаров по категориям

Body

{
  "status": "OK",
  "result": {
    "categoryId": 0,
    "parameters": [
      {
        "id": 1,
        "name": "example",
        "type": "TEXT",
        "unit": {},
        "description": "example",
        "recommendationTypes": [
          null
        ],
        "required": true,
        "filtering": true,
        "distinctive": true,
        "multivalue": true,
        "allowCustomValues": true,
        "values": [
          null
        ],
        "constraints": {},
        "valueRestrictions": [
          null
        ]
      }
    ]
  }
}

Type: object

ApiResponseStatusType

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

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

Type: string

Enum: OK, ERROR

ApiResponse

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

{
  "status": "OK"
}

CategoryId

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

При изменении категории убедитесь, что характеристики товара и их значения в параметре parameterValues вы передаете для новой категории.

Список категорий Маркета можно получить с помощью запроса POST v2/categories/tree.

Type: integer

Min value: 0

Exclusive min: true

ParameterType

Тип данных:

• TEXT — текст.
• ENUM — список возможных значений.
• BOOLEAN — true или false.
• NUMERIC — число.

Type: string

Enum: TEXT, ENUM, BOOLEAN, NUMERIC

UnitDTO

Единица измерения.

{
  "id": 0,
  "name": "кг",
  "fullName": "килограмм"
}

CategoryParameterUnitDTO

Единицы измерения характеристики товара.

[
  {
    "id": 0,
    "name": "кг",
    "fullName": "килограмм"
  }
]

{
  "defaultUnitId": 0,
  "units": [
    {
      "id": 0,
      "name": "кг",
      "fullName": "килограмм"
    }
  ]
}

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.

Type: string

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

ParameterValueOptionDTO

Значение характеристики.

{
  "id": 0,
  "value": "example",
  "description": "example"
}

ParameterValueConstraintsDTO

Ограничения на значения характеристик.

{
  "minValue": 0.5,
  "maxValue": 0.5,
  "maxLength": 0
}

OptionValuesLimitedDTO

Значение ограничивающей характеристики и список допустимых значений ограничиваемой характеристики.

[
  1
]

{
  "limitingOptionValueId": 0,
  "optionValueIds": [
    1
  ]
}

ValueRestrictionDTO

Ограничение на возможные значения, накладываемое другой характеристикой.

Если ограничивающая характеристика принимает определенное значение, список возможных значений ограничиваемой характеристики сокращается.

Пример

Характеристика размер сама по себе может принимать девять разных значений: S, M, L, 44, 46, 48, 42/164, 46/176, 44S.

Если ограничивающая характеристика размерная сетка принимает значение RU, список возможных значений размера сокращается до 44, 46, 48.

[
  {
    "limitingOptionValueId": 0,
    "optionValueIds": [
      1
    ]
  }
]

{
  "limitingParameterId": 1,
  "limitedValues": [
    {
      "limitingOptionValueId": 0,
      "optionValueIds": [
        1
      ]
    }
  ]
}

CategoryParameterDTO

Характеристика товара.

{
  "minValue": 0.5,
  "maxValue": 0.5,
  "maxLength": 0
}

[
  "HAS_VIDEO"
]

{
  "defaultUnitId": 0,
  "units": [
    {
      "id": 0,
      "name": "кг",
      "fullName": "килограмм"
    }
  ]
}

[
  {
    "limitingParameterId": 1,
    "limitedValues": [
      {
        "limitingOptionValueId": 0,
        "optionValueIds": [
          1
        ]
      }
    ]
  }
]

[
  {
    "id": 0,
    "value": "example",
    "description": "example"
  }
]

{
  "id": 1,
  "name": "example",
  "type": "TEXT",
  "unit": {
    "defaultUnitId": 0,
    "units": [
      {
        "id": 0,
        "name": "кг",
        "fullName": "килограмм"
      }
    ]
  },
  "description": "example",
  "recommendationTypes": [
    "HAS_VIDEO"
  ],
  "required": true,
  "filtering": true,
  "distinctive": true,
  "multivalue": true,
  "allowCustomValues": true,
  "values": [
    {
      "id": 0,
      "value": "example",
      "description": "example"
    }
  ],
  "constraints": {
    "minValue": 0.5,
    "maxValue": 0.5,
    "maxLength": 0
  },
  "valueRestrictions": [
    {
      "limitingParameterId": 1,
      "limitedValues": [
        {
          "limitingOptionValueId": 0,
          "optionValueIds": [
            null
          ]
        }
      ]
    }
  ]
}

CategoryContentParametersDTO

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

[
  {
    "id": 1,
    "name": "example",
    "type": "TEXT",
    "unit": {
      "defaultUnitId": 0,
      "units": [
        {
          "id": 0,
          "name": "кг",
          "fullName": "килограмм"
        }
      ]
    },
    "description": "example",
    "recommendationTypes": [
      "HAS_VIDEO"
    ],
    "required": true,
    "filtering": true,
    "distinctive": true,
    "multivalue": true,
    "allowCustomValues": true,
    "values": [
      {
        "id": 0,
        "value": "example",
        "description": "example"
      }
    ],
    "constraints": {
      "minValue": 0.5,
      "maxValue": 0.5,
      "maxLength": 0
    },
    "valueRestrictions": [
      {
        "limitingParameterId": 1,
        "limitedValues": [
          {}
        ]
      }
    ]
  }
]

{
  "categoryId": 0,
  "parameters": [
    {
      "id": 1,
      "name": "example",
      "type": "TEXT",
      "unit": {
        "defaultUnitId": 0,
        "units": [
          {}
        ]
      },
      "description": "example",
      "recommendationTypes": [
        "HAS_VIDEO"
      ],
      "required": true,
      "filtering": true,
      "distinctive": true,
      "multivalue": true,
      "allowCustomValues": true,
      "values": [
        {
          "id": 0,
          "value": "example",
          "description": "example"
        }
      ],
      "constraints": {
        "minValue": 0.5,
        "maxValue": 0.5,
        "maxLength": 0
      },
      "valueRestrictions": [
        {
          "limitingParameterId": 1,
          "limitedValues": [
            null
          ]
        }
      ]
    }
  ]
}

Body

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

Type: object

ApiErrorDTO

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

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

ApiErrorResponse

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

Type: object

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

Body

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

Type: object

Body

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

Type: object

Body

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

Type: object

Body

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

Type: object

Body

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

Type: object