zephia/mercadolibre

Mercado Libre API client

MercadoLibre API Client

, _(*1)

Documentation

Official documentation and how to use the MercadoLibre API can be found at http://developers.mercadolibre.com/api-docs/, _(*2)

Installation

Using composer, _(*3)

composer require zephia/mercadolibre

Usage

<?php

// Instantiate serializer with configurations.
$serializer = \JMS\Serializer\SerializerBuilder::create()
   ->addMetadataDir(__DIR__ . '/../../resources/config/serializer')
   ->build();

// Instantiate client.
$client = new Zephia\MercadoLibre\Client\MercadoLibreClient(
    [],
    $serializer
);

// Call show user.
$ml_response = $client->showUser(1);

var_dump($ml_response);

// object(Zephia\MercadoLibre\Entity\User)

MercadoLibre API resources:

Overstriked resources are not available yet in this package. Contributions will be appreciated., _(*4)

Users & Apps

• /users/{Cust_id}?access_token=$ACCESS_TOKEN User account information. GET PUT, _(*5)

  Get user information., _(*6)

  $client->userShow('123');
  

  Update user information, _(*7)

• /users/me Returns account information about the authenticated user. GET, _(*8)

  Get information about the authenticated user., _(*9)

  $client->userShowMe();
  

• ~~/users/{Cust_id}/addresses?access_token=$ACCESS_TOKEN Returns addresses registered by the user. GET~~, _(*10)

  Get user addresses., _(*11)

• ~~/users/{Cust_id}/accepted_payment_methods Returns payment methods accepted by a seller to collect its operations. GET~~, _(*12)

  Get accepted payment methods by user., _(*13)

• ~~/applications/{application_id}?ACCESS_TOKEN Returns information about the application. GET~~, _(*14)

  Get application details., _(*15)

• ~~/users/{User_id}/brands This resource retrieves brands associated to an user_id. The official_store_id attribute identifies a store. GET~~, _(*16)

  Get brands by user., _(*17)

• /users/{User_id}/classifieds_promotion_packs?access_token=$ACCESS_TOKEN Manage user promotion packs. GET POST, _(*18)

  Get promotions packs engaged by user., _(*19)

  $client->userPackages();
  

  Creates a new Promotion Pack for the user., _(*20)

• ~~/users/{user_id}/classifieds_promotion_packs/{listing_type}&categoryId={category_id}?acces_token=$ACCESS_TOKEN Availability for the user to list under a given Listing Type and category according to packages engaged. GET~~, _(*21)

  Get the availability Listing Type availability by user and category., _(*22)

• ~~/projects?access_token=$ACCESS_TOKEN Manage projects. GET POST PUT DELETE~~, _(*23)

  Get all applications associated to a project, _(*24)

  Create a new project., _(*25)

  Update a project., _(*26)

  Remove a project., _(*27)

• ~~/projects/{Project_id}/applications?access_token=ACCESS_TOKEN_APP_OWNER Manage applications & projects. POST DELETE~~, _(*28)

  Save an application under your project., _(*29)

  Remove an application from your project., _(*30)

• ~~/users/{Cust_id}/available_listing_types?category_id={Category_id}&access_token=$ACCESS_TOKEN Listing types availability by user and category. GET~~, _(*31)

  Get available listing types., _(*32)

• ~~/users/{Cust_id}/available_listing_type/{listing_type_id}?category_id={Category_id}&access_token=$ACCESS_TOKEN Retrieves availability to list under a listing type for a given category. GET~~, _(*33)

  Get category availability., _(*34)

• ~~/users/{User_id}/applications/{App_id}?access_token=$ACCESS_TOKEN Application permissions. DELETE~~, _(*35)

  Revoke permissions to an application., _(*36)

• ~~/myfeeds?app_id={App_id} Notifications history. GET~~, _(*37)

  Get historic of notifications by App., _(*38)

Categories & Listings

• ~~/sites Retrieves information about the sites where MercadoLibre runs. GET~~, _(*39)

  Get all sites., _(*40)

• ~~/site_domains/{Site_domain_url} Returns information about the domain. GET~~, _(*41)

  Get domain information., _(*42)

• ~~/sites/{Site_id}/listing_types Returns information about listing types. GET~~, _(*43)

  Get listing types by site., _(*44)

• ~~/sites/{Site_id}/listing_exposures Returns different exposure levels associated with all listing types in MercadoLibre. GET~~, _(*45)

  Get listing exposures by site., _(*46)

• ~~/sites/{Site_id}/listing_prices?price={Price} Returns the listing price for selling and buying in MercadoLibre. GET~~, _(*47)

  Get listing prices., _(*48)

• /sites/{Site_id}/categories Returns available categories in the site. GET, _(*49)

  Get the category tree by site, _(*50)

  $client->categoryList();
  

• ~~/categories/{Category_id} Returns information about a category. GET~~, _(*51)

  Get category details., _(*52)

• ~~/categories/{Category_id}/attributes Displays attributes and rules over them in order to describe the items that are stored in each category. GET~~, _(*53)

  Get category attributes., _(*54)

• /sites/{Site_id}/category_predictor/predict Category predictor. Retrieves the most accurate category to list your item basing on it’s title. GET, _(*55)

  Predict category., _(*56)

  $client->categoryPredict('MLA', 'Fiat Uno');
  

