Documentação do Mercado Livre

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

Documentação

Última atualização em 15/01/2024

Gestão da capacidade de envio

Importante:
Atualmente, a funcionalidade está disponível apenas para vendedores com Mercado Envios Coleta (cross_docking) e Places (xd_drop_off) de Argentina, Brasil, México, Chile e Colômbia..

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:

Além disso, saiba como funciona Mercado Envios Coleta (cross_docking), Mercado Envíos Places (xd_drop_off) e o que é Mercado Envios 2.



Nota:
Esta ferramenta em Mercado Envios Places (xd_drop_off), está exclusivamente disponível para vendedores profissionais no Mercado Livre, ou seja, para aqueles vendedores com uma trajetória considerável na plataforma.

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 com intervenção delay:

{
  "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",
     },
   ]

Resposta com intervenção early:

{
   "capacities":[
       {
         "day": "monday",
         "capacity_min":20,
         "capacity_max": null,
         "capacity": {
          "value": 120,
          "maximum": false
         },
         "next_capacity": {
          "value": 110,
          "maximum": false
         },
         "can_add_capacity": false,
         "can_subtract_capacity": true,
         "intervention" : "early",
      },
      {
         "day": "tuesday",
         "capacity_min":20,
         "capacity_max": null,
         "capacity": {
          "value": 120,
          "maximum": false
         },
         "next_capacity": null,
         "can_add_capacity": true,
         "can_subtract_capacity": false,
         "intervention" : "early",
      },
      {
         "day": "wednesday",
         "capacity_min":20,
         "capacity_max": null,
         "capacity": {
          "value": 140,
          "maximum": false
         },
         "next_capacity": null,
         "can_add_capacity": true,
         "can_subtract_capacity": false,
         "intervention" : "early",
      },
      {
         "day": "thursday",
         "capacity_min":20,
         "capacity_max": null,
         "capacity": {
          "value": 120,
          "maximum": false
         },
         "next_capacity": null,
         "can_add_capacity": true,
         "can_subtract_capacity": false,
         "intervention" : "early",
      },
      {
         "day": "friday",
         "capacity_min":20,
         "capacity_max": null,
         "capacity": {
          "value": 110,
          "maximum": false 
         },
         "next_capacity": null,
         "can_add_capacity": true,
         "can_subtract_capacity": false,
         "intervention" : "early",
      },
      {
         "day": "saturday",
         "capacity_min":20,
         "capacity_max": null,
         "capacity": {
          "value": 120,
          "maximum": true
         },
         "next_capacity": null,
         "can_add_capacity": true,
         "can_subtract_capacity": false,
         "intervention" : "early",
      },
    ]
}

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.
    • early: intervenção por entregas antecipadas.
    • 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.
Notas:
- Se a capacidade de envios não for configurada, o sistema não irá impor restrições. Entretanto, recomendamos aos vendedores que usem esta funcionalidade para otimizar suas entregar e melhorar a experiência do cliente.
- Quando um vendedor não cumpre com o seu objetivo de capacidades de envios, entra em um estado de intervenção por delay. Durante este período, há restrições na capacidade de modificar ou atualizar a capacidade de envios. Isto é feito para garantir que os vendedores se comprometam a melhorar seu rendimento. Uma vez que cumpram os requisitos durante o período de intervenção, as restrições serão suspensas e poderá voltar a ajustar sua capacidade de envios.
- Quando um vendedor pode despachar mais de sua capacidade, entrega em um estado de intervenção por early. Durante este período, não há restrições na capacidade de modificar ou atualizar a capacidade de envios, o que se busca é que o vendedor possa maximizar sua injeção e configurar uma capacidade exata.
- Para uma experiência ótima, recomendamos habilitar as “Novidades de vendedores”, já que é aqui onde será notificada qualquer atualização ou mudança relevante para este processo.


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.