Documentação do Mercado Livre

Confira todas as informações necessárias sobre as APIs Mercado Livre.
circulos azuis em degrade

Documentação do

Última atualização em 02/10/2024

Campanhas com co-participação e campanha de preços competitivos

Importante:
- Estas campanhas estão na mesma documentação porque trabalham com a mesma lógica e os mesmos parâmetros.
- A partir do dia 14 de outubro de 2024, as campanhas de preços competitivos contam com dois tipos: PRICE_MATCHING e PRICE_MATCHING_MELI_ALL (100% por conta do Mercado Livre).
- No caso em que o vendedor desejar excluir sua participação nas campanhas de preços competitivos 100% Mercado Livre (PRICE_MATCHING_MELI_ALL), deverá acessar o Mercado Livre para desativar essa funcionalidade. Para remover itens específicos da campanha, pode-se utilizar o DELETE, assim como em outras campanhas.

Os vendedores são convidados periodicamente a participar de diversas campanhas realizadas no site. No caso das campanhas co-participação automatizadas e de preços competitivos, o Mercado Livre assume um percentual do desconto oferecido.
As campanhas cofinanciadas automatizadas funcionam de maneira semelhante às com co-participação tradicionais, mas utilizam um processo automatizado para selecionar os itens que serão convidados a participar. Em relação às campanhas de preços competitivos, o objetivo é garantir que os produtos atinjam o melhor preço em comparação com outros sites e marketplaces. Os candidatos para essas campanhas são atualizados diariamente, o que significa que um item pode ser elegível hoje, mas não necessariamente amanhã.

A partir de agora, as campanhas de preços competitivos oferecem dois tipos de promoções:

  • PRICE_MATCHING: O desconto é cofinanciado entre o vendedor e o Mercado Livre.
  • PRICE_MATCHING_MELI_ALL: O desconto é 100% financiado pelo Mercado Livre, e a participação do vendedor é gerida automaticamente, sem necessidade de qualquer ação por parte dele.

Essa estrutura proporciona maior flexibilidade na implementação de descontos, adaptando-se às características de cada campanha.



Consultar detalhes da campanha

Nota:
Para estas campanhas as respostas têm os mesmos campos, mudando apenas a informação de "type" (SMART ou PRICE_MATCHING ou PRICE_MATCHING_MELI_ALL).

Para obter os detalhes de uma promoção do tipo Smart, faça a seguinte consulta:

Exemplo de co-participação automatizada:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/seller-promotions/promotions/P-MLB1812010?promotion_type=SMART&app_version=v2

Resposta de co-participação automatizada:

{
  "id": "P-MLB1812010",
  "type": "SMART",
  "status": "started",
  "start_date": "2023-04-26T23:00:00Z",
  "finish_date": "2023-05-10T23:59:00Z",
  "deadline_date": "2023-05-10T23:59:00Z",
  "name": "test-smart-2"
}

Exemplo de preços competitivos co-participação:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/seller-promotions/promotions/P-MLB2087012?promotion_type=PRICE_MATCHING&app_version=v2
  

Resposta de preços competitivos co-participação:

{
   "id": "P-MLB2087012",
   "type": "PRICE_MATCHING",
   "status": "pending",
   "start_date": "2023-09-19T18:15:00Z",
   "finish_date": "2023-10-01T05:59:59Z",
   "deadline_date": "2023-10-01T05:59:59Z",
   "name": "Gánale a la competencia con un aporte de Mercado Libre"
}

Exemplo de preços competitivos 100% Mercado Livre:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/seller-promotions/promotions/P-MLB35280024?promotion_type=PRICE_MATCHING_MELI_ALL&app_version=v2
  

Resposta de preços competitivos 100% Mercado Livre:

{
    "id": "P-MLB3528002",
    "type": "PRICE_MATCHING_MELI_ALL",
    "status": "started",
    "start_date": "2024-09-26T15:20:04Z",
    "finish_date": "2024-10-01T15:18:04Z",
    "deadline_date": "2024-10-01T15:18:04Z",
    "name": "100% a cargo de Mercado Libre"
}

Campos da resposta

  • id: identificador da campanha.
  • type: tipo de campanha (SMART, PRICE_MATCHING ou PRICE_MATCHING_MELI_ALL).
  • status: estado da campanha.
  • start_date: data em que começa a campanha.
  • finish_date: data em que termina a campanha.
  • deadline_date: data limite para criar a campanha.
  • name: nome da campanha.


Estados

Estes são os diferentes estados pelos quais as campanhas com co-participação automatizada e as campanhas de preços competitivos podem passar:

Estado Descripción
pending Promoção aprovada, mas ainda não foi iniciada.
started Promoção ativa.
finished Promoção finalizada.


Consultar itens de uma campanha

Para ver os itens que fazem parte de uma campanha, você pode realizar a seguinte consulta:

Exemplo de co-participação automatizada:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' 'https://api.mercadolibre.com/seller-promotions/promotions/P-MLB1812010/items?promotion_type=SMART&app_version=v2'

Resposta de co-participação automatizada:

{
  "results": [
      {
          "id": "MLB3538191898",
          "status": "candidate",
          "price": 3000,
          "original_price": 5000,
          "offer_id": "CANDIDATE-MLB3538191898-25593903",
          "meli_percentage": 20,
          "seller_percentage": 20,
          "start_date": "2023-04-26T11:40:00Z",
          "end_date": "2023-05-30T15:47:00Z"
      }
  ],
  "paging": {
      "offset": 0,
      "limit": 50,
      "total": 1
  }
}

Exemplo preços competitivo co-participação:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' 'https://api.mercadolibre.com/seller-promotions/P-MLB2087012/items?promotion_type=PRICE_MATCHING&app_version=v2'

