Recommend Required Product Properties

POST

/product/202609/products/properties/recommend

Predicts the required product properties and their recommended values from the product category and content. The result is generated synchronously for one product and can be used to prepare a create or edit product request.

Do not include personal data, such as names, phone numbers, email addresses, or postal addresses, in the product title, description, or images. The response does not return the submitted product content.

Authorizations

• accessToken

Parameters

Query Parameters

shop_cipher

required

string

Identifies the shop. Obtain it from the Get Authorized Shops API.

Request Body^required

Media typeapplication/json

object

category_id

required

The ID of the leaf category selected for the product.

string

description

Product description used to improve prediction accuracy. Do not include personal data.

string

images

Ordered product images used to improve prediction accuracy. Do not include images containing personal data.

Array<object>

object

uri

required

The URI of the image. Obtain this URI by uploading the images through the Upload Product Image API with use_case=CERTIFICATION_IMAGE.

string

product_title

required

Product title used to predict required properties. Do not include personal data.

string

sales_properties

Existing standard sales properties that define the product variants and provide additional prediction context.

Array<object>

object

id

required

ID of the sales property.

string

values

required

Existing values selected for the sales property.

Array<object>

object

id

required

ID of the sales property value.

string

target_property_ids

Optional property IDs that limit prediction to specific properties. When omitted, no property ID filter is applied.

Array<string>

Example

{
  "category_id": "600001",
  "description": "Lightweight cotton ankle socks designed for everyday wear.",
  "images": [
    {
      "uri": "tos-maliva-i-o3syd03w52-us/c668cdf70b7f483c94dbe"
    }
  ],
  "product_title": "Short Boat Invisible Socks",
  "sales_properties": [
    {
      "id": "100000",
      "values": [
        {
          "id": "100001"
        }
      ]
    }
  ],
  "target_property_ids": [
    "100392"
  ]
}

Responses

200

Success

Media typeapplication/json

object

code

Status code; 0 means success.

integer format: int64

message

Success or failure message.

string

request_id

Request log ID.

string

data

object

recommended_properties

Ordered required properties predicted for the product. The array is empty when no property recommendation is available.

Array<object>

object

id

required

ID of the recommended property.

string

is_customizable

required

Whether the seller can enter a custom value when no recommended value applies.

boolean

is_multiple_selection

required

Whether the seller can select more than one value for the property.

boolean

is_required

required

Whether the property must be provided when the product is created or edited.

boolean

name

required

Display name of the recommended property for the shop’s region.

string

type

required

Type of the recommended property. Possible values:

• UNSPECIFIED: The service could not classify the property type.
• KEY_PROPERTY: A key property used to identify the product.
• SALES_PROPERTY: A sales property that defines product variants.
• PRODUCT_PROPERTY: A property that describes the product as a whole.

string

Allowed values: UNSPECIFIED KEY_PROPERTY SALES_PROPERTY PRODUCT_PROPERTY

values

required

Ordered values recommended for the property. The array is empty when the property requires a custom value or no value is recommended.

Array<object>

object

id

required

ID of the recommended property value.

string

name

required

Display name of the recommended property value for the shop’s region.

string

Example

{
  "code": 0,
  "data": {
    "recommended_properties": [
      {
        "id": "100392",
        "is_customizable": false,
        "is_multiple_selection": false,
        "is_required": true,
        "name": "Occasion",
        "type": "PRODUCT_PROPERTY",
        "values": [
          {
            "id": "1001533",
            "name": "Birthday"
          }
        ]
      }
    ]
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}