Item description

The description of item contains information about the product and serves to complement what is detailed in the data sheet. Remember that this will allow the buyer to quickly find all the specifications that characterize the products. What kind of information should the description include? It should include the technical characteristics and the differentiators against competition.

Contents

→Tips for describing a post
→Uploading item description
→How can I list in both formats?
→Benefits of using plain text
→Adding or replacing an existing description
→Error loading description


Tips for describing a post

  • First load the important data in the data sheet, that is to say all the specifications without forgetting the universal product code.
  • Verify that the data that you are going to write in the description are the details that are not in the data sheet.
  • Nests the information so that it is well organized. Use uppercase, hyphens, spacing, etc.
  • Be brief and read your own description to check its length.

You can check all the details on how to describe a product.


Uploading item description

Through the API, you can work with descriptions containing plain text.

Notes:
- When you create a new item, you must add "plain_text" in the "description" field.
- Remember that you can only break pages this way: \n and you cannot change fonts, sizes or make texts in bold.

How can I list in both formats?

curl -X POST -H "Content-Type: application/json" -d
'{
    "title": "Item de test - No Ofertar",
    "category_id": "MLA47392",
    "price": 10,
    "currency_id": "ARS",
    "available_quantity": 1,
    "buying_mode": "buy_it_now",
    "listing_type_id": "gold_special",
    "condition": "new",
    "description":{
                    "plain_text":"Descripción con Texto Plano  \n"},
    "video_id": "YOUTUBE_ID_HERE",
    "tags": [
        "immediate_payment"
    ],
    "warranty": "12 months by Ray Ban",
    "pictures": [
        {
            "source": "https://upload.wikimedia.org/wikipedia/commons/f/fd/Ray_Ban_Original_Wayfarer.jpg"
        },
        {
            "source": "https://en.wikipedia.org/wiki/File:Teashades.gif"
        }
    ]
}'
https://api.mercadolibre.com/items?access_token=$ACCESS_TOKEN

Benefits of using plain text

  • They will have better results in searches.
  • Descriptions can be downloaded 5 times faster.
  • They will be properly displayed in all devices (mobile, tablets, computer).
  • Besides, you will be able to upload up to 10 item pictures and/or a link with a YouTube video.

Find below an example of the best practice to prepare a description:

Item:“Babolat Pure Control 3 Racket” [su_custom_gallery source="media: 10252" limit="1" link="lightbox" width="870" height="890"]

Notes:
- Bear in mind that you can add any payment and shipping method that you wish to the VIP.
- If you want your listing to show all item variations, even differential stock for each of them, we encourage you to use customized variations.
- Bear in mind that if you list using html and plain text, the priority will be given to the latter.

Adding or replacing an existing description

If you sent an empty description when listing an item, you can add it later. The same applies to changing the existing description.

Example:

curl -X PUT -H "Content-Type: application/json" -d
'{
"plain_text":"Los mejores Rayban Wayfarer. Test."
}'
https://api.mercadolibre.com/items/$ITEM_ID/description?access_token=$ACCESS_TOKEN

Can you see? It's easy! Descriptions can be added or replaced whenever you want, even if there are bids for the item. So, get on with it and prepare an excellent description for your items!


Error loading description

Listing item

In the event that you POST items by creating a post with a description that contains some unacceptable character, the response will contain more information about the error, such as the position of the wrong character.

Example:

curl -X POST -H "Content-Type: application/json" -d
'{
   "title":"Item de testeo",
   "category_id":"MLA47781",
   "price":10.01,
   "currency_id":"ARS",
   "available_quantity":1,
   "buying_mode":"buy_it_now",
   "listing_type_id":"gold_special",
   "condition":"new",
   "description":{
      "plain_text":"Texto < br > 😃"
   },
   "pictures":[
      {
         "source":"https://http2.mlstatic.com/item-de-testeo-por-favor-no-ofertar-kcoff-D_NQ_NP_521015-MCO25103941466_102016-F.jpg"
      }
   ]
}
https://api.mercadolibre.com/items?access_token=$ACCESS_TOKEN

In the response you can identify that errors are in position 6 and 16:

{
    "message": "Validation error",
    "error": "validation_error",
    "status": 400,
    "cause": [
        {
            "department": "items",
            "cause_id": 398,
            "type": "error",
            "code": "item.description.type.invalid",
            "references": [
                "plain_text[6]",
                "plain_text[16]"
            ],
            "message": "The description must be in plain text"
        }
    ]
}

Adding or modifying an existing description

curl -X PUT -H "Content-Type: application/json" -d
'{
"plain_text':'< br >,😃"
}'
https://api.mercadolibre.com/items/$ITEM_ID/description?api_version=2&access_token=$ACCESS_TOKEN

In order for the response to return the position of the character that generates the error, you must add the api_version=2 parameter.

The error will be like this:

{
    "message": "Validation error",
    "error": "validation_error",
    "status": 400,
    "cause": [
        {
            "department": "items",
            "cause_id": 398,
            "type": "error",
            "code": "item.description.type.invalid",
            "references": [
                "plain_text[0]",
                "plain_text[5]"
            ],
            "message": "The description must be in plain text"
        }
    ]
}

In the references node you can get the exact location of the character that generates the error. In this case 0 and 5.

or register to recieve the latest news about our API