API da VTEX: o que dá para fazer e como usar com agentes de IA
A VTEX expõe APIs REST para quase todos os módulos da plataforma de e-commerce: catálogo, pedidos, logística, preços e clientes. É usada por varejistas e indústrias de médio e grande porte e por seus integradores. O acesso é por chave e token de aplicação gerados na conta.
Os grandes recursos da API, em português claro.
Produtos, SKUs, categorias, marcas e especificações.
Consulta, acompanhamento e mudança de status de pedidos, incluindo cancelamento.
Saldos por armazém, docas e configurações de entrega.
Tabelas e regras de preço por SKU e política comercial.
Criação e consulta de promoções e cupons.
Dados de clientes e entidades personalizadas da loja.
Como se acessa a API do VTEX.
- Com credencial da sua empresaUsa um par App Key e App Token criado no admin da VTEX, associado a perfis de acesso que definem o que a chave pode fazer.
- Documentação oficialdevelopers.vtex.com
- Algumas APIs têm limites de requisição; integrações em lote devem respeitá-los.
- Perfis de acesso amplos dão poder demais à chave: crie um perfil próprio para o agente.
- Dados de clientes no Master Data estão sujeitos à LGPD.
- api vtex
- vtex api documentação
- vtex api pedidos
- vtex api catálogo
- integração api vtex
- vtex app key app token
- vtex master data api
O que um agente do iTeam faz com a API do VTEX.
O agente consulta o pedido no OMS e o rastreio, responde o cliente e abre a tratativa no time quando há extravio ou atraso.
O agente cruza vendas e saldo por armazém e avisa compras sobre SKUs que vão zerar nos próximos dias.
Pedidos presos em um status por tempo demais são listados com o motivo provável para o time de operações.
Antes de uma campanha, o agente confere promoções ativas e aponta conflitos de desconto ou SKUs sem preço.
Da credencial ao agente trabalhando, com aprovação.
Crie a chave de aplicação
No admin da VTEX, gere App Key e App Token e associe a um perfil de acesso com as permissões mínimas.
Cadastre no cofre do iTeam
As credenciais ficam no cofre e cada agente recebe só as ações que precisa, como leitura de pedidos ou ajuste de estoque.
Valide em homologação
Teste em um ambiente de desenvolvimento ou workspace da VTEX e mantenha aprovação para cancelamentos e preços.
Dúvidas sobre a API do VTEX.
A API da VTEX é gratuita?
O uso das APIs faz parte do contrato da plataforma VTEX; não há, de forma geral, cobrança separada por chamada para a própria loja.
Preciso programar para usar a API da VTEX com o iTeam?
Não necessariamente. A ferramenta HTTP do iTeam aprende os endpoints pela documentação da VTEX e o time de implantação configura os fluxos.
O agente pode cancelar pedidos?
Pode, se o perfil de acesso permitir, mas o recomendado é que cancelamentos passem por aprovação humana.
Que tarefas de e-commerce um agente de IA executa nas APIs da VTEX?
As APIs da VTEX cobrem catálogo, pedidos no OMS, logística e estoque, preços, promoções e Master Data. O agente consulta onde está o pedido, atualiza estoque por armazém, acompanha pedidos travados e responde ao cliente. Alterações de preço e promoção pedem aprovação. No iTeam, o atendimento da loja VTEX roda também no WhatsApp.
Como funcionam App Key e App Token da VTEX?
Você cria o par no admin da VTEX, associado a um perfil de acesso, e envia nos cabeçalhos de cada chamada. O perfil define o que a chave faz. Crie um perfil próprio para o agente, com só os recursos de que ele precisa, em vez de usar um perfil amplo. O App Token só aparece na criação, então guarde-o em cofre.
A VTEX tem ambiente de homologação para testar a integração?
Não confirmei um sandbox público da API; a prática é usar uma conta ou loja de homologação da própria empresa, quando existir, com catálogo de teste. Confira com a VTEX ou com seu integrador as opções de ambiente de teste do seu contrato. Evite ensaiar mudanças de preço e estoque diretamente na loja ao vivo.
A API de pedidos da VTEX permite consultar o status em tempo real?
Sim: o OMS expõe os dados e o estado de cada pedido, e a VTEX tem recursos de notificação de mudança de status, conforme o módulo. O agente responde ao cliente com o estado atual e a previsão de entrega, sem esperar um relatório. Confira na documentação o modo de receber os avisos no seu plano e o formato da resposta.
Que limites de requisição a VTEX impõe e como o agente os respeita?
Algumas APIs têm limites de requisição, e o excesso devolve erro com orientação de espera. O agente deve processar em lotes pequenos, repetir com espera crescente e evitar varrer o catálogo inteiro com frequência. Confira os limites da API específica na documentação, pois variam por recurso. Para sincronizações grandes, combine janelas fora do horário de pico.
O agente pode alterar preços e promoções na VTEX sozinho?
Pode tecnicamente, com a chave certa, mas preço errado vira prejuízo em minutos. Mantenha o agente propondo e uma pessoa de comercial aprovando, ao menos acima de uma variação definida, e limite a janela de atuação. Registre o valor anterior para reverter. Em grandes lojas, a dupla checagem evita erro de planilha chegar ao site.
Os dados de clientes no Master Data da VTEX têm cuidado de LGPD?
Sim: cadastros com nome, documento, endereço e contato são pessoais. O agente só deve acessar os campos que a tarefa exige, e o perfil de acesso da chave pode restringir isso. Evite que o agente copie esses dados para fora do atendimento. Defina retenção e quem lê conversas inteiras, alinhado ao jurídico.
Vale a pena ligar a VTEX a um agente de IA?
Vale para varejistas de médio e grande porte com muitos pedidos, perguntas de status e catálogo grande, em que o atendimento e a operação repetem consultas. Para uma loja pequena, o volume dificilmente justifica a integração. O diagnóstico inicial do iTeam mapeia onde o time perde tempo antes de propor um agente.
