按类别划分的产品特性一览表

方法适用于模式:FBY, FBS, ExpressDBS.

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

返回指定[叶类别]的具有可接受值的特征列表(*list-category).

响应中的字段定义了在方法中传输特性的规则:

⚙️ 限制: 每分钟100个类别

Request

POST

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

Path parameters

Name

Description

categoryId

Type: integer

市场上的类别的ID。

要找出您感兴趣的产品所属类别的ID,请使用请求 POST v2/categories/tree.

Min value: 0

Exclusive min: true

Query parameters

Name

Description

businessId

Type: integer

内阁ID。 要找到答案,请使用请求 GET v2/campaigns.

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

Min value: 1

Responses

200 OK

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

Body

application/json
{
  "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

All of 2 types
  • Type: object

    status

    Type: string

    响应的类型。 可能的值:

    • OK — 没有错误。
    • ERROR — 处理请求时出错。

    Enum: OK, ERROR

    服务器响应的标准包装器。

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

    result

    Type: object

    categoryId

    Type: integer

    市场上的类别的ID。

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

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

    Min value: 0

    Exclusive min: true

    parameters

    Type: object[]

    allowCustomValues

    Type: boolean

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

    distinctive

    Type: boolean

    征是否为变体的特征。

    filtering

    Type: boolean

    特性是否用于滤波器中。

    id

    Type: integer

    特性的标识符。

    Min value: 1

    multivalue

    Type: boolean

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

    required

    Type: boolean

    强制性特征。

    type

    Type: string

    数据类型:

    • TEXT — 文本。
    • ENUM — 可能值的列表。
    • BOOLEANtruefalse.
    • NUMERIC — 数字。

    Enum: TEXT, ENUM, BOOLEAN, NUMERIC

    constraints

    Type: object

    maxLength

    Type: integer

    文本的最大长度。

    maxValue

    Type: number

    的最大数量。

    minValue

    Type: number

    的最小数量。

    特性的值的限制。

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

    description

    Type: string

    特性的描述。

    Example: example

    name

    Type: string

    特性的名称。

    Example: example

    recommendationTypes

    Type: string[] | null

    填写卡片的可能建议列表,此特性适用于此。

    Min items: 1

    Unique items: true

    Example
    [
      "HAS_VIDEO"
    ]
    

    unit

    Type: object

    defaultUnitId

    Type: integer

    默认的测量单位。

    units

    Type: object[]

    fullName

    Type: string

    计量单位的全称。

    Example: килограмм

    id

    Type: integer

    测量单位的ID。

    name

    Type: string

    计量单位的缩写名称。

    Example: кг

    可接受的计量单位。

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

    品特性的测量单位。

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

    valueRestrictions

    Type: object[]

    limitedValues

    Type: object[]

    limitingOptionValueId

    Type: integer

    限制特性的值的ID。

    optionValueIds

    Type: integer[]

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

    Unique items: true

    Example
    [
      1
    ]
    

    限制特性的值和当前特性的相应允许值。

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

    limitingParameterId

    Type: integer

    限制特性的ID。

    Min value: 1

    其他特性强加的值的限制。 仅针对类型特征 ENUM.

    Min items: 1

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

    values

    Type: object[]

    id

    Type: integer

    值的ID。

    value

    Type: string

    意义。

    Example: example

    description

    Type: string

    值的描述。

    Example: example

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

    Min items: 1

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

    征的列表。

    Min items: 1

    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": [
              {}
            ]
          }
        ]
      }
    ]
    

    类别参数的信息。

    Example
    {
      "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
              ]
            }
          ]
        }
      ]
    }
    
    Example
    {
      "result": {
        "categoryId": 0,
        "parameters": [
          {
            "id": 1,
            "name": "example",
            "type": "TEXT",
            "unit": {
              "defaultUnitId": 0,
              "units": [
                null
              ]
            },
            "description": "example",
            "recommendationTypes": [
              "HAS_VIDEO"
            ],
            "required": true,
            "filtering": true,
            "distinctive": true,
            "multivalue": true,
            "allowCustomValues": true,
            "values": [
              {}
            ],
            "constraints": {
              "minValue": 0.5,
              "maxValue": 0.5,
              "maxLength": 0
            },
            "valueRestrictions": [
              {}
            ]
          }
        ]
      }
    }
    

400 Bad Request

请求包含不正确的数据。 详细了解处理类别时的错误

Body

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

Type: object

All of 1 type
  • Type: object

    All of 2 types
    • Type: object

      status

      Type: string

      响应的类型。 可能的值:

      • OK — 没有错误。
      • ERROR — 处理请求时出错。

      Enum: OK, ERROR

      服务器响应的标准包装器。

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

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      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: object

    All of 2 types
    • Type: object

      status

      Type: string

      响应的类型。 可能的值:

      • OK — 没有错误。
      • ERROR — 处理请求时出错。

      Enum: OK, ERROR

      服务器响应的标准包装器。

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

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      
      Example
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      

    服务器错误的标准包装器。

    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: object

    All of 2 types
    • Type: object

      status

      Type: string

      响应的类型。 可能的值:

      • OK — 没有错误。
      • ERROR — 处理请求时出错。

      Enum: OK, ERROR

      服务器响应的标准包装器。

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

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      
      Example
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      

    服务器错误的标准包装器。

    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: object

    All of 2 types
    • Type: object

      status

      Type: string

      响应的类型。 可能的值:

      • OK — 没有错误。
      • ERROR — 处理请求时出错。

      Enum: OK, ERROR

      服务器响应的标准包装器。

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

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      
      Example
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      

    服务器错误的标准包装器。

    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: object

    All of 2 types
    • Type: object

      status

      Type: string

      响应的类型。 可能的值:

      • OK — 没有错误。
      • ERROR — 处理请求时出错。

      Enum: OK, ERROR

      服务器响应的标准包装器。

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

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      
      Example
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      

    服务器错误的标准包装器。

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

500 Internal Server Error

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

Body

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

Type: object

All of 1 type
  • Type: object

    All of 2 types
    • Type: object

      status

      Type: string

      响应的类型。 可能的值:

      • OK — 没有错误。
      • ERROR — 处理请求时出错。

      Enum: OK, ERROR

      服务器响应的标准包装器。

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

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      
      Example
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      

    服务器错误的标准包装器。

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

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

没有子项的类别。