Documentação do Mercado Livre
Confira todas as informações necessárias sobre as APIs Mercado Livre.
Documentação do
Status de pedidos e rastreamento
A nova ferramenta de status de pedidos ME1 tem o objetivo de melhorar a experiência dos compradores no acompanhamento da entrega de seus pedidos. Neste recurso, será possível informar quando o produto foi enviado, se houve sucesso na entrega ou não além do número de rastreamento (tracking number).
Status e substatus de envio
As junções das informações do campo status e sub-status de envio determinam o que será notificado ao comprador. Agora é possível enviar a informação de pedido despachado (shipped) ou insucesso de entrega (not_delivered):
| Estado | Subestado | Descripción |
|---|---|---|
| shipped | null | Enviado |
| shipped | out_for_delivery | Saiu para entrega ao comprador |
| shipped | receiver_absent | Entrega sem sucesso por comprador ausente |
| shipped | dangerous_area | Entrega sem sucesso por região perigosa |
| shipped | bad_address | Entrega sem sucesso por endereço incorreto |
| shipped | unauthorized_receiver | Entrega sem sucesso por pessoa não autorizada para receber |
| not_delivered | returning_to_sender | Não entregue - Em devolução ao vendedor |
| delivered | null | Entregue ao comprador |
Atualizar o status de um envio ME1
Para atualizar o status do envio, é necessário que conheça o shipment_id do pedido. Para obter esta informação, busque no recurso de order.
Chamada:
curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/orders/$ORDER_ID/shipments
Exemplo:
curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/orders/2339711980/shipments
Resposta:
{
"id": 28264263908,
"mode": "me1",
"created_by": "receiver",
"order_id": 2339711980,
"order_cost": 99.9,
"base_cost": 22.07,
"site_id": "MLB",
"status": "pending",
"substatus": null,
...
}
Marcar pedido como despachado
Para marcar o pedido como despachado, é necessário informar o status como "shipped" e o substatus como "null". Isso é definido quando a transportadora coletou o pacote do vendedor.
Chamada:
curl -X POST -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/shipments/$SHIPMENT_ID/seller_notifications
Exemplo:
curl -X POST -H 'Authorization: Bearer $ACCESS_TOKEN' -H 'Content-Type: application/json' \
{
"payload": {
"service_id": 154,
"comment": "despachado",
"date": "2023-01-16T13:03:51.175-04:00"
},
"tracking_number": "OP123456789AR",
"tracking_url": "http://www.url.test/40886674732",
"status": "shipped",
"substatus": "null"
}
https://api.mercadolibre.com/shipments/28264263908/seller_notifications
Marcar pedido como saiu para entrega
A transportadora iniciou o trajeto até o comprador e tentará realizar a entrega hoje. A previsão de entrega é atualizada automaticamente para "Chega hoje". Outros eventos de falha na entrega podem ocorrer (por exemplo, comprador ausente, endereço incorreto, etc.). Para notificar esta atualização, utilize o status "shipped" com o substatus "out_for_delivery".
Chamada:
curl -X POST -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/shipments/$SHIPMENT_ID/seller_notifications
Exemplo:
curl -X POST -H 'Authorization: Bearer $ACCESS_TOKEN' -H 'Content-Type: application/json' \
{
"payload": {
"service_id": 154,
"comment": "saiu para entrega",
"date": "2023-01-16T13:03:51.175-04:00"
},
"tracking_number": "OP123456789AR",
"tracking_url": "http://www.url.test/40886674732",
"status": "shipped",
"substatus": "out_for_delivery"
}
https://api.mercadolibre.com/shipments/28264263908/seller_notifications
Marcar pedido como não entregue
O status "not_delivered" é um status finalizador e irreversível. Só deve ser utilizado quando não houver mais tentativas de entrega. Dessa forma o vendedor tem que alinhar o fluxo para que seja feita a devolução do dinheiro do comprador.
Para marcar o pedido como não entregue, é necessário informar o status como "not_delivered" e o substatus como "returning_to_sender".
Chamada:
curl -X POST -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/shipments/$SHIPMENT_ID/seller_notificationsExemplo:
curl -X POST -H 'Authorization: Bearer $ACCESS_TOKEN' -H 'Content-Type: application/json' \
{
"payload":{
"comment":"Não entregue",
"date":"2020-03-05T16:17:51.175-04:00"
},
"status":"not_delivered",
"substatus":"returning_to_sender"
}
https://api.mercadolibre.com/shipments/28264263908/seller_notifications
Marcar pedido como entregue
Ao receber a informação de que o produto foi entregue ao comprador, é necessário fazer a alteração do status da compra para entregue. Para isso utilize o status "delivered" com o substatus "null".
Este status também é finalizador e irreversível.
Chamada:
curl -X POST -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/shipments/$SHIPMENT_ID/seller_notifications
Exemplo:
curl -X POST -H 'Authorization: Bearer $ACCESS_TOKEN' -H 'Content-Type: application/json' \
{
"payload":{
"comment":"Pedido entregue",
"date":"2020-03-06T16:17:51.175-04:00"
},
"status":"delivered",
"substatus":"null"
}
https://api.mercadolibre.com/shipments/28264263908/seller_notifications
Marcar entrega sem suceso por comprador ausente
O comprador não se encontra em seu domicílio residencial ou não atende ao interfone no momento da visita.
Possíveis soluções:
- O comprador e o vendedor devem coordenar como resolver a entrega ou cancelar a compra.
- Se as tentativas de entrega foram esgotadas, a transportadora ou o vendedor deve marcar como Não entregue. Somente então o Mercado Livre reembolsará o comprador e o vendedor deverá gerenciar a devolução com sua transportadora.
Chamada:
curl -X POST -H 'Authorization: Bearer $ACCESS_TOKEN'
https://api.mercadolibre.com/shipments/$SHIPMENT_ID/seller_notifications
Exemplo:
curl -X POST -H 'Authorization: Bearer $ACCESS_TOKEN' -H 'Content-Type: application/json' \
{
"payload":{
"comment":"Comprador não se encontra no domicílio",
"date":"2020-03-06T16:17:51.175-04:00"
},
"status":"shipped",
"substatus":"receiver_absent"
}
https://api.mercadolibre.com/shipments/28264263908/seller_notifications
Marcar entrega sem sucesso por região perigosa
A transportadora saiu para distribuição com destino ao comprador, mas a zona onde se encontra o domicílio é perigosa e se decide não ir. Também pode se aplicar em um planejamento antes de sair para o destino.
Possíveis soluções:
- O comprador e o vendedor devem coordenar como resolver a entrega ou cancelar a compra.
- Se as tentativas de entrega foram esgotadas, a transportadora ou o vendedor deve marcar como Não entregue. Somente então o Mercado Livre reembolsará o comprador e o vendedor deverá gerenciar a devolução com sua transportadora.
Chamada:
curl -X POST -H 'Authorization: Bearer $ACCESS_TOKEN'
https://api.mercadolibre.com/shipments/$SHIPMENT_ID/seller_notifications
Exemplo:
curl -X POST -H 'Authorization: Bearer $ACCESS_TOKEN' -H 'Content-Type: application/json' \
{
"payload":{
"comment":"Região da entrega identificada como zona de risco",
"date":"2020-03-06T16:17:51.175-04:00"
},
"status":"shipped",
"substatus":"dangerous_area"
}
https://api.mercadolibre.com/shipments/28264263908/seller_notifications
Marcar entrega sem sucesso por endereço incorreto
A transportadora não encontrou o endereço de entrega no momento da visita. Se as tentativas de entrega foram esgotadas, o Mercado Livre reembolsará o comprador e o vendedor deverá gerenciar a devolução com sua transportadora.
Possíveis soluções:
- O comprador e o vendedor devem coordenar como resolver a entrega ou cancelar a compra.
- Se as tentativas de entrega foram esgotadas, a transportadora ou o vendedor deve marcar como Não entregue. Somente então o Mercado Livre reembolsará o comprador e o vendedor deverá gerenciar a devolução com sua transportadora.
Chamada:
curl -X POST -H 'Authorization: Bearer $ACCESS_TOKEN'
https://api.mercadolibre.com/shipments/$SHIPMENT_ID/seller_notifications
Exemplo:
curl -X POST -H 'Authorization: Bearer $ACCESS_TOKEN' -H 'Content-Type: application/json' \
{
"payload":{
"comment":"O endereço de entrega não foi encontrado",
"date":"2020-03-06T16:17:51.175-04:00"
},
"status":"shipped",
"substatus":"bad_address"
}
https://api.mercadolibre.com/shipments/28264263908/seller_notifications
Marcar entrega sem sucesso por pessoa não autorizada para receber o produto
O titular da compra não se encontra e a pessoa que atende no endereço de entrega não está autorizada a receber em seu lugar.
Possíveis soluções:
- O comprador e o vendedor devem coordenar como resolver a entrega ou cancelar a compra.
- Se as tentativas de entrega foram esgotadas, a transportadora ou o vendedor deve marcar como Não entregue. Somente então o Mercado Livre reembolsará o comprador e o vendedor deverá gerenciar a devolução com sua transportadora.
Chamada:
curl -X POST -H 'Authorization: Bearer $ACCESS_TOKEN'
https://api.mercadolibre.com/shipments/$SHIPMENT_ID/seller_notifications
Exemplo:
curl -X POST -H 'Authorization: Bearer $ACCESS_TOKEN' -H 'Content-Type: application/json' \
{
"payload":{
"comment":"O titular da compra não se encontra e não há uma pessoa autorizada para receber a entrega",
"date":"2020-03-06T16:17:51.175-04:00"
},
"status":"shipped",
"substatus":"unauthorized_receiver"
}
https://api.mercadolibre.com/shipments/28264263908/seller_notifications
Próximo: Frete dinâmico.