Pular para o conteúdo principal

Referência de ferramentas

Esta página lista as ferramentas que o servidor MCP oferece para sellers, agrupadas por toolset. Para cada uma, você encontra:

  • Tipo: se a ferramenta só consulta dados (Leitura) ou se altera dados na loja (Escrita);
  • API: a operação da API que a ferramenta chama, com link para a referência completa (parâmetros, respostas e erros);
  • Escopo: a permissão do ID Magalu que a ferramenta exige. Se o token não tiver esse escopo, a ferramenta não aparece para o assistente.

O nome de cada toolset indica a visão e o assunto: seller:orders reúne as ferramentas de pedidos para quem vende.

Ferramentas para sellers​

seller:categories​

Categorias, atributos e ficha técnica do catálogo.

FerramentaO que fazTipoAPIEscopo
seller_categories_searchBusca categorias do catálogo pelo nome ou IDLeituraConsultar categoriaopen:portfolio-categories-seller:read
seller_categories_get_hierarchyNavega a árvore de categorias: raízes, filhas de uma categoria ou o caminho até elaLeituraConsultar hierarquia de categoriaopen:portfolio-categories-seller:read
seller_categories_list_attributesLista os atributos (ex.: cor, voltagem) que um SKU da categoria pode ou deve terLeituraConsultar atributos de uma categoriaopen:portfolio-categories-seller:read
seller_categories_list_datasheetLista os campos da ficha técnica de uma categoriaLeituraConsultar atributos de ficha técnica de uma categoriaopen:portfolio-categories-seller:read
seller_categories_get_sku_templateMonta o template de cadastro de SKU de uma categoria: atributos e ficha técnicaLeituraConsultar atributos de uma categoriaopen:portfolio-categories-seller:read

seller:financial​

Análise financeira dos pedidos do seller.

FerramentaO que fazTipoAPIEscopo
seller_financial_list_ordersLista a análise financeira dos pedidos: valor vendido, comissão, frete e repasseLeituraConsultaropen:order-financial-report-seller:read
seller_financial_get_orderConsulta o demonstrativo financeiro de um pedidoLeituraConsultar por Pedidoopen:order-financial-report-seller:read

seller:orders​

Pedidos do seller no Marketplace Magalu.

FerramentaO que fazTipoAPIEscopo
seller_orders_searchBusca pedidos do seller aplicando filtros avançadosLeituraConsultaropen:order-order-seller:read
seller_orders_getConsulta os detalhes de um pedido específicoLeituraConsultar por códigoopen:order-order-seller:read
seller_orders_list_deliveriesLista as entregas do seller. Cada pedido pode ter uma ou mais entregasLeituraConsultaropen:order-order-seller:read
seller_orders_get_deliveryConsulta os detalhes de uma entregaLeituraConsultar por IDopen:order-order-seller:read
seller_orders_list_delivery_historyLista o histórico de mudanças de status de uma entregaLeituraConsultar históricoopen:order-order-seller:read
seller_orders_finish_deliveryMarca uma entrega como entregue ao cliente (status delivered). A ação não pode ser desfeitaEscritaMarcar entrega finalizadaopen:order-delivery-seller:write
seller_orders_ship_deliveryMarca uma entrega como despachada (status shipped), com rastreio e previsão de entregaEscritaMarcar entrega enviadaopen:order-delivery-seller:write
seller_orders_list_delivery_invoicesLista as notas fiscais (NF-e) enviadas para uma entregaLeituraBuscar NF-esopen:order-delivery-seller:read
seller_orders_create_delivery_invoiceEnvia a nota fiscal (NF-e) de uma entrega aprovada; a entrega passa a invoicedEscritaEnviar NF-e de entregaopen:order-delivery-seller:write
seller_orders_update_delivery_invoiceSubstitui os dados de uma NF-e já enviada para a entregaEscritaAtualizar NF-e de entregaopen:order-delivery-seller:write
seller_orders_list_fulfillment_invoicesLista as notas fiscais emitidas pela Magalu nas vendas com fulfillmentLeituraBuscar NF-e de fulfillmentopen:order-invoice-seller:read
seller_orders_create_shipping_labelsGera as etiquetas de envio de uma ou mais entregasEscritaGerar etiquetasopen:order-logistics-seller:write

seller:products​

SKUs, preços, estoques e vídeos do seller.

