ExlogWMS Manual de uso
Acessar o Sistema
Integrações

Cadastro de produto por link (API)

Como deixar outro sistema — uma loja virtual, um ERP, uma automação ou o Postman — cadastrar produtos no ExlogWMS: gerar o link, enviar o produto em JSON e conferir o resultado. Com modelos prontos para copiar.

Em resumo A empresa gera um link na tela Minha empresa e entrega a quem vai integrar. Quem tem o link envia o produto em JSON (uma chamada POST) e recebe a resposta na hora. Não há usuário nem senha: o link é a senha. O link só cadastra produto novo; nunca altera o que já existe.
1

Como funciona

1a

O caminho do produto

  1. A empresa gera um link para um seller. Todo produto enviado por esse link entra nesse seller, na unidade dele.
  2. O outro sistema envia um produto por chamada, com os dados em JSON.
  3. O ExlogWMS confere os dados e responde na mesma hora: cadastrou, ou recusou dizendo o motivo.
  4. O produto entra com estoque zero. A entrada de estoque continua sendo feita pelo recebimento.
1b

O que o link faz e o que não faz

  • Faz: cadastra produto novo, simples ou com variações.
  • Não faz: não altera, não consulta e não apaga produto. Se o SKU ou o código já existir no seller, a chamada é recusada e nada muda.
O link é uma senhaQuem tiver o link consegue cadastrar produtos no seller. Entregue só a quem precisa, não publique em grupo nem em repositório de código e, se o link vazar, desligue e gere outro (passo 8).
2

Gerar o link

2a

Abrir a seção Links de cadastro

No menu lateral, abra Configurações e clique em Empresa. Na lista de seções à esquerda, clique em Links de cadastro (fica depois de Integrações).

A seção lista os links já gerados, com o nome, o começo do código, o seller, a validade, o limite por dia, as chamadas de hoje, o último uso e a situação.

Seção Links de cadastro da tela Minha empresa, com a lista de links e o botão Gerar link
Print pendenteassets/img/api-cadastro-produto/secao-links.png
Figura 1 — Seção Links de cadastro, na tela Minha empresa.
2b

Preencher e gerar

  1. Clique em Gerar link.
  2. Em Nome do link, escreva algo que ajude a reconhecer depois (ex.: Loja virtual).
  3. Em Seller que recebe os produtos, escolha o seller. Seller que aparece como (sem unidade) não pode receber link: edite o seller e informe a unidade primeiro.
  4. Validade em dias é opcional. Em branco, o link não vence.
  5. Limite de chamadas por dia já vem com 500. Contam as chamadas aceitas e as recusadas.
  6. Clique em Gerar link.
Janela Gerar link de cadastro de produto, com os campos Nome do link, Seller que recebe os produtos, Validade em dias e Limite de chamadas por dia
Print pendenteassets/img/api-cadastro-produto/janela-gerar-link.png
Figura 2 — Janela Gerar link de cadastro de produto.
2c

Copiar o link na hora

Abre a janela Link gerado. Clique em Copiar link e guarde em local seguro antes de fechar.

O link aparece uma única vezPor segurança, o ExlogWMS não guarda o link completo. Depois de fechar a janela, ele não pode ser mostrado de novo. Se perder, desligue esse link e gere outro.
Janela Link gerado, com o aviso de que o link não será mostrado de novo, o link, o botão Copiar link e um exemplo de JSON
Print pendenteassets/img/api-cadastro-produto/janela-link-gerado.png
Figura 3 — Janela Link gerado: copie antes de fechar.
3

Enviar o produto

3a

A chamada

ItemValor
MétodoPOST
EndereçoO link completo, exatamente como foi copiado, com o ?link=... no fim.
AutenticaçãoNenhuma. Não envie usuário, senha nem chave.
CabeçalhoContent-Type: application/json
CorpoUm produto, em JSON (modelos no passo 4).

O link tem este formato (o código abaixo é só um exemplo):

Formato do link
https://n8n.srv1206270.hstgr.cloud/webhook/exlog-produto?link=0000000000000000000000000000000000000000000000000000000000000000
3b

Campos do produto

