API Directory

REST API Resources.

 

Users and Apps

Under users and apps we will find all the resources relatives to mercadolibre users, applications and scopes.

Resource Description
/users/{id} Returns the user public information such as nickname, country, user type and reputation, specified by the user_id. If the user is logged, more information will be available.
/users/{user_id}/addresses?access_token={…} Retrieves the addresses of the user specified by user_id. This resource requires an access token.
/users/{user_id}/accepted_payment_methods Returns the payment methods accepted by a merchant to collect their operations.
/applications/{app_id} This resource allows create and manage application from third parties that use MercadoLibre API.
/users/{id}/applications/{app_id} This resource allows to deauthorize one application.

Categories and Listings

Use the correct site for your application, you can pick from MLA, MLB among other and their respective categories and type of publications.

Retrieves the categories availables from the site.

Resource Description
/sites Retrieves information about the sites where MercadoLibre runs.
/sites/{site_id} Retrieves information about the sites where MercadoLibre runs.
/site_domains/{site_domain_url} Retrieves information about the domain.
/sites/{site_id}/listing_types Retrieves information about the listing types.
/sites/{site_id}/listing_exposures No description available.
/sites/{site_id}/listing_prices?price=1 No description available.
/sites/{site_id}/categories Retrieves the categories availables from the site.
/categories/{category_id} Retrieves the information about a MercadoLibres category.
/categories/{category_id}/attributes Displays attributes and rules over them in order to describe the items that are stored in each category. Rules are executed while posting the item. So the current attribute settings may be inconsistent with items which have been posted with another configuration.

Locations and Currencies

Resources that gives the regional information, countries, cities and currency.

Resource Description
/countries Retrieves countries information.
/countries/{country_id} Retrieves country information by country_id.
/states/{state_id} Retrieves state information.
/cities/{city_id} Retrieves city information.
/currencies Retrieves information about currencies used in MercadoLibre.
/currencies/{currency_id} Retrieves information about currencies used in MercadoLibre by currency_id.
/currency_conversions/search?from={currency_id}&to={currency_id} Retrieves the convertion ratio between currencies that MercadoLibre uses in calculations.
/classified_locations/search?cep={zip_code_br} Retrieves data for the location of the zip code entered
/countries/{country_id}/zip_codes/{zip_code} Retrieves data for the location of the zip code entered

Items and Searches

The heart of MercadoLibre API, the resources for managing items and to look for them.

Resource Description
/items This resource allows to interact with items.
/items/{item_id} Retrieves the information of a listed item.
/items/validate This resource allows to test a json to list an item.
/items/{id}/available_upgrades Returns the data to change the listing type of an item.
/items/{id}/relist This resource allows to relist a item.
/items/{id}/pictures Retrieves all item’s pictures.
/items/{id}/pictures/:id Retrieves picture’s information of an item.
/pictures/{picture_id} Retrieves the information of a picture.
/items/{id}/description/ Retrieves an item description.
/sites/{site_id}/search?q=ipod Retrieves items from a search queary.
/sites/{site_id}/searchUrl?q=ipod Search for any item in MercadoLibre. It will return an array of items that match the search criteria.
/sites/{site_id}/hot_items/search?limit=5&category={category_id} Retrieves an array of hot items from a specified category by parameter. Works only with the first level of categories.
/sites/{site_id}/featured_items/{pool_id} Retrieves an array of featured items. The featured items are items that have a special exposure at home page or categories page. You can use only HP for products of home or HP-{categId} for featured by category. Only works with first level of categories.
/sites/{site_id}/trends/search?category={category_id} Retrieve an array of the trends items from the category specified by parameter.
/sites/{site_id}/search?seller_id={seller_id} Search items by seller_id.
/sites/{site_id}/search?nickname={nickname} Search items by nickname.
/search-my-own-items/ Retrieves data from the actual user.
/items/{item_id}/product_identifiers/ Retrieves the product identifier codes associated to your item.

Order Management

The core of the business: the transactions. Using the order resources, can easily access to purchases, give feedback and follow any order

Resource Description
/orders?access_token={…} View, create and modify purchase orders at MercadoLibre.
/orders/search?access_token={…} Search the orders from a seller or buyer and not archived.
/payments?access_token={…} Returns data for a payment, according to the profile of the sender of the payment.
/payments/{payment_id}?access_token={…} Retrieves data of one payment.
/collections?access_token={…} No description available.
/payment_methods/{payment_method_id} Retrieves information about the different payment methods available in MercadoLibre.
/sites/{site_id}/payment_methods Returns the payment methods provided by MercadoPago.
/orders/{order_id}/feedback?access_token={…} Get the feedback received from a buyer or seller in an order.
/order/{id}/feedback/sale Retrieves data from a feedback made by saller.
/order/{id}/feedback/purchase Retrieves data from a feedback made by buyer.
/users/{seller_id}/order_blacklist Retrieves all users locked to make a buy.

For more information about working with online payments check MercadoPago

Shipping

Using this resources, can access deliveries, send tracking number and much more.

Resource Description
/shipments/{id} Retrieves all data to make a delivery.
/items/{id}/shipping_options Retrieves all methods available to send the product.
/sites/{site_id}/shipping_methods Retrieves shipping modes available in a country.
/sites/{site_id}/shipping_services Retrieves shipping services available in a country.
/sites/{site_id}/shipping_options?zip_code_from={zip_code}&zip_code_to={zip_code}&dimensions={dimensions} Retrieves the cost of a shipping. Shipping cost calculator per country.
/users/{user_id}/shipping_modes?category_id={category_id} Retrieves methods available to list a item of a user.
/users/{id}/shipping_options?zip_code={zip_code}&dimensions={dimensions} Retrieves the cost of a shipping. Shipping cost calculator.
/users/{id}/shipping_preferences Retrieves all shipping modes and services available to user.
/orders/{id}/shipments Retrieves data of the shipping methods chosen.
/shipment_labels Allows print the ticket for send the order.

Questions

Ask question, receive answers.

Resource Description
/questions?access_token={…} Ask, answer or search for questions. Hide questions or block someone from asking questions on your items.
/questions/search Search any question made to user products.
/users/{seller_id}/questions_blacklist?access_token={…} Search questions from users in the blacklist.
/my/received_questions/search Questions received by an user.