Resposta de preços competitivos co-participação:

{
  "results": [
      {
          "id": "MLB4048719074",
          "status": "candidate",
          "price": 3000,
          "original_price": 5000,
          "offer_id": "CANDIDATE-MLB4048719074-70000001705",
          "meli_percentage": 20,
          "seller_percentage": 20,
          "start_date": "2023-09-19T03:00:00Z",
          "end_date": "2023-09-26T02:59:59Z"
      }
  ],
  "paging": {
      "total": 1,
      "limit": 50
  }
}

Exemplo de preços competitivos 100% Mercado Livre:

Nota:
Para este tipo de campanha, não será visualizado um status de candidate, uma vez que o processo de ativar é executado automaticamente pelo Mercado Livre. Quando a campanha é exibida ao vendedor, isso indica que os itens já foram ativados na campanha de forma automática.
curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' 'https://api.mercadolibre.com/seller-promotions//P-MLB3528002/items?promotion_type=PRICE_MATCHING_MELI_ALL&app_version=v2''

Resposta de preços competitivos 100% Mercado Livre:

{
    "results": [
        {
            "id": "MLB3845318745",
            "status": "started",
            "price": 121.5,
            "original_price": 135,
            "offer_id": "OFFER-MLB3845318745-10000115845",
            "meli_percentage": 10,
            "seller_percentage": 0,
            "start_date": "2024-09-26T15:24:35Z",
            "end_date": "2024-09-28T23:59:59Z"
        }
    ],
    "paging": {
        "total": 1,
        "limit": 50
    }
}

Ao criar uma nova campanha do tipo SMART e PRICE_MATCHING, todos os itens elegíveis são selecionados. O estado inicial (status) dos itens é candidate e contam com um offer_id de candidato. No momento em que o vendedor adiciona um item na campanha, seu estado é alterado a started> e o offer_id muda para um id de oferta.



Estado dos-itens

Na tabela a seguir, você encontrará os possíveis estados que um item em campanhas destes tipos podem ter:

Estado Descripción
candidate Item candidato para participar da promoção.
pending Item com promoção aprovada e programada.
started Item ativo na campanha.
finished Item excluído da campanha.


Indicar itens para uma campanha

Nota:
A campanha com co-participação automatizada pode ter uma duração máxima de 30 dias, enquanto a campanha de preços competitivos pode ter até 10 dias.

Após ser convidado a participar destas campanhas, poderá indicar quais produtos quer incluir nas mesmas.

Chamada:

curl -X POST -H 'Authorization: Bearer $ACCESS_TOKEN' \
  -d '{
     "promotion_id":"$PROMOTIONDEAL_ID",
     "promotion_type":"$PROMOTION_TYPE",
     "offer_id":"$OFFER_ID"
  }'
  https://api.mercadolibre.com/seller-promotions/items/$ITEM_ID?app_version=v2

Exemplo de co-participação automatizada:

curl -X POST -H 'Authorization: Bearer $ACCESS_TOKEN' \
  -d '{
    "promotion_id":"P-MLB1812010",
    "promotion_type":"SMART",
    "offer_id":"CANDIDATE-MLB3538191898-25593903"
  }
  '
  https://api.mercadolibre.com/seller-promotions/items/MLB3538191898?app_version=v2

Resposta de co-participação automatizada:

{
  "offer_id": "OFFER-MLB3538191898-177685",
  "price": 3000,
  "original_price": 5000
}

Exemplo de preços competitivos:

curl -X POST -H 'Authorization: Bearer $ACCESS_TOKEN' \
-d '{
   "promotion_id": "P-MLB2087012",
   "offer_id": "CANDIDATE-MLB4048719074-70000001705",
   "promotion_type": "PRICE_MATCHING"
}
'
https://api.mercadolibre.com/seller-promotions/items/MLB4048719074?app_version=v2

Resposta de preços competitivos:

{
  "offer_id": "OFFER-MLB4048719074-10000001972",
  "price": 3000,
  "original_price": 5000
}

Parâmetros

  • promotion_id: identificação da promoção.
  • promotion_type: tipo de promoção (SMART ou PRICE_MATCHING).
  • offer_id: identificação da oferta acordada.

Eliminar campanhas

Chamada:

curl -X DELETE -H 'Authorization: Bearer $ACCESS_TOKEN' 'https://api.mercadolibre.com/seller-promotions/items/$ITEM_ID?promotion_type=$PROMOTION_TYPE&promotiondeal_id=$PROMOTION&offer_id=$OFFER_ID'

Exemplo de co-participação automatizada:

curl -X DELETE -H 'Authorization: Bearer $ACCESS_TOKEN' 'https://api.mercadolibre.com/seller-promotions/items/MLB4048719074?promotion_type=PRICE_MATCHING&promotion_id=P-MLB2087012&offer_id=OFFER-MLB4048719074-10000001972&app_version=v2

Resposta: Status 200 OK

Exemplo de preços competitivos co-participação:

curl -X DELETE -H 'Authorization: Bearer $ACCESS_TOKEN' 'https://api.mercadolibre.com/seller-promotions/items/MLB4048719074?promotion_type=PRICE_MATCHING&promotion_id=P-MLB2087012&offer_id=OFFER-MLB4048719074-10000001972&app_version=v2

Resposta: Status 200 OK

Exemplo de preços competitivos 100% Mercado Livre:

curl -X DELETE -H 'Authorization: Bearer $ACCESS_TOKEN' 'https://api.mercadolibre.com/seller-promotions/items/MLA1387793467?promotion_type=PRICE_MATCHING_MELI_ALL&promotion_id=P-MLA2072013&offer_id=OFFER-MLA1387793467-1000000151&app_version=v2

Resposta: Status 200 OK