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 25/03/2024

Permite baixar as faturas legais do Mercado Livre e Mercado Pago em formato PDF para todos os sites.

Notas:
- O file_id se obtêm consumindo o endpoint de Documents.Em alguns casos, o endpoint de Documents pode devolver dois file_id. Nestes casos sempre se deverá utilizar o file_id correspondente ao PDF.

- Se o endpoint de Document devolve um único file_id. Então esse é o dado para o download do documento legal.

Chamada:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/billing/integration/legal_document/{file_id}

Exemplo:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/billing/integration/legal_document/1234_FE_MEPF00869625_pdf

Resposta: download do arquivo em formato PDF.



Download do relatório de conciliação

Para fazer o download dos relatórios de conciliação do Mercado Livre, Mercado Envios Flex, Insurtech e Mercado Pago nos formatos XLSX e CSV você deve seguir um processo de gerar o relatório. Esse mesmo processo servirá para o relatório de Fulfillment e para o relatório de pagamentos, que admitem apenas o formato de download XLSX.
O processo de gerar o relatório consiste en três passos: primeiro irá gerar o relatório de conciliação, em seguida, deverá consultar o estado de geração do relatório até que esteja gerado e por fim, poderá proceder com o download.



1. Criação do relatório

Através deste endpoint irá realizar a criação do relatório.

Chamada para os sites MLM:

curl -X POST -H 'Authorization: Bearer $ACCESS_TOKEN' -H "Content-Type: application/json" -d {...}
  https://api.mercadolibre.com/billing/integration/periods/$EXPIRATION_DATE/reports

Chamada para os sites MLA, MLB, MCO, MLC, MLU, MPE, MLV e MCR:

curl -X POST -H 'Authorization: Bearer $ACCESS_TOKEN' -H "Content-Type: application/json" -d {...} https://api.mercadolibre.com/billing/integration/periods/key/$key/reports

Exemplo para os sites MLA, MLB, MCO, MLC, MLU, MPE, MLV e MCR

curl -X POST -H 'Authorization: Bearer $ACCESS_TOKEN'
  -d '{
     "group": "ML",
     "document_type": "BILL",
     "report_format": "CSV"
  }' 
  https://api.mercadolibre.com/billing/integration/periods/key/2021-08 -01/reports

O valor do parâmetro group varia segundo o relatório que queira gerar:

  • ML para relatório de ML
  • MP para relatório de MP
  • FLEX para relatório de Flex
  • FULL para relatório de Fulfillment
  • INSURTECH para relatório de Insurtech
  • PAYMENT para relatório de pagamentos

Resposta:

{
  "fileId": "ML-report-BILL-2021-08-04-11119999-CSV-v2"
  }

2. Estado de criação de relatório

Permitirá obter o estado de criação de um relatório.Os estados podem ser:

  • PROCESSING: o relatório está sendo gerado.
  • READY: o relatório terminou de ser criado.
  • ERROR: a criação do relatório falhou, deverá ser consultado novamente.

Chamada:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/billing/integration/reports/{file_i d}/status

Exemplo:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/billing/integration/reports/ML-repo rt-BILL-2021-08-04-11119999-CSV-v2/status?document_type=BILL

Resposta:

{
"status": "PROCESSING"
}

3. Download do relatório

Com este endpoint poderá realizar o download do relatório. Este download poderá ser feito uma vez que o estado da criação seja Ready.


Chamada:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/billing/integration/reports/{file_id}

Exemplo:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/billing/integration/reports/ML-repo rt-BILL-2021-08-04-11119999-CSV-v2?document_type=BILL