FerramentaO que fazTipoAPIEscopo
seller_products_get_seller_infoRetorna as informações do seller (lojista) autenticadoLeituraConsultar informações do selleropen:portfolio-skus-seller:read
seller_products_list_skusLista os SKUs (produtos) do catálogo do seller com paginaçãoLeituraConsultaropen:portfolio-skus-seller:read
seller_products_create_skuCria um novo SKU no catálogo do sellerEscritaCriaropen:portfolio-skus-seller:write
seller_products_update_skuAtualiza completamente um SKU existente (PUT — substitui todos os campos)EscritaAtualizaropen:portfolio-skus-seller:write
seller_products_get_sku_validation_infoConsulta o último evento de política de publicação de um SKULeituraConsultar eventos de políticas de SKUopen:portfolio-skus-seller:read
seller_products_get_priceConsulta o preço atual de um SKULeituraConsultaropen:portfolio-prices-seller:read
seller_products_update_priceAtualiza o preço de um SKU que já tem preço cadastrado. Para o primeiro preço, use seller_products_create_priceEscritaAtualizaropen:portfolio-prices-seller:write
seller_products_get_stockConsulta o estoque atual de um SKULeituraConsultaropen:portfolio-stocks-seller:read
seller_products_create_stockCria o registro de estoque inicial de um SKU em um canalEscritaCriaropen:portfolio-stocks-seller:write
seller_products_update_stockAltera a quantidade à venda de um SKU no marketplace; com 0, o SKU deixa de ser vendido no canalEscritaAtualizaropen:portfolio-stocks-seller:write
seller_products_list_videosLista os vídeos associados a um SKULeituraConsultar vídeos de um produto específicoopen:portfolio-skus-seller:read
seller_products_request_video_uploadInicia o processo de upload de vídeo para um SKUEscritaIniciar processo de upload de vídeoopen:portfolio-skus-seller:write
seller_products_confirm_video_uploadConfirma que o upload do vídeo foi concluído e inicia a validaçãoEscritaConfirmar o upload de um vídeoopen:portfolio-skus-seller:write
seller_products_get_videoConsulta os detalhes e status de um vídeo específicoLeituraConsultar detalhes de um vídeo específicoopen:portfolio-skus-seller:read
seller_products_get_skuConsulta todos os dados cadastrados de um SKULeituraConsultar pelo SKUopen:portfolio-skus-seller:read
seller_products_patch_skuAtualiza só os campos informados de um SKU, sem reenviar o cadastro inteiroEscritaAtualizar (parcial)open:portfolio-skus-seller:write
seller_products_create_priceCadastra o primeiro preço de um SKU em um canal. Para alterar depois, use seller_products_update_priceEscritaCriaropen:portfolio-prices-seller:write
seller_products_list_all_videosLista os vídeos de todo o portfólio do seller, com filtrosLeituraConsultar todos os vídeos do portfólioopen:portfolio-skus-seller:read
seller_products_request_bulk_video_uploadInicia o upload de um vídeo associado a vários SKUs de uma vezEscritaIniciar processo de múltiplos uploads de vídeosopen:portfolio-skus-seller:write
seller_products_list_scoresLista a nota de qualidade do cadastro dos produtos em um canalLeituraConsultaropen:portfolio-scores-seller:read

seller:promotions​

Promoções do seller no Marketplace Magalu.

FerramentaO que fazTipoAPIEscopo
seller_promotions_listLista as promoções em que o seller pode participar ou já participaLeituraConsultar promoções elegíveisopen:promotion-promotions-seller:read
seller_promotions_createCria uma promoção do próprio seller (self service)EscritaCriar promoçãoopen:promotion-promotions-seller:write
seller_promotions_getConsulta os detalhes de uma promoçãoLeituraConsultar detalhes de uma promoçãoopen:promotion-promotions-seller:read
seller_promotions_applyEfetiva as alterações pendentes de SKUs (inclusões, preços e remoções) de uma promoção, com efeito imediatoEscritaAplicar alterações pendentes de uma promoçãoopen:promotion-skus-seller:write
seller_promotions_get_performanceConsulta vendas, investimento e uso de uma promoçãoLeituraConsultar performance de uma promoçãoopen:promotion-promotions-seller:read
seller_promotions_list_skusLista os SKUs do seller que participam de uma promoçãoLeituraConsultar SKUs de uma promoçãoopen:promotion-skus-seller:read
seller_promotions_get_skuConsulta um SKU dentro de uma promoçãoLeituraConsultar SKU de uma promoção por IDopen:promotion-skus-seller:read
seller_promotions_update_skuInclui um SKU na promoção ou altera o preço promocional ou o limite de unidades deleEscritaAtualizar dados de um SKU de uma promoçãoopen:promotion-skus-seller:write
seller_promotions_remove_skuRemove um SKU de uma promoçãoEscritaRemover SKU de uma promoçãoopen:promotion-skus-seller:write
seller_promotions_subscribeInscreve o seller em uma promoção do canalEscritaInscrever-se em uma promoçãoopen:promotion-subscriptions-seller:write
seller_promotions_unsubscribeCancela a inscrição do seller em uma promoçãoEscritaCancelar inscrição em uma promoçãoopen:promotion-subscriptions-seller:write

seller:vehicles​

Compatibilidade de autopeças com veículos.

FerramentaO que fazTipoAPIEscopo
seller_vehicles_list_manufacturersLista os fabricantes de veículos. Primeiro passo para chegar à versão do veículoLeituraConsultar fabricantesopen:portfolio-vehicles-seller:read
seller_vehicles_list_modelsLista os modelos de um fabricanteLeituraConsultar modelosopen:portfolio-vehicles-seller:read
seller_vehicles_list_yearsLista os anos disponíveis de um modeloLeituraConsultar anos do modeloopen:portfolio-vehicles-seller:read
seller_vehicles_list_versionsLista as versões de um modelo em um ano. O ID da versão é o que entra na compatibilidadeLeituraConsultar versõesopen:portfolio-vehicles-seller:read
seller_vehicles_add_compatibilitiesAdiciona versões de veículos compatíveis com uma autopeça (SKU)EscritaCriar compatibilidadesopen:portfolio-vehicles-compatibility-seller:write
seller_vehicles_replace_compatibilitiesSubstitui toda a lista de veículos compatíveis de uma autopeça (SKU)EscritaAtualizar compatibilidadesopen:portfolio-vehicles-compatibility-seller:write
seller_vehicles_remove_compatibilitiesRemove todas as compatibilidades de veículos de uma autopeça (SKU)EscritaRemover compatibilidadesopen:portfolio-vehicles-compatibility-seller:write

Ferramentas do servidor​

Estas aparecem para qualquer conta e não chamam APIs da loja.

FerramentaO que faz
magalu_list_modulesLista os toolsets que o token permite usar
magalu_list_channelsLista os canais de venda da loja, com o ID que o assistente usa em preço, estoque, cadastro e promoções. Só no servidor de sellers
list_toolsets, get_toolset_tools, enable_toolsetDescoberta de toolsets no modo dinâmico. Veja Para desenvolvedores