Referência de toolsIndex

Referência de ferramentas — Mercado Livre

O conector expõe 43 ferramentas. Classes de cobrança: grátis (meta/status — não contam na cota), leitura, agregação (fan-out computado no servidor) e escrita (auditadas; as arriscadas exigem confirmação).

Agregação (respostas computadas)

ads_performance

Performance de Product Ads (api-version 2, ROAS-first; deriva ACoS=(1/ROAS)×100). Janela ≤90 dias.

ParâmetroTipoObrigatórioPadrão
date_fromstringsim
date_tostringsim
levelstringnãoaccount
advertiser_idstring/nullnão
statusstring/nullnão
metricsarray/nullnão
aggregation_typestringnãosum
sort_bystring/nullnão
limitintegernão50
campaign_idsarray/nullnão

aggregate_orders

Agrega pedidos server-side: faturamento (gmv), pedidos, unidades, ticket médio, tarifas, por período/status/agrupamento. 1 chamada = 1 resposta computada (ex.: ‘faturamento pago dos últimos 7 dias’).

ParâmetroTipoObrigatórioPadrão
date_fromstringsim
date_tostringsim
date_fieldstringnãoclosed
statusarray/nullnão
group_byarray/nullnão
metricsarray/nullnão
top_nintegernão20

claims_open_summary

Reclamações abertas: total, agrupamentos e as acionáveis com prazo.

ParâmetroTipoObrigatórioPadrão
group_byarray/nullnão
include_actionablebooleannãoTrue

query

Consulta genérica (DSL) sobre orders, order_items, items, questions, claims — filtros, group_by (com bucket day/week/month) e agregações (sum/count/avg/min/max/count_distinct) computadas no servidor. Use describe_query_schema para o catálogo completo.

ParâmetroTipoObrigatórioPadrão
entitystringsim
selectarray/nullnão
filterobject/nullnão
group_byarray/nullnão
aggregatearray/nullnão
sortarray/nullnão
limitinteger/nullnão
budgetobject/nullnão

rank_items

Ranqueia anúncios por gmv/unidades/visitas/conversão no período.

ParâmetroTipoObrigatórioPadrão
date_fromstringsim
date_tostringsim
bystringnãogmv
statusarray/nullnão
limitintegernão20
directionstringnãodesc
includearray/nullnão

reputation_summary

Reputação enquadrada nos thresholds de cor do site + distância do rebaixamento + reclamações abertas.

ParâmetroTipoObrigatórioPadrão
include_open_claimsbooleannãoTrue

visits_rollup

Rollup de visitas (janela ≤150d; contorna a regra 1-id-por-chamada).

ParâmetroTipoObrigatórioPadrão
date_fromstringsim
date_tostringsim
item_idsarray/nullnão
group_bystring/nullnão
top_nintegernão20

Leitura

get_claim

Reclamação composta (post-purchase v1).

ParâmetroTipoObrigatórioPadrão
claim_idintegersim
includearray/nullnão

get_item

Busca 1..N anúncios com projeção de campos (multiget em blocos de 20).

ParâmetroTipoObrigatórioPadrão
item_idstring/nullnão
item_idsarray/nullnão
fieldsarray/nullnão

get_order

Busca um pedido do Mercado Livre (normalizado). view=financial inclui descontos.

ParâmetroTipoObrigatórioPadrão
order_idintegersim
viewstringnãosummary

get_question

Uma pergunta; include_contact usa api_version=4 (dados do comprador).

ParâmetroTipoObrigatórioPadrão
question_idintegersim
include_contactbooleannãoFalse

get_seller_reputation

Projeção da reputação do vendedor (endpoint /users/id).

get_shipment

