Documentação do Mercado Livre
Confira todas as informações necessárias sobre as APIs Mercado Livre.
Documentação
Gestão da capacidade de envio
A gestão de capacidade de envios é uma ferramenta que permite aos vendedores configurar a capacidade máxima de envios que pode realizar em um dia sem sofrer atrasos, oferecendo a flexibilidade de organizar-se e evitar atrasos, seja devido a mudanças planificadas em seu volume de vendas ou situações inesperadas.
Saiba mais sobre:
- O que é minha capacidade de envios e para que serve.
- O que acontece se supero minha capacidade.
- Até quando posso modificá-la.
- Como a modifico se tenho uma coleta no dia.
- O que é minha capacidade mínima.
- Como finalizar coletas com meu código.
Além disso, saiba como funciona Mercado Envios Coleta (cross_docking) e o que é Mercado Envios 2.
Obter capacidade atual
Este endpoint permite obter a configuração atual de capacidade de envios de um usuário:
Chamada:
curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/users/$USER_ID/capacity_middleend/$LOGISTIC_TYPE
Exemplo:
curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/users/419059119/capacity_middleend/cross_docking
Resposta:
{
"capacities":[
{
"day": "monday",
"capacity_min":20,
"capacity_max": 140,
"capacity": {
"value": 120,
"maximum": false
},
"next_capacity": {
"value": 110,
"maximum": false
},
"can_add_capacity": false,
"can_subtract_capacity": true,
"intervention" : "delay",
},
{
"day": "tuesday",
"capacity_min":20,
"capacity_max": 140,
"capacity": {
"value": 120,
"maximum": false
},
"next_capacity": null,
"can_add_capacity": true,
"can_subtract_capacity": false,
"intervention" : "delay",
},
{
"day": "wednesday",
"capacity_min":20,
"capacity_max": 140,
"capacity": {
"value": 140,
"maximum": false
},
"next_capacity": null,
"can_add_capacity": true,
"can_subtract_capacity": false,
"intervention" : "delay",
},
{
"day": "thursday",
"capacity_min":20,
"capacity_max": 140,
"capacity": {
"value": 120,
"maximum": false
},
"next_capacity": null,
"can_add_capacity": true,
"can_subtract_capacity": false,
"intervention" : "delay",
},
{
"day": "friday",
"capacity_min":20,
"capacity_max": 140,
"capacity": {
"value": 110,
"maximum": false
},
"next_capacity": null,
"can_add_capacity": true,
"can_subtract_capacity": false,
"intervention" : "delay",
},
{
"day": "saturday",
"capacity_min":20,
"capacity_max": 140,
"capacity": {
"value": 120,
"maximum": true
},
"next_capacity": null,
"can_add_capacity": true,
"can_subtract_capacity": false,
"intervention" : "delay",
},
]
Parâmetros de resposta
- day: representa o dia da semana a que se refere a capacidade. Os valores possíveis são monday, tuesday, wednesday, thursday, friday, e saturday
- capacity_min: é o valor mínimo de capacidade permitido para esse dia.
- capacity_max: é o valor máximo de capacidade permitido para esse dia.
- capacity.value: é o valor de capacidade atual para o dia e semana em que o usuário se encontra.
- capacity.maximum: indica se o usuário tem selecionado a capacidade infinita (false) / máxima (true). Caso não tenha next_capacity devolverá null para este campo.
- next_capacity.value: é o valor de capacidadde confighurada aplicável para a semana seguinte.
- next_capacity.maximum: indica se o usuário tem selecionada capacidade infinita (false) / máxima (true) para a semana seguinte.
- can_add_capacity: indica se é possível adicionar capacidade adicional para este dia. Os possíves valores são true ou false.
- can_subtract_capacity: indica se é possível restar capacidade para este dia. Os possíveis valores são true ou false.
- intervention: descreve o tipo de intervenção em que o usuário pode incorrer:
- delay: intervenção por atraso.
- null: não tem intervenção.
Código | Mensagem | Descrição | Recomendação |
---|---|---|---|
200 - OK | - | Foi obtida corretamente a configuração atual. | - |
404 - Not Found | not valid logistic type | O usuário não existe oou não tem a logística de cross_docking. | Validar o user_id e os tipos de logísticas do usuário. |
Atualizar capacidade de envios
Este endpoint permite atualizar ou modificar a configuração de capacidade de envios do usuário.
Chamada:
curl -X PUT -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/users/$USER_ID/capacity_middleend/$LOGISTIC_TYPE
Exemplo:
curl -X PUT -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/users/419059119/capacity_middleend/cross_docking
{
"capacities": [
{
"day": "monday",
"capacity": {
"value": 120,
"maximum": false
},
},
{
"day": "tuesday",
"capacity": {
"value": 120,
"maximum": false
},
},
{
"day": "wednesday",
"capacity": {
"value": 120,
"maximum": false
},
},
{
"day": "tuesday",
"capacity": {
"value": 120,
"maximum": false
},
},
{
"day": "friday",
"capacity": {
"value": 120,
"maximum": true
},
},
{
"day": "saturday",
"capacity": {
"value": 120,
"maximum": false
},
},
]
}'
Códigos de estado de resposta:
Código | Mensagem | Descrição | Recomendação |
---|---|---|---|
200 - OK | - | Foi obtida corretamente a configuração atual.. | - |
400 - Bad Request | there was an error parsing the request body | Erro nos parâmetros do request body. | Validar o request body. |
404 - Not Found | not valid logistic type | O usuário não existe oou não tem a logística de cross_docking. | Validar o user_id e os tipos de logísticas do usuário. |