按类别列出的产品特性

方法适用于模式：FBY, FBS, 快递和DBS.

如果您使用API-Key令牌，调用该方法时需要具备列表中可用权限之一

返回给定值可接受的特征列表 叶类.

**⚙️ 限制：**每分钟100个类别

Request

POST

https://api.partner.market.yandex.ru/v2/category/{categoryId}/parameters

Path parameters

Name

Description

categoryId*

Type: integer<int64>

市场上的类别的ID。

要找出您感兴趣的产品所属类别的ID，请使用请求 :no-translate[POST v2/categories/tree].

Min value (exclusive): 0

Query parameters

Name

Description

businessId

Type: integer<int64>

内阁ID。 要找到答案，请使用请求 :no-translate[GET v2/campaigns].

传递参数以获得作为此机柜中产品变型的特征的特征。

Min value: 1

Responses

200 OK

指定类别的产品特性列表。

Body

application/json
{
    "status": "OK",
    "result": {
        "categoryId": 0,
        "parameters": [
            {
                "id": 0,
                "name": "string",
                "type": "TEXT",
                "unit": {
                    "defaultUnitId": 0,
                    "units": [
                        {
                            "id": 0,
                            "name": "кг",
                            "fullName": "килограмм"
                        }
                    ]
                },
                "description": "string",
                "recommendationTypes": [
                    "HAS_VIDEO"
                ],
                "required": false,
                "filtering": false,
                "distinctive": false,
                "multivalue": false,
                "allowCustomValues": false,
                "values": [
                    {
                        "id": 0,
                        "value": "string",
                        "description": "string"
                    }
                ],
                "constraints": {
                    "minValue": 0,
                    "maxValue": 0,
                    "maxLength": 0
                },
                "valueRestrictions": [
                    {
                        "limitingParameterId": 0,
                        "limitedValues": [
                            {
                                "limitingOptionValueId": 0,
                                "optionValueIds": [
                                    0
                                ]
                            }
                        ]
                    }
                ]
            }
        ]
    }
}

Name

Description

status*

Type: ApiResponseStatusType

响应的类型。 可能的值:

  • OK -没有错误。
  • ERROR -处理请求时发生错误。

Enum: OK, ERROR

result

Type: CategoryContentParametersDTO

类别参数的信息。

ApiResponseStatusType

响应的类型。 可能的值:

  • OK -没有错误。
  • ERROR -处理请求时发生错误。

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

CategoryContentParametersDTO

类别参数的信息。

Name

Description

categoryId*

Type: integer<int32>

市场上的类别的ID。

更改类别时，请确保参数中的产品特性及其值 parameterValues 您正在提交一个新的类别.

您可以使用请求获取市场类别列表。 POST v2/categories/tree.

Min value (exclusive): 0

parameters

Type: CategoryParameterDTO[]

征的列表。
产品特性。

Min items: 1

CategoryParameterDTO

产品特性。

Name

Description

allowCustomValues*

Type: boolean

是否可以传递不在市场期权列表中的自定义值？ 仅针对类型特征 ENUM.

distinctive*

Type: boolean

征是否为变体的特征。

filtering*

Type: boolean

特性是否用于滤波器中。

id*

Type: integer<int64>

特性的标识符。

Min value: 1

multivalue*

Type: boolean

是否可以一次传递多个值？

required*

Type: boolean

强制性特征。

type*

Type: ParameterType

Тип данных.

Enum: TEXT, ENUM, BOOLEAN, NUMERIC

constraints

Type: ParameterValueConstraintsDTO

Ограничения на значения. Только для характеристик типа TEXT и NUMERIC.

description

Type: string

特性的描述。

name

Type: string

特性的名称。

recommendationTypes

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

Min items: 1

Unique items  

unit

Type: CategoryParameterUnitDTO

品特性的测量单位。

valueRestrictions

Type: ValueRestrictionDTO[]

其他特性强加的值的限制。 仅针对类型特征 ENUM.
对另一个特性施加的可能值的限制。

如果限制特性具有一定的值，则限制特性的可能值的列表被减少。

例子：

特征大小本身可以取九个不同的值。: S, M, L, 44, 46, 48, :无翻译[42/164], :无翻译[46/176], 44S.

如果限制特性维度网格取值 RU，可能的大小值列表减少到 44, 46, 48.

Min items: 1

values

Type: ParameterValueOptionDTO[]