Envio composto: colapsa até 8 endpoints /shipments/* (busca só o pedido).

ParâmetroTipoObrigatórioPadrão
shipment_idintegersim
includearray/nullnão

get_stock

Estoque multi-origem; devolve x_version (necessário para escrita).

ParâmetroTipoObrigatórioPadrão
user_product_idstringsim

get_visits

Visitas (user ou item). Janela ≤150 dias; 1 id por chamada (regra ML).

ParâmetroTipoObrigatórioPadrão
scopestringsim
idstring/nullnão
date_fromstring/nullnão
date_tostring/nullnão
modestringnãototal
lastinteger/nullnão
unitstringnãoday

list_pack_messages

Mensagens pós-venda de um pacote/pedido (pack-cêntrico; aceita ambos).

ParâmetroTipoObrigatórioPadrão
pack_idinteger/nullnão
order_idinteger/nullnão
mark_as_readbooleannãoFalse
cursorstring/nullnão
limitintegernão50

list_received_questions

Perguntas recebidas (pré-venda).

ParâmetroTipoObrigatórioPadrão
statusstring/nullnão
item_idstring/nullnão
from_userinteger/nullnão
sortstring/nullnão
cursorstring/nullnão
limitintegernão50

list_warehouses

Depósitos (stock locations) do vendedor.

search_claims

Busca reclamações. Auto-injeta players.user_id+role=respondent quando não há filtro real (ML devolve 400 em busca só com paginação).

ParâmetroTipoObrigatórioPadrão
statusstring/nullnão
typestring/nullnão
stagestring/nullnão
order_idinteger/nullnão
pack_idinteger/nullnão
resourcestring/nullnão
resource_idinteger/nullnão
reason_idstring/nullnão
range_fromstring/nullnão
range_tostring/nullnão
sortstring/nullnão
cursorstring/nullnão
limitintegernão30

search_orders

Busca pedidos do vendedor (/orders/search) com paginação normalizada (cursor).

ParâmetroTipoObrigatórioPadrão
statusstring/nullnão
qstring/nullnão
itemstring/nullnão
tagsarray/nullnão
date_fieldstringnãocreated
date_fromstring/nullnão
date_tostring/nullnão
sortstring/nullnão
cursorstring/nullnão
limitintegernão50

search_seller_items

Lista IDs de anúncios do vendedor; muda para scan/scroll_id além de 1000.

ParâmetroTipoObrigatórioPadrão
statusstring/nullnão
listing_typestring/nullnão
skustring/nullnão
cursorstring/nullnão
limitintegernão100

Escrita (auditadas)

add_order_note

Adiciona nota interna a um pedido (visível só para o vendedor).

ParâmetroTipoObrigatórioPadrão
order_idintegersim
notestringsim
confirmbooleannãoFalse

answer_question

Responde uma pergunta de pré-venda.

ParâmetroTipoObrigatórioPadrão
question_idintegersim
textstringsim
confirmbooleannãoFalse

delete_question ⚠️ destrutiva

Exclui uma pergunta. SEMPRE exige confirm=true.

ParâmetroTipoObrigatórioPadrão
question_idintegersim
confirmbooleannãoFalse

Obtém etiquetas de envio OFICIAIS do ML (o template nunca é alterado).

ParâmetroTipoObrigatórioPadrão
shipment_idsarraysim
formatstringnãopdf
confirmbooleannãoFalse

resolve_claim ⚠️ destrutiva

Resolve uma reclamação. Valida action ∈ available_actions do claim. SEMPRE exige confirm=true (ação de alto risco).

ParâmetroTipoObrigatórioPadrão
claim_idintegersim
actionstringsim
payloadobject/nullnão
confirmbooleannãoFalse

send_claim_message

Envia mensagem na reclamação (para o reclamante ou mediador).

ParâmetroTipoObrigatórioPadrão
claim_idintegersim
tostringsim
textstringsim
attachment_idsarray/nullnão
confirmbooleannãoFalse

send_message

Envia UMA mensagem pós-venda no pacote/pedido. Regras ML: só conversas iniciadas pelo comprador, janela de 48h úteis, pedido não cancelado. PROIBIDO uso automático/template/repetitivo (bloqueado pelo ML e arrisca a conta do vendedor) — apenas os motivos oficiais.

ParâmetroTipoObrigatórioPadrão
textstringsim
pack_idinteger/nullnão
order_idinteger/nullnão
attachment_idsarray/nullnão
confirmbooleannãoFalse

split_shipment ⚠️ destrutiva

Divide um envio em pacotes. SEMPRE exige confirm=true.

ParâmetroTipoObrigatórioPadrão
shipment_idintegersim
reasonstringsim
packsarraysim
confirmbooleannãoFalse

update_item ⚠️ destrutiva

Atualiza um anúncio (preço, estoque, status). Guardas: rejeita variação de preço >±50%, estoque negativo; deleted encadeia closed→delete.

ParâmetroTipoObrigatórioPadrão
item_idstringsim
pricenumber/nullnão
available_quantityinteger/nullnão
statusstring/nullnão
deletedbooleannãoFalse
other_fieldsobject/nullnão
confirmbooleannãoFalse

update_order_note

Atualiza uma nota interna de pedido.

ParâmetroTipoObrigatórioPadrão
order_idintegersim
note_idstringsim
notestringsim
confirmbooleannãoFalse

update_stock_multiwarehouse ⚠️ destrutiva

Atualiza estoque multi-origem (busca x-version e envia PUT com lock otimista).

ParâmetroTipoObrigatórioPadrão
user_product_idstringsim
locationsarraysim
confirmbooleannãoFalse

upload_message_attachment

Sobe um anexo de mensagem (≤25MB; JPG/PNG/PDF/TXT).

ParâmetroTipoObrigatórioPadrão
file_base64stringsim
filenamestringsim
confirmbooleannãoFalse

Meta (grátis)

connection_status

Status da conexão: conta, validade do token, escopos. Gratuito.

describe_query_schema

Catálogo do DSL query: entidades, campos, operadores, regras de budget. Gratuito.

describe_schemas

Schemas dos objetos ML (para o agente montar consultas). Gratuito.

ParâmetroTipoObrigatórioPadrão
entitystring/nullnão

get_app_limits

Limites do app ML (max_requests_per_hour, escopos). Gratuito.

get_claim_reasons

Motivos de reclamação (todos ou um específico). Gratuito.

ParâmetroTipoObrigatórioPadrão
reason_idstring/nullnão

list_shipment_statuses

Catálogo de status de envio (cacheável). Gratuito.

list_sites

Sites do ML (site_id ↔ moeda). Gratuito.

open_support_ticket

Abre um chamado de suporte do mcplace sem sair do chat. Use quando o usuário pedir, ou OFEREÇA quando houver erro repetido de ferramenta, falha de permissão/auth sem solução, ou limitação do conector. Sempre pergunte ao usuário antes de abrir. Gratuito (não conta na cota).

ParâmetroTipoObrigatórioPadrão
subjectstringsim
bodystringsim
severitystring/nullnão
categorystringnãoquestion
contextobject/nullnão

suggest_improvement

Registra uma sugestão de melhoria do mcplace (ex.: ‘essa ação ainda não existe no conector’). Pergunte ao usuário antes. Gratuito.

ParâmetroTipoObrigatórioPadrão
textstringsim
areastring/nullnão

whoami

Conta conectada: id, nickname, site, tags (inclui multiwarehouse), status.