Listings quality

The /health resource allows see the quality of the publications, knowing what goals are completed and those that are still pending, allowing the achievement of publication objectives and increasing the listings quality, thus improving the item exposure and also the sale and purchase experience. See more about status of your datasheets.


Contents

→Quality levels
→Quality detail by marketplace item
→Necessary actions to improve the quality of an marketplace item



Quality levels

The /health_level resource allows you to identify the necessary scoring range for each listing level. Currently all sites have same scoring range.

Request:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/marketplace/sites/$SITE_ID/health_levels

Example:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/marketplace/sites/MLB/health_levels

Response:

[
   {
       "level": "basic",
       "health_min": 0,
       "health_max": 0.69
   },
   {
       "level": "standard",
       "health_min": 0.7,
       "health_max": 0.98
   },
   {
       "level": "professional",
       "health_min": 0.99,
       "health_max": 1
   }
]

Response fields

level: identification of the quality level in which the listing is located: basic, standard and professional.
health_min and health_max: respectively represent the minimum and maximum values of the range of punctuation used to identify the quality level in which the publication is.


Quality detail by marketplace item

To find out the quality level of an item, it is available the /health resource. In this, you can access to the quality percentage of the item, which is calculated by dividing the number of objectives met / quality of applicable objectives. In addition, you can see the level at which it falls.

Request:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/marketplace/items/$ITEM_ID/health

Example:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/marketplace/items/MCO111159326/health

Response:

{
    "item_id": "MCO111159326",
    "health": 0.85,
    "level": "standard",
    "goals": [
        {
            "progress": 0,
            "progress_max": 0,
            "id": "buybox",
            "name": "buybox",
            "apply": false,
            "completed": "0001-01-01T00:00:00Z",
        },
        {
            "progress": 1,
            "progress_max": 1,
            "id": "picture",
            "name": "picture",
            "apply": true,
            "completed": "2021-09-07T08:57:03.895Z",
        },
        {
            "progress": 0,
            "progress_max": 1,
            "id": "price",
            "name": "price",
            "apply": false,
            "completed": "0001-01-01T00:00:00Z",
        },
        {
            "progress": 0,
            "progress_max": 1,
            "id": "me2",
            "name": "me2",
            "apply": false,
            "completed": "0001-01-01T00:00:00Z",
        },
        {
            "progress": 0,
            "progress_max": 1,
            "id": "variations",
            "name": "variations",
            "apply": true,
            "completed": "0001-01-01T00:00:00Z",
        },
        {
            "progress": 0,
            "progress_max": 1,
            "id": "size_chart",
            "name": "size_chart",
            "apply": false,
            "completed": "0001-01-01T00:00:00Z",
        },
        {
            "progress": 10,
            "progress_max": 10,
            "id": "technical_specification",
            "name": "technical_specification",
            "apply": true,
            "completed": "2021-05-26T12:37:11.743Z",
        },
        {
            "progress": 0,
            "progress_max": 1,
            "id": "free_shipping",
            "name": "free_shipping",
            "apply": false,
            "completed": "0001-01-01T00:00:00Z",
        },
        {
            "progress": 0,
            "progress_max": 1,
            "id": "flex",
            "name": "flex",
            "apply": false,
            "completed": "0001-01-01T00:00:00Z",
        },
        {
            "progress": 1,
            "progress_max": 1,
            "id": "immediate_payment",
            "name": "immediate_payment",
            "apply": true,
            "completed": "2021-05-26T12:37:11.665Z",
        },
        {
            "progress": 0,
            "progress_max": 1,
            "id": "product_identifiers",
            "name": "product_identifiers",
            "apply": false,
            "completed": "0001-01-01T00:00:00Z",
        },
        {
            "progress": 1,
            "progress_max": 1,
            "id": "classic",
            "name": "classic",
            "apply": true,
            "completed": "2021-05-26T12:37:11.665Z",
        },
        {
            "progress": 1,
            "progress_max": 1,
            "id": "premium",
            "name": "installments_free",
            "apply": true,
            "completed": "2021-05-26T12:37:11.665Z",
        },
        {
            "progress": 1,
            "progress_max": 1,
            "id": "publish",
            "name": "publish",
            "apply": true,
            "completed": "2021-05-26T12:37:11.665Z",
        }
    ]
}

Response fields

id: objective´s identifier.
name: descriptive name.
apply: indicates whether the objective is applicable for the item.
completed: shows the date on which the objective was achieved. If it has not yet been met or is not applicable, this field will be hidden.
progress_max: the number indicates the highest possible progress value towards that objetive.
progress: the number indicates the current progress value on the goal. When it is equal to progress_max, it means that the objective has been completed.
health: the quality percentage of the item.


Necessary actions to improve the quality of an marketplace item

After identifying the item's quality level, in applicable cases, it is possible to verify which are the objectives that the seller still has pending and can adjust to improve the publication quality and get more exposure.

Request:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/marketplace/items/$ITEM_ID/health/actions

Example:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/marketplace/items/MCO111159326/health/actions

Response:

{
    "item_id": "MCO111159326",
    "health": 0.85,
    "actions": [
        {
            "id": "variations",
            "name": "variations"
        }
    ]
}

Actions description

In actions you can find all the actions that will help you improve the quality of the publication. Below, you can find out all the possible actions and the resources that should be verified to make the improvements:


technical_specification: complete mandatory attributes.
buybox: list on catalog.
variations: use variations to listing.
product_identifiers: inform the product universal code.
picture: check the pictures quality.
price: list with a more competitive price, and if applicable, we will indicate the price range that you can use.
free_shipping: offer free shipping.
premium (installments_free): completed automatically when listing.
publish: objective regarding the item listing, completed automatically when listing.