Manage packages (Real Estate)

Promotions Packs are listing packages for Real Estate Agency Classifieds listings. In this tutorial you’ll learn how to get information about packages and also engage and activate a package.
For a user to massively list as a real estate agency through a business agreement, he/she should:

  • Set up the user as real estate.
  • Assign a listing package.
  • Get a stand-out package (optional).

NOTE: For testing purposes, you should send the test user to the support channel so that he/she is activated as real estate.

Contents:

Query packages by category

The possible values for classifieds_promotion_packs categories are different each site. Possible values are:
{site_id}1459: Real Estate Agency.
For example, on Argentina, Real Estate package category it’s MLA1459 while in Brazil it’s MLB1459
Make a GET to look for packages in an specific category:

curl -X GET https://api.mercadolibre.com/categories/{category_id}/classifieds_promotion_packs

Example

curl -X GET https://api.mercadolibre.com/categories/MLA1459/classifieds_promotion_packs
[
  {
    "id": "IPILIMP30DF",
    "category_id": "MLA1459",
    "brand": "MLREALESTATE",
    "description": "Paquete Ilimitado propiedades",
    "price": 1145.87,
    "package_type": "unlimited",
    "package_content": "publications",
    "duration": 30,
    "status": "active",
    "charge_type_id": "CCGE",
    "max_upgrades": 300,
    "quota_type": "reusable",
    "listing_details": [
      {
        "listing_type_id": "silver",
        "available_listings": 100000
      }
    ]
  },
  {
    "id": "IPILIMP90DF",
    "category_id": "MLA1459",
    "brand": "MLREALESTATE",
    "description": "Paquete Ilimitado propiedades",
    "price": 3081.87,
    "package_type": "unlimited",
    "package_content": "publications",
    "duration": 90,
    "status": "active",
    "charge_type_id": "CCGJ",
    "max_upgrades": 300,
    "quota_type": "reusable",
    "listing_details": [
      {
        "listing_type_id": "silver",
        "available_listings": 100000
      }
    ]
  },
  {
    "id": "IPILIMP180DF",
    "category_id": "MLA1459",
    "brand": "MLREALESTATE",
    "description": "Paquete Ilimitado propiedades",
    "price": 5864.87,
    "package_type": "unlimited",
    "package_content": "publications",
    "duration": 180,
    "status": "active",
    "charge_type_id": "CCGO",
    "max_upgrades": 300,
    "quota_type": "reusable",
    "listing_details": [
      {
        "listing_type_id": "silver",
        "available_listings": 100000
      }
    ]
  }
]

Query listing packages engaged by a user

Listing packages are plain packages to list in a single display. We provide an option to engage a stand-out package to increase display on demand.
Mixed packages with various display quotas, e.g., silver, golden and golden_premium are available in MCO only, and a display increase or reduction is achieved by finishing the listing and re-listing.

Call

curl -X GET https://api.mercadolibre.com/users/{user_id}/classifieds_promotion_packs?access_token=$ACCESS_TOKEN;

Example

curl -X GET https://api.mercadolibre.com/users/135146148/classifieds_promotion_packs?access_token=$ACCESS_TOKEN;

Response

[
    {
       "id": 754985,
       "user_id": "135146148",
       "promotion_pack_id": "MPAB",
       "category_id": "MLU1743",
       "description": "Paquete 15 Básico",
       "package_type": "rotary",
       "status": "active",
       "date_created": "2013-05-23T15:34:48.498-04:00",
       "date_start": "2013-05-23T15:34:47.544-04:00",
       "date_expires": "2013-06-22T15:34:47.544-04:00",
       "date_stopped": null,
       "last_updated": "2013-05-23T15:35:48.211-04:00",
       "engagement_type": "none",
       "charge_id": 822129921,
       "remaining_listings": 15,
       "used_listings": 0,
       "listing_details": [
            {
             "listing_type_id": "silver",
             "available_listings": 15,
             "used_listings": 0,
             "remaining_listings": 15
            }
       ]
    }
]

Query stand-out packages engaged by a user

Based on the display level desired for your items, you may engage different stand-out packages. For more information please see the following tutorial.

NOTE: There are no stand-out packages available for MCO. When activating a listing package, it is directly a mixed package with different display quotas, where a display increase or reduction is achieved by finishing the listing and re-listing.

curl -X GET 
https://api.mercadolibre.com/users/{user_id}/classifieds_promotion_packs?package_content=upgrades&status=active&access_token=$ACCESS_TOKEN;

Response

