API Shop: como pedir e ativar a API do Shop Control 9

Antes de ligar o Shop 9 a qualquer marketplace, alguém precisa ativar a API.

Você pede o módulo e recebe as credenciais antes de abrir qualquer projeto de desenvolvimento. Só depois decide quem vai usá-las: seu desenvolvedor, um integrador ou um aplicativo pronto.

API Shop, API do Shop 9, módulo Integrações: um recurso só

No comercial da IdealSoft, o nome é módulo Integrações. Na documentação técnica, é a API desse módulo. Entre lojista e desenvolvedor, vira “API Shop”, “API do Shop 9” ou “webservice”.

Esse recurso é a porta oficial do ERP: um sistema de fora pede dados ao Shop 9, grava dados nele e recebe a resposta em JSON. Site, BI e hub de marketplace passam por ali, e a integração com marketplaces também.

O que passa pela API

Em linguagem de loja, a API lê e grava cinco grupos de dados:

1. Produtos e grade, com cadastro, fotos e as grades de cor e tamanho.
2. Preços do produto, das tabelas e das promoções.
3. Estoque, com o saldo por filial, por combinação de grade, por lote e por série.
4. Clientes, com cadastro e contatos.
5. Vendas e movimentações, como saídas, devoluções, notas, entradas, ordens de serviço, contagem de estoque e crédito de cliente.

Os endpoints e os exemplos de requisição ficam na documentação oficial da IdealSoft. É por lá que o programador começa.

Na prática, uma camiseta em 3 cores e 4 tamanhos chega pela API como 12 combinações, cada uma com o seu saldo. É isso que permite a um hub publicar um anúncio com variações nos canais que aceitam (o guia da grade mostra como fica).

Peça o módulo Integrações e receba as credenciais

O módulo Integrações é vendido à parte do Shop Control 9, e valor e condições são da IdealSoft. Vale para qualquer uso da API: desenvolvimento próprio, integrador ou Gumo Hub. Por isso o módulo é a primeira linha de qualquer orçamento, e o pedido tem dois passos:

1. Fale com o comercial da IdealSoft: pergunte se o seu plano é elegível, quanto custa e como a ativação é feita na licença.
2. Receba as credenciais: com o módulo ativo, o Shop 9 gera o número de série, o código da filial e a senha do módulo.

Esses três dados seguem para quem fará a conexão: o seu desenvolvedor, o integrador ou o Hub. Trate a senha do módulo como senha de banco, porque ela faz parte da assinatura de cada chamada. Passe só a quem vai mesmo conectar.

API ativa, integração ainda por fazer

Com a API ativa, o ERP já entrega e recebe dados. Anúncio no canal, ainda não. Esse trabalho fica com quem consome a API:

1. Publicar o anúncio em cada canal, com as regras dele.
2. Traduzir a grade para o formato que cada canal pede.
3. Cuidar de título e foto, porque o anúncio precisa dos dois.
4. Vigiar a sincronização, já que preço e saldo mudam depois que o anúncio vai ao ar.

Quem desenvolve encontra token com validade, assinatura em cada requisição e uma base de homologação, liberada pelo suporte da IdealSoft para testar sem tocar em dado real. Os detalhes estão na documentação oficial e são assunto para o desenvolvedor.

Quem vai usar a API: um desenvolvedor ou um aplicativo pronto?

Alguém precisa consumir a API, e são três os caminhos:

1. Desenvolver você mesmo: faz sentido para site próprio, app de vendedor ou painel de BI, principalmente se a loja tem TI. A manutenção entra na conta, porque o que você constrói precisa acompanhar o ERP e as mudanças de cada canal.
2. Contratar um integrador: ele constrói e mantém a ponte com os canais. O módulo continua à parte, com a IdealSoft.
3. Usar um aplicativo pronto: é a saída de quem não quer desenvolver nada. Os aplicativos de parceiros estão listados na página de aplicativos adicionais da IdealSoft, e o guia de integração mostra onde achá-la.

O Gumo Hub é um desses aplicativos.

Perguntas frequentes sobre a API Shop

Preciso de programador para usar a API?

Só se você for desenvolver por conta própria. Com um integrador ou um aplicativo pronto, a programação fica com eles. O módulo Integrações é necessário nos três caminhos.

O módulo Integrações vem no meu plano? Quanto custa?

É um módulo à parte. Confirme com o comercial da IdealSoft se o seu plano é elegível e qual é o valor, porque as condições são dela.

A API Shop publica meus produtos no Mercado Livre?

Não. Ela entrega os dados do ERP. A publicação no canal fica com o sistema que consome a API: um hub como o Gumo Hub, um integrador ou um desenvolvimento próprio.

Existe documentação e ambiente de testes?

Sim. A IdealSoft publica a documentação técnica e oferece uma área de homologação com base de testes, liberada pelo suporte dela.

Fonte: documentação técnica da API do módulo Integrações, da IdealSoft, consultada em 11/10/2026.