可接受的参数值的列表。 仅针对类型特征 ENUM.
特性的值。

Min items: 1

ParameterType

数据类型:

  • TEXT -文本。
  • ENUM -可能值的列表。
  • BOOLEAN — true 或 false.
  • NUMERIC -号码。

Type

Description

ParameterType

Enum: TEXT, ENUM, BOOLEAN, NUMERIC

ParameterValueConstraintsDTO

特性的值的限制。

Name

Description

maxLength

Type: integer<int32>

文本的最大长度。

maxValue

Type: number<double>

的最大数量。

minValue

Type: number<double>

的最小数量。

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

Description

OfferCardRecommendationType

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

CategoryParameterUnitDTO

品特性的测量单位。

Name

Description

defaultUnitId*

Type: integer<int64>

默认的测量单位。

units*

Type: UnitDTO[]

可接受的计量单位。
计量单位。

ValueRestrictionDTO

对另一个特性施加的可能值的限制。

如果限制特性具有一定的值，则限制特性的可能值的列表被减少。

例子：

特征大小本身可以取九个不同的值。: S, M, L, 44, 46, 48, :无翻译[42/164], :无翻译[46/176], 44S.

如果限制特性维度网格取值 RU，可能的大小值列表减少到 44, 46, 48.

Name

Description

limitedValues*

Type: OptionValuesLimitedDTO[]

限特性的值和当前特性的相应允许值。
述限制特性的值和所述限制特性的可接受值的列表。

limitingParameterId*

Type: integer<int64>

限制特性的ID。

Min value: 1

ParameterValueOptionDTO

特性的值。

Name

Description

id*

Type: integer<int64>

值的ID。

value*

Type: string

意义。

description

Type: string

值的描述。

UnitDTO

计量单位。

Name

Description

fullName*

Type: string

计量单位的全称。

Example: килограмм

id*

Type: integer<int64>

测量单位的ID。

name*

Type: string

计量单位的缩写名称。

Example: кг

OptionValuesLimitedDTO

述限制特性的值和所述限制特性的可接受值的列表。

Name

Description

limitingOptionValueId*

Type: integer<int64>

限制特性的值的ID。

optionValueIds*

Type: integer<int64>[]

限制特性的可接受值的id。

Min value: 1

Unique items  

400 Bad Request

请求包含不正确的数据。 有关错误的更多信息

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

错误列表。
一般错误格式。

Min items: 1

status

Type: ApiResponseStatusType

响应的类型。 可能的值:

  • OK -没有错误。
  • ERROR -处理请求时发生错误。

Enum: OK, ERROR

ApiErrorDTO

一般错误格式。

Name

Description

code*

Type: string

的错误代码。

message

Type: string

错误的描述。

401 Unauthorized

请求中未指定授权数据。 有关错误的更多信息

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

错误列表。
一般错误格式。

Min items: 1

status

Type: ApiResponseStatusType

响应的类型。 可能的值:

  • OK -没有错误。
  • ERROR -处理请求时发生错误。

Enum: OK, ERROR

403 Forbidden

授权数据不正确或禁止访问资源。 有关错误的更多信息

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

错误列表。
一般错误格式。

Min items: 1

status

Type: ApiResponseStatusType

响应的类型。 可能的值:

  • OK -没有错误。
  • ERROR -处理请求时发生错误。

Enum: OK, ERROR

404 Not Found

找不到请求的资源。 有关错误的更多信息

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

错误列表。
一般错误格式。

Min items: 1

status

Type: ApiResponseStatusType

响应的类型。 可能的值:

  • OK -没有错误。
  • ERROR -处理请求时发生错误。

Enum: OK, ERROR

420 Method Failure

已超出资源访问限制。 有关错误的更多信息

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

错误列表。
一般错误格式。

Min items: 1

status

Type: ApiResponseStatusType

响应的类型。 可能的值:

  • OK -没有错误。
  • ERROR -处理请求时发生错误。

Enum: OK, ERROR

500 Internal Server Error

Yandex的内部错误。 市场。 有关错误的更多信息

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

错误列表。
一般错误格式。

Min items: 1

status

Type: ApiResponseStatusType

响应的类型。 可能的值:

  • OK -没有错误。
  • ERROR -处理请求时发生错误。

Enum: OK, ERROR

No longer supported, please use an alternative and newer version.

Категория, у которой нет дочерних.

上一篇
类别树
下一篇
添加产品和更改信息