[
    {
        "id": 1584151,
        "user_id": "XXXXXX",
        "promotion_pack_id": "IPUPGGP5INT",
        "category_id": "MLA1459",
        "brand": "MLREALESTATE",
        "description": "5 Destaques Oro Premium Interior",
        "package_type": "rotary",
        "status": "active",
        "date_created": "2017-08-31T09:08:29.124-04:00",
        "date_start": "2017-08-31T09:08:29.113-04:00",
        "date_expires": "2017-09-30T09:08:29.113-04:00",
        "date_stopped": null,
        "last_updated": "2017-08-31T09:25:57.860-04:00",
        "engagement_type": "none",
        "package_content": "upgrades",
        "charge_id": 3152387845,
        "bonus_id": null,
        "remaining_listings": 0,
        "used_listings": 5,
        "quota_type": "reusable",
        "next_promotion_pack_id": null,
        "parent_promotion_pack_id": null,
        "listing_details": [
            {
                "listing_type_id": "gold_premium",
                "available_listings": 5,
                "used_listings": 5,
                "remaining_listings": 0
            }
        ]
    },
    {
        "id": 1584150,
        "user_id": "XXXXXX",
        "promotion_pack_id": "IPUPGG5INT",
        "category_id": "MLA1459",
        "brand": "MLREALESTATE",
        "description": "5 Destaques Oro Interior",
        "package_type": "rotary",
        "status": "active",
        "date_created": "2017-08-31T09:08:28.752-04:00",
        "date_start": "2017-08-31T09:08:28.742-04:00",
        "date_expires": "2017-09-30T09:08:28.742-04:00",
        "date_stopped": null,
        "last_updated": "2017-08-31T09:25:57.747-04:00",
        "engagement_type": "none",
        "package_content": "upgrades",
        "charge_id": 3152387844,
        "bonus_id": null,
        "remaining_listings": 0,
        "used_listings": 5,
        "quota_type": "reusable",
        "next_promotion_pack_id": null,
        "parent_promotion_pack_id": null,
        "listing_details": [
            {
                "listing_type_id": "gold",
                "available_listings": 5,
                "used_listings": 5,
                "remaining_listings": 0
            }
        ]
    }
]

Resource description

attribute description
id unique package identifier.
user_id unique id of the user who engaged the package.
category_id Package category.
description package name.
package_type: package detail.
status package status possible values are:
active: the user can use this package to list. An available_listing will be discounted when he does.
pending: the package it’s not active yet.
finished: expired package.
date_created date the package was created.
date_start: date the package was activated.
date_expires date the package expires.
date_stopped date the package was finished.
last_updated last time the package was updated.
engagement_type Possible values are:
“none”: The package was engaged for one time.
“re-engagement”: When the package expires, a similar package_type will be re engaged automatically.
charge_id unique id of the charge generated over the engagement of the package.
listing_details detailed information about listing types and availability.
listing_type_id listing_type associated to the package.
available_listings amount of listings the user gets with the package.
used_listings already spent listings.
remaining_listings available listings left.

Verify if a user has a specific listing_type available

curl -X GET https://api.mercadolibre.com/users/{user_id}/classifieds_promotion_packs/silver?access_token=$ACCESS_TOKEN

Item stand-out

To stand out a listing you should make the following post. Bear in mind that in order to perform this action, the user should have previously engaged a stand-out package:

Call

POST https://api.mercadolibre.com/items/{item_id}/listing_type?access_token=$ACCESS_TOKEN

Example

curl -X POST 'https://api.mercadolibre.com/items/MLA111111111/listing_type?access_token=$ACCESS_TOKEN' -d '{"id":"listing_type"}'

Response