CampoTipoRegra
nome obrigatóriotextoNome do produto, até 255 caracteres.
sku obrigatóriotextoAté 255 caracteres. Não pode repetir no seller.
codigonúmeroCódigo do produto, até 18 dígitos. Sem ele, o sistema usa o EAN quando o EAN é só números.
eantextoCódigo de barras, até 20 caracteres.
descricaotextoAté 2000 caracteres.
fabricantetextoAté 255 caracteres.
ncm, cfoptextoAté 10 caracteres cada.
id_categorianúmeroNúmero de uma categoria que já existe na empresa.
volumenúmeroCom ponto decimal (ex.: 0.5).
estoque_minimonúmero inteiroEstoque de segurança.
preco_venda, preco_custonúmeroCom ponto decimal e até 2 casas (ex.: 49.90).
imagem_urltextoEndereço da imagem. Precisa começar com https://; até 500 caracteres.
usa_caixaS ou NS = o produto usa caixa (LPN) na separação. Sem o campo, vale N.
variacoeslistaVariações do produto (passo 3c). Sem a lista, o produto é simples.

Campo que não está nesta tabela é ignorado.

3c

Campos de cada variação

Use variacoes quando o mesmo produto tem versões (tamanho, cor, voltagem). O produto e as variações entram juntos: se uma variação for recusada, nada é gravado. São aceitas até 100 variações por produto.

CampoTipoRegra
descricao obrigatóriotextoNome da variação (ex.: P, Azul), até 100 caracteres.
sku obrigatóriotextoAté 100 caracteres. Não repete na lista nem em outra variação do seller.
eantextoSó números, até 18 dígitos.
preco_vendanúmeroCom ponto decimal e até 2 casas.
imagem_urltextoPrecisa começar com https://; até 100 caracteres.
detalhe, observacaotextoAté 100 caracteres cada.

O estoque e o preço principal ficam no produto. Cada variação guarda a própria descrição, o SKU, o código de barras e, se informado, o preço.

4

Modelos de JSON

Copie o modelo mais próximo do seu caso e troque os valores. Em todos, os números vão com ponto e sem aspas.

4a

Produto simples — só o obrigatório

Corpo da chamada

          
4b

Produto simples — todos os campos

Corpo da chamada

          
4c

Produto com variações

A terceira variação mostra os campos opcionais; as duas primeiras, só o necessário.

Corpo da chamada

          
4d

O que volta quando dá certo

Guarde o id_produto: é o número do produto no ExlogWMS.

Resposta 201 — produto simples

          
Resposta 201 — produto com variações

          
4e

O que volta quando é recusado

Toda recusa traz sucesso: false e uma mensagem. Quando o problema está nos dados, a lista erros diz o campo e o motivo. Em variação, o campo vem como variacoes[2].sku — o número é a posição na lista, começando em 1.

Resposta 422 — dados recusados

          
Resposta 409 — produto já existe

          
5

Respostas

O código HTTP diz o resultado. Só o 201 grava alguma coisa.

CódigoO que significaO que fazer
201Produto cadastrado.Guarde o id_produto.
400O corpo não é um JSON de produto, ou é grande demais.Confira o JSON e envie um produto por chamada.
401Link inválido.Confira se o link foi copiado inteiro, com o ?link=.
403Link desligado ou vencido, ou o seller do link foi inativado.Peça um link novo à empresa.
409Já existe produto com esse SKU ou código (ou variação com esse SKU).Nada a fazer: o produto já está cadastrado. O link não altera produto.
422Algum campo foi recusado.Corrija os campos apontados em erros e envie de novo.
429O link atingiu o limite de chamadas do dia.Envie o restante no dia seguinte ou peça à empresa um limite maior.
500, 502Falha inesperada. Nada foi gravado.Repita a chamada. Se continuar, fale com o suporte.
503O cadastro por link está desligado no ExlogWMS.Fale com o suporte.
6

Testar no Postman

6a

Importar a requisição pronta

  1. Baixe o arquivo de descrição da API pelo botão abaixo.
  2. No Postman, clique em Import e escolha o arquivo baixado. O Postman cria a coleção com a requisição Cadastra um produto novo.
  3. Abra a requisição e, na aba Params, troque o valor de link pelo código do seu link (os 64 caracteres depois de ?link=).
  4. Na aba Body, ajuste os dados do produto e clique em Send.
