Documentação do Mercado Livre
Confira todas as informações necessárias sobre as APIs Mercado Livre.
Documentação do
Gerenciamento de pacotes de veículos
Tipos de pacote
Existem 2 tipos de pacotes:
Pacote de publicação: obrigatório para o vendedor publicar anúncios. Este pacote é o prata (silver), ou seja, listing_type = silver.
Pacote de destaque: este pacote é opcional, e o vendedor utiliza este pacote para aumentar a exposição dos seus anúncios. Pode ser o ouro (listing_type = gold) e o diamante (listing_type = gold_premium).
Ambos os pacotes contém quotas que são consumidas a cada publicação de anúncio (no caso de um pacote de publicação) e a cada vez que se realiza um upgrade / destaque (no caso de um pacote de destaque).
O listing_type usado para publicar um anúncio será sempre o mais baixo: "prata", e, se quiser destacar o anúncio, deverá atualizar o anúncio com o listing_type desejado (consumindo uma quota no pacote de destaque).
Lembre-se que nas chamadas GET ao recurso de API classifieds_promotion_packs, você pode usar o parâmetro package_content (tipo de pacote) para saber qual pacote você quer consultar:
Parâmetro: package_content
Obrigatório: Não
Default: publications
Tipo: String
Valores: tipo do pacote:
- publications - pacotes de publicação
- upgrades - pacotes de destaque
- ALL - retorna todos os pacotes disponíveis
Um cliente, obrigatoriamente, deve ter um pacote de publicação para anunciar, mas os pacotes de destaques são opcionais. O cliente também pode ter mais de um pacote ativo ao mesmo tempo. Cada pacote ativo tem suas próprias quotas, datas de vencimento, etc.
Para saber como enviar uma publicação, visite a página Publicação de Imóveis, e lembre-se: o anúncio primeiramente deve ser enviado e publicado com um pacote de publicação, para posteriormente realizar um upgrade para um pacote de destaque, conforme explicado mais abaixo nesta página em Publicación de vehículos.
Pesquisar pacotes por categoria
Para consultar os pacotes disponíveis para as categorias de classificados, deve-se primeiramente saber qual a categoria a ser utilizada, de qual site. Por exemplo, para Brasil, categoria de veículos é MLB1744.
Chamada:
curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/categories/{category_id)/classifieds_promotion_packsExemplo:
curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/categories/MLB1743/classifieds_promotion_packsResposta:
[
{
"id": "PUS30FREE",
"category_id": "MLB1459",
"brand": "MLRCARDEALER",
"description": "Todo o seu estoque",
"price": 0,
"package_type": "unlimited",
"package_content": "publications",
"duration": 30,
"status": "active",
"charge_type_id": "free",
"max_upgrades": 0,
"quota_type": "reusable",
"listing_details": [
{
"listing_type_id": "silver",
"available_listings": 100000
}
]
}
]
Pesquisar pacotes de anúncios contratados por um usuário
Esta consulta é importante, pois através dela você pode saber quais os pacotes um cliente tem e qual a quantidade de anúncios disponíveis em cada um, informando o id do usuário (cliente), o tipo de pacote (package content) e o token. Veja abaixo um exemplo de chamada.
Chamada:
curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/users/{user_id}/classifieds_promotion_packs?package_content=$PACKAGE_CONTENTExemplo:
curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/users/135146148/classifieds_promotion_packs?package_content=ALLResposta:
[
{
"id": 754985,
"user_id": "135146148",
"promotion_pack_id": "MPAB",
"category_id": "MLU1743",
"description": "Paquete 15 Básico",
"package_type": "rotary",
"package_content": "publications",
"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
}
]
}
]Atente-se que pelo campo status = active, você pode verificar apenas os planos que ainda estão ativos. Através do package_content, você descobre se o pacote é de publicação (publications) ou destaque (upgrades). Por fim, através do campo remaining_listings, você consegue saber quantas publicações o cliente ainda tem direito. Isso é importante, porque você pode mostrar em seu sistema quantos pacotes o cliente tem, e qual a quantidade de anúncios restantes, para publicar e destacar, antes de enviar uma publicação para o Mercado Livre.
Descrição de recursos
| Atributo | Descrição |
|---|---|
| id | Identificador exclusivo do pacote. |
| user_id | ID exclusivo do usuário contratante do pacote. |
| category_id | Categoria do pacote. |
| description | Nome do pacote. |
| package_type | Detalhes do pacote. |
| status | Os valores possíveis de status do pacote são: active: o usuário pode usar esse pacote para publicar. Quando ele fizer a publicação, uma available_listing será descontada. pending: o pacote ainda não está ativo. finished: pacote expirado. |
| date_created | Data de criação do pacote. |
| date_start | Data de ativação do pacote. |
| date_expires | Data de expiração do pacote. |
| date_stopped | Data de finalização do pacote. |
| last_updated | Última atualização do pacote. |
| engagement_type | Os valores possíveis são: “nenhum”: o pacote foi contratado apenas por uma vez. “recontratação”: quando o pacote expirar, um package_type similar será automaticamente recontratado. |
| charge_id | ID exclusivo da cobrança gerada durante a contratação do pacote. |
| listing_details | Informação detalhada sobre tipos de publicações e disponibilidade |
| listing_type_id | listing_type associado ao pacote. |
| available_listings | Quantidade de publicações obtidas pelo usuário com o pacote. |
| used_listings | Publicações já enviadas. |
| remaining_listings | Publicações restantes disponíveis. |
Conferir se um usuário tem um listing_type específico disponível
Esta é uma maneira mais rápida para saber se o usuário possui um listing_type específico.
Chamada:
curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/users/{user_id}/classifieds_promotion_packs/silverExemplo:
curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/users/135146148/classifieds_promotion_packs/silverRealizar o upgrade de um anúncio (destacar)
Para destacar um anúncio, você deverá realizar a postagem abaixo. Lembre que, para poder realizar esta ação, o usuário deve ter contratado previamente um pacote destaque.
Chamada:
POST https://api.mercadolibre.com/items/{item_id}/listing_typeExemplo:
curl -X POST -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/items/MLA111111111/listing_type -d '{"id":"gold_premium"}'No exemplo acima, o anúncio está fazendo o upgrade para o listing type = gold_premium (diamante). Lembre-se também que não é gerado nenhum tipo de cobrança ao realizar esta chamada, e que caso o upgrade seja desfeito, a quota de destaque volta a ficar disponível. Também não é possível destacar uma publicação sem a contratação de pelo menos um pacote de destaques.
Tempo de validade da publicação
Há um tempo de ciclo de vida máximo para o item. Ou seja, para que um item seja publicado, ele dependerá de duas condições principais:
- Que tenha uma cota ativa do pacote de publicação correspondente;
- Que está dentro do ciclo de vida esperado.
Para carros para venda e motocicletas para venda, o API finalizará o item após xx dias da publicação, aplicando a regra do ciclo mostrada na tabela acima.
Significado dos parâmetros de tempo de ciclo de vida do item para carros e motocicletas:
start_time: A API define no momento de criar o item.
stop_time: A API define no momento de criar o item seguindo a categoria.
expiration_time: A API define no momento de criar o item de acordo com a duração do pacote de promoção (pacote de publicação ativa que você tem).
Quando o item atingir o stop_time, a API encerrará o item, o status do item mudará de active para closed com o sub status expired.
Quando o pacote está ativo e o item é descartado por closed/sub_status: expired, pode ser porque o ciclo de vida do item chegou ao fim. O integrador pode verificar o start_time do item para confirmar isto ou não.
Exemplo:
Um carro para venda (categoría MLC157522) que foi publicado com:
start_time: 2022-01-01T00:06:15.000Z
stop_time: 01/06/2022T00:06:15.000Z
expiration_time: 2022-02-01T00:06:15.000Z (vencimiento do pacote de publicações mensais)
Foi publicado em 01/01/2022 e permanecerá ativo enquanto o pacote de publicação estiver ativo e dentro do ciclo de vida (ciclo de vida de 180 dias por ser uma venda). Em 01/06/2022, o item será encerrado.
Regras para renovação automática de pacotes com recontratação automática
Os pacotes realizam uma série de validações para renovar um pacote engagement-type "re-engagement":
- O pacote não deve estar pausado.
- O usuário deve estar habilitado para publicar (verificar status.list.allow=true).
- O usuário não deve ter dívidas (verificar se em status.list.codes e status.list.immediate_payment.reasons está definido como "has_debt").
Como cancelar a renovação automática de destaques?
Esse cancelamento no momento não é realizado via API. O usuário vendedor/loja deverá ir até a sua conta do Mercado Livre > Depois clicar na seção Resumo. Em seguida, desmarcar a opção de renovação do pacote, confirmar e pronto.
Próxima: Publicação de automóveis.