Documentação do Mercado Livre
Confira todas as informações necessárias sobre as APIs Mercado Livre.
Documentação do
Última atualização em 25/04/2024
Detalhe de conciliação
.Filtros opcionais
- order_by: permite ordenar a busca.
asc: ordena os resultados de forma ascendente (valor por default).
desc: ordena os resultados de forma descendente.
Ex: order_by=asc
- sort_by: permite selecionar por que campo ordenar. Valores possíveis: DATE.
- detail_typepermite buscar por tipos de detalhes.
charge: traz somente cobranças.
bonus: traz somente bonificações.
Ex: detail_type=charge.
- detail_sub_types: permite buscar por tipos de detalhes.
Se pueden definir varios separados por comas. Se pueden definir varios separados por coma.
Ex: detail_sub_types=CV, BV
- detail_excluded_sub_types: permite excluir da busca os subtipos de detalhes indicados. Podem ser definidos vários separados por vírgula.
Ex: not_subtypes=CXD, BXD
- marketplace_type: permite buscar pelo market do detalhe.
Ex: marketplace_type=SHIPPING
- order_ids: permite buscar por um ou vários ID de order. Disponível para Mercado Libre.
Ex: order_ids=2294412230
- item_ids: permite buscar por um ou mais IDs de publicação.
Ex: item_ids=724159812
- document_ids: permite buscar por um ou mais IDs de fatura.
Ex: document_ids=987046992
- detail_ids: permite buscar por um ou mais IDs de detalhe.
Ex: detail_ids=724159812
- offset: permite buscar desde um número de resultado em diante. O valor mínimo permitido é 0 e o valor máximo permitido é 10000. Por padrão o valor é 0. Ex: offset=100 (devolve a partir do resultado nro 100).
- limit: limita a quantidade de resultados. Por padrão o mínimo é 1 e o máximo valor permitido: 1000.
Ex: limit=300 (devolve até 300 resultados).
Mercado Livre
Poderá ver os valores faturados, informação de venda, descontos, envios e a publicação.
Chamada:
curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN'
https://api.mercadolibre.com/billing/integration/periods/key/$key/group/ML/detailsExemplo:
curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN'
https://api.mercadolibre.com/billing/integration/periods/key/2021-06-012/group/ML/details?document_type=BILL&limit=1Resposta:
{
"offset": 0,
"limit": 150,
"total": 1,
"results": [
{
"charge_info": {
"legal_document_number": "0001A00123456",
"legal_document_status": "PROCESSED",
"legal_document_status_description": "Procesado",
"creation_date_time": "2021-05-13T08:08:24",
"detail_id": 123456789,
"detail_amount": 342.49,
"transaction_detail": "Cargo por Mercado Envíos",
"debited_from_operation": "YES",
"debited_from_operation_description": "Si",
"status": null,
"status_description": null,
"charge_bonified_id": null,
"detail_type": "CHARGE",
"detail_sub_type": "CXD",
"concept_type": "SHIPPING"
},
"discount_info": {
"charge_amount_without_discount": 684.99,
"discount_amount": 342.5,
"discount_reason": "Descuento general"
},
"sales_info": [
{
"order_id": 12345,
"operation_id": null,
"sale_date_time": "2021-05-13T08:05:10",
"sales_channel": "Mercado Libre",
"payer_nickname": "ABCD",
"state_name": "Neuquén",
"transaction_amount": 2499
},
],
"shipping_info": {
"shipping_id": "123456789",
"pack_id": "200000123456789",
"receiver_shipping_cost": 0
},
"items_info": [
{
"item_id": "MLA987654321",
"item_title": "Fabrica Magdalenas Cup Cake Maker Atma Cm8910e",
"item_type": "gold_special",
"item_type_description": "Clásica",
"item_category": "Electrodomésticos y Aires Ac. > Pequeños Electrodomésticos > Para Cocina > Máquinas para Postres > Máquinas de Cupcakes",
"inventory_id": null,
"item_amount": 1,
"item_price": 2499,
"order_id": 1234
}
],
"document_info": {
"document_id": 1615633359
},
"marketplace_info": {
"marketplace": "SHIPPING"
},
"currency_info": {
"currency_id": "ARS"
}
}
],
errors:[]
}Campos de resposta Mercado Livre
- charge_info: informação da cobrança.
- legal_document_number: número do documento.
- legal_document_status: estado de criação do documento. Valores possíveis: PROCESSING | PROCESSED.
- legal_document_status_description: descrição internacionalizada do estado do documento legal_document_status.
- creation_date_time: data de criação da cobrança.
- detail_id: identificador da cobrança.
- transaction_detail: detalhe da cobrança.
- debited_from_operation: indica se está descontado da operação. Valores possíveis: YES | NO | INAPPLICABLE.
- debited_from_operation_description: descrição internacionalizada do campo debited_from_operation.
- status: estado da cobrança. Valores possíveis: BONUS_ON_CREDIT_NOTE | BONUS_PART_ON_CREDIT_NOTE | BONUS_ON_BILL | BONUS_PART_ON_BILL | BONUS_ON | BONUS_PART_ON.
- status_description: descrição internacionalizada de status.
- charge_bonified_id: identificador da cobrança que bonifica.
- detail_amount: valor da cobrança.
- detail_type: tipo de detalhe.
- detail_sub_type: subtipos de detalhes.
- discount_info: informação sobre descontos.
- charge_amount_without_discount: valor da cobrança sem desconto.
- discount_amount: valor do desconto.
- discount_reason: motivo do desconto.
- sales_info: informação de vendas.
- sale_info: informação sobre a venda.
- order_id: identificador da venda.
- operation_id: identificador do pagamento.
- sale_date_time: data e hora da venda.
- sales_channel: canal de venda.
- payer_nickname: cliente.
- state_name: estado.
- transaction_amount: valor total da venda.
- shipping_info: informação do envio.
- shipping_id: identificador do envio.
- pack_id: identificador do pacote.
- receiver_shipping_cost: envio a cobrança do cliente.
- items_info: informação sobre publicações.
- item_id: identificador da publicação.
- item_title: título da publicação.
- item_type: tipo de publicação.
- item_category: categoria da publicação.
- inventory_id: código de Mercado Livre.
- item_amount: quantidade de itens vendidos.
- item_price: preço unitário de item.
- order_id: ordem à qual o item pertence.
- documentInfo: informação do documento.
- document_id: número Id de documentos.
- marketplaceInfo: informação do marketplace.
- marketplace: nome do marketplace.
- currency_info: informação da moeda de acordo ao site_id.
- currency_id: identificador da moeda de acordo ao site_id.
Mercado Pago
Poderá ver o detalhe de custos faturados, com informação complementar sobre a operação do Mercado Pago, como os movimentos, meios de pagamento, payer, filial, ponto de venda, entre outros.
Chamada:
curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN'
https://api.mercadolibre.com/billing/integration/periods/key/$key/group/MP/detailsExemplo:
curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN'
https://api.mercadolibre.com/billing/integration/periods/key/2021-06-01/group/MP/details?document_type=BILL&limit=1Resposta:
{
"offset": 0,
"limit": 1,
"total": 9,
"results": [
{
"charge_info": {
"legal_document_number": null,
"legal_document_status": "PROCESSING",
"legal_document_status_description": "En proceso",
"concept_id": "12345678",
"transaction_detail": "Cargo de MercadoPago",
"creation_date_time": "2021-06-01T17:45:39",
"detail_amount": 13.8,
"detail_type": "CHARGE",
"detail_sub_type": "CCMP"
},
"operation_info": {
"operation_type": "BUY",
"operation_type_description": "Pago",
"reference_id": 12345678,
"sales_channel": "Point",
"store_id": 2222222,
"store_name": "Store",
"external_reference": "Venta presencial",
"payer_nickname": "TEST",
"transaction_amount": 340
},
"perception_info": {
"aliquot": null,
"taxable_amount": null
},
"document_info": {
"document_id": 8888899999,
},
"market_type_info": {
"marketplace": "MP"
},
"currency_info": {
"currency_id": "MXN"
}
}
]
}Campos de resposta Mercado Pago
- charge_info: informação da cobrança.
- legal_document_number: número do documento.
- detail_id: identificador da cobrança.
- movement_id: número de movimento.
- transaction_detail: detalhe.
- creation_date_time: data da cobrança.
- detail_amount: valor da cobrança.
- detail_type: tipo de detalhe.
- detail_sub_type: subtipos de detalhes.
- operation_info: informação de operação sobre a que se aplica.
- operation_type: tipo de operação. Valores possíveis BUY | TAX.
- operation_type_description: descrição internacionalizada do campo operation.
- reference_id: número de operação relacionada.
- sales_channel: tipo de pagamento.
- store_id: número de filial/loja.
- store_name: nome da filial/loja.
- external_reference: número de referência externa.
- payer_nickname: cliente.
- transation_amount: valor da operação.
- perception_info: informação da percepção.
- aliquot: valor da alíquota.
- taxable_amount: base tributável.
- documentInfo: informação do documento.
- document_id: número Id de documentos.
- marketplaceInfo: informação do marketplace.
- nome do marketplace.
- currency_info: informação da moeda de acordo ao site_id.
- currency_id: identificador da moeda de acordo ao site_id.
Mercado Envios Flex
Poderá ver o detalhe para conciliar as bonificações e anulamentos de Flex, para um período em particular, o grupo de faturamento Mercado Livre e o tipo de documento (nota de débito ou nota de crédito). Além disso, terá informações sobre o envio e sobre a venda.
Chamada:
curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN'
https://api.mercadolibre.com/billing/integration/periods/key/$key/group/ML/flex/detailsExemplo:
curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN'
https://api.mercadolibre.com/billing/integration/periods/key/2023-03-012/group/ML/flex/details?document_type=BILL&limit=1Resposta:
{
"offset": 0,
"limit": 1,
"total": 100,
"results": [{
"charge_info": {
"legal_document_number": "00AA11AA00",
"legal_document_status": "PROCESSED",
"legal_document_status_description": "Procesado",
"creation_date_time": "2023-02-21T12:35:58",
"detail_id": 2020202020,
"detail_associated_id": 4040404040,
"detail_amount": 163,
"transaction_detail": "Anulación de bonificación por Mercado Envíos Flex",
"detail_type": "CHARGE",
"detail_sub_type": "CFLX",
"concept_type": "FLEX"
},
"shipping_info": {
"shipping_id": 4444455555,
"receiver_nickname": "NICKNAME",
"pack_id": "12345678",
"receiver_shipping_cost": 814.99,
"order": {
"order_id": 9000000008888888,
"date_created": "2023-02-15T11:54:51",
"total_amount": 29499,
"payment_id": 998899889988,
"buyer_nickname": "NICKNAME"
}
},
"document_info": {
"document_id": 776677667711
}
}],
"errors": []
}Campos de resposta Mercado Envios Flex
- charge_info: informações de cobrança.
- legal_document_number: número do documento.
- legal_document_status: estado de geração do documento. Possíveis valores: PROCESSING | PROCESSED
- legal_document_status_description: descrição internacionalizada do estado do documento legal_document_status.
- creation_date_time: data de criação da cobrança.
- detail_id: identificador da cobrança.
- detail_associated_id: Identificador da cobrança associada (em caso de cancelamento de bonificação).
- detail_amount: valor da cobrança.
- transaction_detail: detalhe da cobrança.
- detail_type: tipo de detalhe.
- detail_sub_type: subtipos de detalhes.
- concept_type: tipo de conceito.
- shipping_info: informação sobre envio.
- shipping_id: identificador do envio.
- receiver_nickname: cliente.
- pack_id: número do pacote.
- receiver_shipping_cost: custo do envio.
- order: informação da venda.
- order_id: identificador da venda.
- date_created: data da order.
- totalAmount: valor total da order.
- paymentId: identificador de pagamento.
- buyerNickname: cliente.
- document_info: informação do documento.
- document_id: ID do documento.
Fulfillment
Poderá ver os custos e as bonificações por coleta e/ou armazenamento para um período particular, o grupo de faturamento Mercado Livre e o tipo de documento (fatura ou nota de crédito). Também terá informações do producto armazenado e recoletado. Os tipos de custo para o reporte de Fullfilment poder ser por: retirada de estoque, armazenamento prolongado, serviço de coleta, descumprimento, armazenamento.
Chamada:
curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN'
https://api.mercadolibre.com/billing/integration/periods/key/$key/group/ML/full/detailsExemplo:
curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN'
https://api.mercadolibre.com/billing/integration/periods/key/2023-03-01/group/ML/full/details?document_type=BILL&limit=1Resposta:
{
"offset": 0,
"limit": 100,
"total": 634,
"results": [{
"charge_info": {
"legal_document_number": "000AAA00000000",
"legal_document_status": "PROCESSED",
"legal_document_status_description": "Procesado",
"creation_date_time": "2021-07-23T16:37:58",
"detail_id": 11111111111,
"detail_amount": 2.54,
"transaction_detail": "Cargo por servicio de colecta Full",
"charge_bonified_id": null,
"detail_type": "CHARGE",
"detail_sub_type": "CFCB",
"concept_type": "FULFILLMENT",
"payment_id": 222222222
},
"fulfillment_info": {
"type": "INBOUND_COLLECT",
"amount_per_unit": 2.54,
"amount": 2.54,
"sku": "3125404000009",
"ean": "3125404000009",
"item_id": "MLM788740252",
"item_title": "VESTIDO CORTO AZUL MARINO BORDADO EN PECHO DEVENDI",
"variation": "AZUL MARINO | EG",
"quantity": 1,
"volume_type": null,
"inventory_id": "LLLGGKK12",
"inbound_id": 555555,
"volume_unit": "m3",
"amount_per_volume_unit": 500,
"volume": 0.00507,
"volume_total": 0.00507
},
"document_info": {
"document_id": 333333333
}
}],
"errors": []
}Campos de resposta Mercado Envios Fulfillment
- charge_info: informação da cobrança.
- legal_document_number: número do documento.
- legal_document_status: estado de geração do documento. Possíveis valores: PROCESSING, PROCESSED
- creation_date_time: data de criação da cobrança.
- detail_id: identificador da cobrança.
- detail_amount: valor da cobrança.
- transaction_detail: detalhe da cobrança.
- charge_bonified_id: identificador da cobrança que bonifica.
- detail_type: tipo de detalhe.
- detail_sub_type: subtipos de detalhe.
- concept_type: tipo de conceito.
- payment_id: identificador do pagamento.
- fulfillment_info: Informação de fulfillment.
- type: tipo de fulfillment. Possíveis valores: WITHDRAWAL | AGING | INBOUND_COLLECT | INBOUND_PENALTY | WAREHOUSING
- amount_per_unit: valor por unidade.
- amount: total.
- sku: stock-keeping-unit.
- item_id: número da publicação.
- item_title: titulo da publicação.
- variation: variável do produto.
- quantity: unidades armazenadas ou recoletadas.
- volume_type: tamanho da unidade.
- inventory_id: código do inventário do Mercado Livre.
- withdrawal_id: número de retirada –TYPE WITHDRAWAL custo por retirada de estoque –
- shipment_type: forma de retirada. –TYPE WITHDRAWAL custo por retirada de estoque –
- volume_unit: unidade de medida (m3). –TYPE WITHDRAWAL custo por retirada de estoque –
- amount_per_volume_unit: valor por m3. –TYPE WITHDRAWAL custo por retirada de estoque –
- volume: volume unitário (cm3) –TYPE WITHDRAWAL custo por retirada de estoque–
- volume_total: volume total. –TYPE WITHDRAWAL custo por retirada de estoque –
- months_range: antiguidade em meses. –TYPE AGING custo por armazenamento prolongado –
- stock_details: detalhes de estoque. –TYPE AGING custo por armazenamento prolongado –
- quantity: quantidade em estoque. –TYPE AGING custo por armazenamento prolongado–
- inventory_status: estado do inventário. –TYPE AGING custo por armazenamento prolongado –
- inbound_id: número de envio. –TYPE INBOUND_COLLECT custo por serviço de coleta –
- volume_unit: unidade de medida (m3) –TYPE INBOUND_COLLECT custo por serviço de coleta –
- amount_per_volume_unit: valor por m3. –TYPE INBOUND_COLLECT custo por serviço de coleta –
- volume: volume unitário (cm3) –TYPE INBOUND_COLLECT custo por serviço de coleta –
- volume_total: volume total. –TYPE INBOUND_COLLECT custo por serviço de coleta–
- inbound_id: número de envio. –TYPE INBOUND_PENALTY custo por não cumprimento -
- penalty_type: tipo de não cumprimento. –TYPE INBOUND_PENALTY custo por não cumprimento –
- warehouse_id: identificador de warehouse.–TYPE WAREHOUSING custo por não cumprimento –
- size: tamanho da unidade.–TYPE WAREHOUSING custo por armazenamento–
- item_quantity: unidades armazenadas.–TYPE WAREHOUSING custo por armazenamento–
- idocument_info: informação do documento.
- document_id: ID do documento.
Insurtech
Poderá ver o detalhe para conciliar os custos e bonificações das garantias aplicadas sobre o produto para um período particular, o grupo de faturamento Mercado Livre e o tipo de documento (Fatura ou nota de crédito).
Chamada:
curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN'
https://api.mercadolibre.com/billing/integration/periods/key/$KEY/group/ML/insurtech/detailsExemplo:
curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN'
https://api.mercadolibre.com/billing/integration/periods/key/2022-10-01/group/ML/insurtech/details?document_type=BILL&limit=1Resposta:
{
"offset": 0,
"limit": 150,
"total": 1,
"results": [
{
"charge_info": {
"legal_document_number": "001112131415",
"legal_document_status": "PROCESSED",
"legal_document_status_description": "Procesado",
"creation_date_time": "2022-10-04T22:24:18",
"detail_id": 123456,
"detail_amount": 520.01,
"transaction_detail": "Cargo por seguro de garantía extendida",
"status": null,
"status_description": null,
"charge_bonified_id": null,
"detail_type": "CHARGE",
"detail_sub_type": "CEW",
"concept_type": "WARRANTY"
},
"warranty_info": {
"warranty_id": "11111111-43c2-44ea-8436-00000000",
"certificate_id": "MLA999999",
"warranty_product": "GAREX",
"buyer_nickname": "TEST",
"buyer_state_name": "Salta",
"order": {
"order_id": 102030405060,
"order_items": [
{
"unit_price": 10791,
"listing_type_id": "gold_special",
"item": {
"item_id": "MLA88888888",
"title": "Auriculares Inalámbricos Jbl Tune 510bt Negro",
"category_id": "MLA1234",
"category_name": "Auriculares"
}
}
]
},
"quote_model": null,
"quote_brand": null,
"quote_description": ""
},
"prepaid_info": {
"operation_id": 55558888,
"movement_id": 123456789,
"doc_id": 11111111111,
"payment": {
"payment_id": 5555555555,
"date_created": "2022-10-04T22:23:40",
"transaction_amount": 736.98,
"money_release_date": "2023-03-03T22:23:41"
}
},
"document_info": {
"document_id": 3333333333
}
}
]Campos de resposta Insurtech
- charge_info: informação da cobrança. <
- legal_document_number: número do documento.
- legal_document_status: estado de geração do documento. Valores possiveís: PROCESSING | PROCESSED.
- legal_document_status_description: descrição internacionalizada do estado do documento legal_document_status.
- creation_date_time: data de criação da cobrança.
- detail_id: identificador da cobrança.
- detail_amount: valor da cobrança.
- transaction_detail: detalhe da cobrança.
- status: estado da cobrança. Valores possíveis: BONUS_ON_CREDIT_NOTE | BONUS_PART_ON_CREDIT_NOTE | BONUS_ON_BILL | BONUS_PART_ON_BILL | BONUS_ON | BONUS_PART_ON.
- status_description: descrição internacionalizada de status.
- charge_bonified_id: identificador da cobrança bonificada.
- detail_type: tipo de detalhe.
- detail_sub_type: subtipos de detalhes.
- concept_type: ipo de conceito.
- wanrranty_info: informação da garantia.
- wanrranty_id: identificador da garantia.
- certificate_id: identificador do certificado.
- waranty_product: tipo de garantia. Valores possíveís: CARDS, GAREX, RODA.
- buyer_nickname: numero do comprador.
- buyer_state_name: província do comprador.
- order: informação da venda.
- order_items: lista de items da venda.
- unit_price: preço por unidade.
- listing_type_id: tipo de publicação.
- item: informação do item.
- item_id: identificador do produto.
- tittle: titulo do produto.
- category_id: identificador da categoria.
- category_name: nome da categoria.
- quote_model: modelo do produto. Aplica a RODA.
- quote_brand: marca do produto. Aplica a RODA.
- quote_description: descrição adicional. Aplica a RODA.
- prepaid_info: informação do pagamento.
- operation_id: identificador da operação.
- movement_id: identificador do pagamento.
- doc_id: identificador do documento.
- payment: informação do pagamento.
- payment_id: identificador do pagamento.
- date_created: data de papamento.
- transaction_amount: valor do pago.
- money_release_date: data de liberação do dinheiro.
- document_info: informação do documento
- document_id: ID do documento.
Seguinte: Pagamentos.