Arquivo OpenAPI 3 (JSON). Também abre em qualquer ferramenta compatível com Swagger.
6b

Montar na mão

  1. Crie uma requisição e escolha o método POST.
  2. Cole o link completo no campo do endereço.
  3. Na aba Authorization, deixe em No Auth.
  4. Na aba Body, escolha raw e, na lista ao lado, JSON.
  5. Cole um dos modelos do passo 4 e clique em Send.
Coleção compartilhadaSe a requisição for salva em uma coleção compartilhada do Postman, o link vai junto e todos os membros passam a tê-lo.
7

Referência interativa

A mesma descrição, em formato Swagger. Para testar daqui: clique em POST /exlog-produto, depois em Try it out, cole o código do seu link em link, escolha um exemplo e clique em Execute.

O teste é de verdadeCom um link válido, o Execute cadastra o produto no ExlogWMS. Use um SKU de teste e avise a empresa para remover depois.

Carregando a referência interativa…

8

Acompanhar e desligar

8a

Ver as chamadas de um link

Na seção Links de cadastro, clique em Chamadas na linha do link. A janela mostra as 50 chamadas mais recentes, com a data, o resultado (Cadastrado ou Recusado com o código), o SKU e a mensagem devolvida.

Janela Chamadas do link, com as colunas Quando, Resultado, SKU e Mensagem
Print pendenteassets/img/api-cadastro-produto/janela-chamadas.png
Figura 4 — Chamadas recebidas em um link.
8b

Desligar ou ligar um link

Clique em Desligar na linha do link e confirme. A partir daí, quem usa esse link recebe a recusa 403 e não cadastra mais nada. Para voltar atrás, clique em Ligar.

Desligue sempre que o link tiver sido exposto, quando a integração for encerrada ou quando a pessoa que recebeu o link sair do projeto.

8c

Situações do link

SituaçãoO que significa
AtivoRecebe chamadas normalmente.
DesligadoFoi desligado pela empresa. Não recebe chamadas até ser ligado de novo.
VencidoPassou da validade. Gere um link novo.
?

Dúvidas frequentes

Perdi o link. Dá para ver de novo?

Não. O ExlogWMS não guarda o link completo. Desligue o link perdido e gere outro; quem integra precisa trocar o endereço pelo novo.

Posso mandar vários produtos de uma vez?

Não. É um produto por chamada. Para cadastrar muitos, o outro sistema faz uma chamada para cada produto. Um produto pode levar até 100 variações na mesma chamada.

Como altero um produto que já foi cadastrado?

Pelo link não é possível: ele só cadastra produto novo. A alteração é feita na tela de cadastro de produto do ExlogWMS.

Recebi 409, mas quero cadastrar assim mesmo.

O 409 significa que já existe um produto com o mesmo SKU ou o mesmo código nesse seller (ou uma variação com o mesmo SKU). Confira o cadastro no ExlogWMS; se for outro produto, use um SKU diferente.

Mandei as variações e veio 201, mas o produto ficou sem variação.

Confira o nome do campo: precisa ser exatamente variacoes, sem acento e no plural, e o valor precisa ser uma lista entre colchetes. Campo com outro nome é ignorado. Quando as variações entram, a resposta 201 traz a lista variacoes com o número de cada uma.

Dá para cadastrar um kit pelo link?

Ainda não. O link cadastra produto simples e produto com variações. O kit e a composição dele são cadastrados na tela de cadastro de produto do ExlogWMS. Campos de kit enviados no JSON são ignorados e o produto entra como simples.

O preço foi recusado.

Use ponto como separador decimal e no máximo 2 casas: 49.90. Vírgula, símbolo de moeda e separador de milhar são recusados.

Preciso de um link para cada seller?

Sim. Cada link pertence a um seller, e é para ele que os produtos vão. Um mesmo seller pode ter mais de um link (por exemplo, um para cada sistema que integra).

O botão Gerar link está apagado.

O cadastro por link está desligado no ExlogWMS no momento, e a seção mostra um aviso. Fale com o suporte.