How do I utilize the "extended_description" section to add/update the product description?

How do I utilize the "extended_description" section to add/update the product description?

Request Example：

"description_type": "extended",
"description_info": {
    "extended_description": {
        "field_list": [
            {
                "field_type": "text",
                "text": "text description 1"
            },
            {
                "field_type": "image",
                "image_info": {
                    "image_id": "1e076dff0699d8e778c06dd6c02df1fe"
                }
            }

                {
                "field_type": "text",
                "text": "text description 2"
            }
        ]
    }
}

The front-end product page will look like below:

Currently we allow sellers to add images in the product description section.

• A new parameter, "description_info", is added to the "v2.product.add_item" API for uploading product descriptions containing both images and texts which we call extended description (when the "description_type" is extended, plain texts should be input here.). The existing parameter, "description", is for uploading plain texts only (when the "description_type" is normal, plain texts should be input here.). You cannot upload plain texts and extended description to the same product at the same time. For sellers who are not currently on the whitelist, the "description_type" can be omitted, and the description is in plain text by default.
• The new parameter "extended_description_limit" required by the "v2.product.get_item_limit" API indicates the limitation of the extended description.
• The new parameter "scene" required by the "v2.media_space.upload_image" API is for sellers to upload images used in extended description.

Here are some frequent-asked questions related to the "extended_description" section

Q: Does the "extended_description" section support HTML format?

A: At present, it doesn't support HTML format or any text effects, such as bold text. For "text" field in "extended_description" section, you need to upload a plain text value.

Q: How do we currently know if a seller is on the whitelist?

A: At present, the OpenAPI will not return the whitelist information. To verify if the seller is on the whitelist, he/she can check whether it's allowed to add images in the product description section in the Seller Centre. In the future, this feature will be gradually opened to other non-whitelist sellers.

Q: Does the v1.0 API support the "extended_description" section? If the seller is whitelisted, can I still retrieve the item description? Is it possible to add or update items successfully?

A: The v1.0 API does not support adding products with "extended_description". If attempted, the API will return an error message:

“Parameter is not match the constraints, You are not in the whitelist to add images in description, can only upload plain text.”

Whitelisted sellers can still add products using the v1.0 API, but they can only include plain text descriptions. If a product already uses "extended_description", you cannot update it through the v1.0 API. Attempting to do so will result in an error:

"Item description include images, please use Open API 2.0 editing."

Please note that products created by whitelisted sellers via the Seller Centre will use "extended_description", regardless of whether the description includes images. Therefore, you may encounter the error:

"Item description include images, please use Open API 2.0 editing."

When updating products using v1.0 API, regardless of whether the update API call includes a description update or not, whitelisted sellers will receive the error:

"Item description include images, please use Open API 2.0 editing."when they update their products with V1.0

Q: Can CNSC sellers choose whether the MPSKU description is plain text or extended description when publishing?

A: The "v2.global_product.create_publish_task" API does not include a "description_type" field, meaning that the description type of the MPSKU will match that of the original MTSKU. If the original MTSKU uses "extended_description", the MPSKU must also use "extended_description" when published. Similarly, if the MTSKU is in plain text, the MPSKU must be plain text. Otherwise, the API will return an error:

“Parameter is not match the constraints, Description type of MTSKU and MPSKU should be same.”

After publishing, you can modify the MPSKU description separately. If your sync toggle for descriptions is enabled, any changes to the MTSKU description type will automatically sync to the MPSKU. If not, changes to the MTSKU description type will not be synchronized to the MPSKU.

Q: When I called the "v2.product.add_item" API and uploaded the "extended_description", the system returned the following error message:

"Parameter is not match the constraints; Product description format error(s) detected, please check and ensure all formats are correct."

A: Please refer to the document:https://open.shopee.com/documents/v2/v2.product.add_item?module=89&type=1 and correct your request parameter(s).

Q: Why isn't the updated "extended_description" of MTSKU syncing to MPSKU?

A: If the updated "extended_description" of the MTSKU does not comply with the constraints specified in the "extended_description_limit" field from the "v2.product.get_item_limit" API, the synchronization will fail.

Q: Can sellers on the whitelist change the product description format between plain text and text with images?

A: For whitelisted sellers, it is possible to change the product description from plain text to text with images, or vice versa, by uploading the "description_type" field. However, if the change only involves editing the plain text without adding or removing images, there is no need to upload the "description_type" field.

Non-whitelist sellers update to use the "extended_description" section, and the "description_type" field does not need to be uploaded when update products in plain text description.