{
    "id": "MLA111111111",
    "site_id": "MLA",
    "title": "Test 10 No Ofertar",
    "subtitle": null,
    "seller_id": 184854440,
    "category_id": "MLA50543",
          "official_store_id": null,
    "price": 2928282,
    "base_price": 2928282,
    "original_price": null,
    "currency_id": "ARS",
    "initial_quantity": 1,
    "available_quantity": 1,
    "sold_quantity": 0,
    "buying_mode": "classified",
    "listing_type_id": "gold",
    "start_time": "2015-06-09T20:25:50.000Z",
    "stop_time": "2015-07-05T19:51:17.587Z",
    "end_time": "2015-07-05T19:51:17.587Z",
    "condition": "not_specified",
    "permalink": "http://inmueble.mercadolibre.com.ar/MLA-563940625-test-10-no-ofertar-_JM",
    "thumbnail": "http://mla-s1-p.mlstatic.com/302401-MLA20317818801_062015-I.jpg",
    "secure_thumbnail": "https://mla-s1-p.mlstatic.com/302401-MLA20317818801_062015-I.jpg",
    "pictures": [
        {
            "id": "302401-MLA20317818801_062015",
            "url": "http://mla-s1-p.mlstatic.com/302401-MLA20317818801_062015-O.jpg",
            "secure_url": "https://mla-s1-p.mlstatic.com/302401-MLA20317818801_062015-O.jpg",
            "size": "500x281",
            "max_size": "1200x675",
            "quality": ""
        }
    ],
    "video_id": null,
    "descriptions": [],
    "accepts_mercadopago": false,
    "non_mercado_pago_payment_methods": [],
    "shipping": {
        "mode": "not_specified",
        "local_pick_up": false,
        "free_shipping": false,
        "methods": [],
        "dimensions": null,
        "tags": []
    },
    "international_delivery_mode": "none",
    "seller_address": {
        "id": 163310864,
        "comment": "",
        "address_line": "Test Address 123",
        "zip_code": "1414",
        "city": {
            "id": "",
            "name": "Palermo"
        },
        "state": {
            "id": "AR-C",
            "name": "Capital Federal"
        },
        "country": {
         "id": "AR",
            "name": "Argentina"
        },
        "latitude": "",
        "longitude": "",
        "search_location": {
            "neighborhood": {
                "id": "TUxBQlBBTDI1MTVa",
                "name": "Palermo"
            },
            "city": {
                "id": "TUxBQ0NBUGZlZG1sYQ",
                "name": "Capital Federal"
            },
            "state": {
                "id": "TUxBUENBUGw3M2E1",
                "name": "Capital Federal"
            }
        }
    },
    "seller_contact": {
        "contact": "",
        "other_info": "",
        "area_code": "",
        "phone": "",
        "area_code2": "",
        "phone2": "",
        "email": "",
        "webpage": ""
    },
    "location": {
        "address_line": "falsa 123 123",
        "zip_code": "",
        "neighborhood": {
            "id": "TUxBQkVTUDYyODRa",
            "name": "Espartillar"
        },
        "city": {
            "id": "TUxBQ0FETzQ2Nzc",
            "name": "Adolfo Alsina"
        },
        "state": {
            "id": "TUxBUFpPTmFpbnRl",
            "name": "Buenos Aires Interior"
        },
        "country": {
            "id": "AR",
            "name": "Argentina"
        },
        "latitude": -34.6635266,
        "longitude": -58.3654707,
        "open_hours": ""
    },
    "geolocation": {
        "latitude": -34.6635266,
        "longitude": -58.3654707
    },
    "coverage_areas": [],
    "attributes": [
        {
            "id": "MLA1459-HORPREF",
            "name": "Horario de contacto",
            "value_id": "",
            "value_name": "",
            "attribute_group_id": "ADICIONALES",
            "attribute_group_name": "Adicionales"
        },
        {
            "id": "MLA50541-ACCESO",
            "name": "Acceso",
            "value_id": "",
            "value_name": "",
            "attribute_group_id": "ADICIONALES",
            "attribute_group_name": "Adicionales"
        },
        {
            "id": "MLA50541-ANTIG",
            "name": "Antigüedad",
            "value_id": "",
            "value_name": "",
            "attribute_group_id": "ADICIONALES",
            "attribute_group_name": "Adicionales"
        },
        {
            "id": "MLA50541-EXPENCEM",
            "name": "Expensas ($)",
            "value_id": "",
            "value_name": "",
            "attribute_group_id": "ADICIONALES",
            "attribute_group_name": "Adicionales"
        },
        {
            "id": "MLA50541-SEGUR",
            "name": "Seguridad",
         "value_id": "",
            "value_name": "",
            "attribute_group_id": "ADICIONALES",
            "attribute_group_name": "Adicionales"
        },
        {
            "id": "MLA1459-INMUEBLE",
            "name": "Inmueble",
            "value_id": "MLA1459-INMUEBLE-COCHERA",
            "value_name": "Cochera",
            "attribute_group_id": "FIND",
            "attribute_group_name": "Ficha técnica"
        },
        {
            "id": "MLA1459-OPERACION",
            "name": "Operación",
            "value_id": "MLA1459-OPERACION-VENTA",
            "value_name": "Venta",
            "attribute_group_id": "FIND",
            "attribute_group_name": "Ficha técnica"
        },
        {
            "id": "MLA50541-MTRSTOTAL",
            "name": "Superficie total (m²)",
            "value_id": "",
            "value_name": "24",
            "attribute_group_id": "FIND",
            "attribute_group_name": "Ficha técnica"
        },
        {
            "id": "MLA50541-TIPCOB",
            "name": "Tipo de cobertura",
            "value_id": "MLA50541-TIPCOB-CUBIERTA",
            "value_name": "Cubierta",
            "attribute_group_id": "FIND",
            "attribute_group_name": "Ficha técnica"
        },
        {
            "id": "MLA50541-TIPOCOCH",
            "name": "Tipo de cochera",
            "value_id": "MLA50541-TIPOCOCH-FIJA",
            "value_name": "Fija",
            "attribute_group_id": "FIND",
            "attribute_group_name": "Ficha técnica"
        }
    ],
    "listing_source": "",
    "variations": [],
    "status": "active",
    "sub_status": [],
    "tags": [],
    "warranty": null,
    "catalog_product_id": null,
    "seller_custom_field": null,
    "parent_item_id": null,
    "differential_pricing": null,
    "deal_ids": [],
    "automatic_relist": false,
    "date_created": "2015-06-09T20:25:50.000Z",
    "last_updated": "2015-06-10T12:20:32.418Z"
}

Next:
List properties.

Please rate this