• ~~/categories/{Category_id}/classifieds_promotion_packs Retrieves classified promotion packs by category. GET~~, _(*57)

  Get classified promotion packs by category, _(*58)

Locations & Currencies

• ~~/countries Returns countries information. GET~~, _(*59)

  Get information about countries., _(*60)

• ~~/countries/{Country_id} Returns country information by country_id. GET~~, _(*61)

  Get country detail, _(*62)

• ~~/states/{State_id} Returns state information. GET~~, _(*63)

  Get state information., _(*64)

• ~~/cities/{City_id} Returns city information. GET~~, _(*65)

  Get city information., _(*66)

• ~~/currencies Returns information about all available currencies in MercadoLibre. GET~~, _(*67)

  Get currencies information., _(*68)

• ~~/currencies/{Currency_id} Returns information about available currencies in MercadoLibre by currency_id. GET~~, _(*69)

  Get currency details., _(*70)

• ~~/currency_conversions/search?from={Currency_id}&to={Currency_id} Retrieves the conversion ratio between currencies that MercadoLibre uses in calculations. GET~~, _(*71)

  Get ratio conversion between currencies., _(*72)

• ~~/countries/{Country_id}/zip_codes/{Zip_code} Retrieves data for the location of the zip code entered. GET~~, _(*73)

  Get location information by zip code., _(*74)

• ~~/country/{Country_id}/zip_codes/search_between?zip_code_from={zip_code_from}&zip_code_to={zip_code_to} Retrieve all zip codes for a country_id between two given zip codes. GET~~, _(*75)

  Get all zip codes between two given values of zip codes., _(*76)

Items & Searches

• /items Allows listing items. POST, _(*77)

  List an item in MercadoLibre., _(*78)

  $item = new Zephia\MercadoLibre\Entity\Item;
  $client->itemCreate($item);
  

• /items/{Item_id} Allows managing listings GET PUT, _(*79)

  Get item details., _(*80)

  $client->itemShow('MLA123123');
  

  Update an item., _(*81)

• ~~/items/validate Validate the JSON before posting an item. POST~~, _(*82)

  Validate your JSON., _(*83)

• ~~/items/{Item_id}/available_upgrades Returns available listing types to upgrade an item posure. GET~~, _(*84)

  Get available upgrades., _(*85)

• ~~/items/{Item_id}/relist Allows to relist an item. GET~~, _(*86)

  Relist your item., _(*87)

• ~~/items/{Item_id}/pictures/{picture_id} Manage item pictures. GET DELETE~~, _(*88)

  Get pictures in all it sizes., _(*89)

  Delete a picture., _(*90)

• ~~/items/{Item_id}/pictures Add and update pictures on your item. GET PUT~~, _(*91)

  Post a picture., _(*92)

  Update items pictures., _(*93)

• ~~/items/{Item_id}/description Manage description for an item. GET PUT~~, _(*94)

  Get item description., _(*95)

  Update item description., _(*96)

• ~~/sites/{Site_id}/search?q=ipod Retrieves items from a search query. GET~~, _(*97)

  METHOD DESCRIPTION, _(*98)

• ~~/sites/{Site_id}/searchUrl?q=ipod Search for any item in MercadoLibre. It will return an array of items url that match the search criteria. GET~~, _(*99)

  Search items Url by query., _(*100)

• ~~/sites/MLA/search?category={Category_id}&official_store_id=all Search for all items listed by Official Stores for a given category. GET~~, _(*101)

  Search Official Store items., _(*102)

• ~~/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. GET~~, _(*103)

  Search hot items., _(*104)

• ~~/sites/{Site_id}/featured_items/HP-{Category_Id} Retrieves an array of featured items. The featured items are items that have a special posure 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. GET~~, _(*105)

  Get items featured on the home by it’s category., _(*106)

• ~~/sites/{Site_id}/trends/search?category={Category_id} Retrieve an array of the trends items from the category specified by parameter. GET~~, _(*107)

  Get trends by category, _(*108)

• ~~/sites/{Site_id}/search?seller_id={Seller_id}&category={Category_id}&access_token=$ACCESS_TOKEN Search items by seller_id for a category. GET~~, _(*109)

  Get items by seller id and cateogyr id., _(*110)

• /users/{Cust_id}/items/search?access_token=$ACCESS_TOKEN Retrieves user’s listings. GET, _(*111)

  Get user’s listings, _(*112)

  $client->setAccessToken(ACCESS_TOKEN)->itemList('user_id');
  

• ~~/items/{Item_id}/product_identifiers/ Retrieves the product identifier codes associated to your item. GET PUT~~, _(*113)

  Get item product identifiers., _(*114)

  Update product identifiers, _(*115)

• ~~/items/{Item_id}/variations Manage item’s variations. GET POST~~, _(*116)

  Get item’s variations., _(*117)

  Create a variation for your item., _(*118)

• ~~/items/{Item_id}/variations/{Variation_id} Manage variations. GET PUT DELETE~~, _(*119)

  Get variation details., _(*120)

  Update a variation., _(*121)

  Delete a variation., _(*122)

• ~~/users/{Cust_id}/items/search?sku={seller_custom_field}&status=active&access_token=$ACCESS_TOKEN Search item by SKU. Filter item by status. GET~~, _(*123)

  Search item by SKU. Filter item by status., _(*124)