1. Produtos
WebgexERP API
  • Webgex API v2
    • Introdução
    • Padrão de Response
    • Endpoints
      • Cadastros
        • Organização
          • Unidades
            • Unidades
          • Centros de Resultado
            • Centros de Resultado
          • Armazens
            • Armazéns
          • Plano de Contas
            • Plano de Contas
          • Naturezas Financeiras
            • Naturezas Financeiras
          • Itens Contábeis
            • Itens Contábeis
          • Classificações Contábeis
            • Classificações Contábeis
          • Códigos de Remuneração
            • Códigos de Remuneração
        • Pessoas Físicas/Jurídicas
          • Clientes
            • Cliente
            • Clientes
          • Fornecedores
            • Fornecedor
            • Fornecedores
            • Detalhes do Fornecedor
          • Parceiros
            • Parceiro
            • Parceiros
            • Detalhes do Parceiro
          • Empregados
            • Empregado
            • Empregados
            • Detalhes do Empregado
          • Grupos Empresariais
            • Grupos Empresariais
        • Produtos e Serviços
          • Categorias
            • Categorias
          • Produtos
            • Produto
            • Produtos
          • Serviços
            • Serviços
            • Detalhes do Serviço
          • Materiais
            • Materiais
            • Detalhes do Material
          • Produtos Base
            • Produtos Base
            • Detalhes do Produto Base
          • Produtos Variantes
            • Produtos Variantes
          • Kits e Composições
            • Kits e Composições
          • Preços
            • Preços
            • Preço
      • Lançamentos
        • Despesas
          • Despesas
          • Detalhes da Despesa
          • Criar Despesa
          • Folha de Pagamento
        • Documentos Fiscais
          • Notas Fiscais Emitidas
            • Notas Fiscais Emitidas
            • Detalhes da Nota Fiscal Emitida
          • Notas Fiscais ao Consumidor Emitidas
            • Notas Fiscais ao Consumidor Emitidas
            • Detalhes da nota fiscal ao consumidor emitida
          • Cupons Fiscais Emitidos
            • Cupons Fiscais Emitidos
            • Detalhes do Cupom Fiscal Emitido
          • Notas Fiscais de Serviço Emitidas
            • Notas Fiscais de Serviço Emitidas
            • Detalhes da Nota Fiscal de Serviço Emitidas
          • Notas Fiscais de Entrada
            • Notas Fiscais Recebidas
            • Detalhes da Nota fiscal de Entrada
          • Conhecimentos de Frete
            • Conhecimentos de Frete Recebidos
      • Controladoria
        • Escrita Fiscal
          • Impostos
        • Contabilidade
          • Lançamentos Contábeis
            • Lançamentos Contábeis
          • Saldos Contábeis
            • Saldos Contábeis
        • Orçamento
          • Orçamento
            • Orçamento
        • Imobilizado
          • Itens de Imobilizado
            • Itens de Imobilizado
      • Financeiro
        • Tesouraria
          • Contas, Caixas e Cartões
            • Contas, Caixas e Cartões
          • Saldos das Contas
            • Saldos das Contas
        • Contas a Pagar
          • Contas a Pagar
            • Contas a Pagar*
        • Contas a Receber
          • Contas a Receber
            • Contas a Receber*
      • Operacional
        • Controle de Estoque
          • Posição de Estoque
            • Posição de Estoque
        • Compras
          • Carteira Pedidos de Compra
            • Carteira Pedidos de Compra
          • Histórico de Compras
            • Histórico de Compras
        • Projetos e Contratos
          • Projetos
            • Projetos
          • Gestão de Projetos
            • Gestão de Projetos
        • Serviços
          • Veículos
            • Veículos
          • Histórico de Serviços
            • Histórico de Veículos
        • Ordens de Serviço
          • Ordens de Serviço Automotivas
          • Detalhes da Ordem de Serviço Automotiva
      • Relatórios
        • Relatórios de Vendas
          • Vendas Detalhadas
      • Configuração
        • Acessos e Auditoria
          • Utilizadores
            • Utilizadores
        • Parametrização
          • Transações
            • Transações*
      • Crm
        • Crm Gerencial
          • Oportunidades
            • Oportunidade
    • Raiz
    • Esquemas
      • OrdemServicoAutomotivaCabecalho
      • OportunidadeRequest
      • OrdemServicoAutomotivaItem
      • Cliente
      • OrdemServicoAutomotivaPagamento
      • Endereco
      • OrdemServicoAutomotivaDetalhe
      • Item
      • Pagamento
      • CreatedEnvelope
      • ProblemDetail
  • Webgex API v2 — Produto
    • Raiz
      • Produtos
        • Produto
          POST
    • Esquemas
      • ProdutoRequest
      • VarianteRequest
      • ProdutoCreatedEnvelope
      • ProblemDetail
  1. Produtos

Produto

POST
/erp-produto
Cria um produto base com suas variantes ou, com atualiza: true, atualiza um produto existente.

Inclusão ou atualização#

O produto é localizado pelo par tipo + codigo_produto.
Não existe: é criado (201).
Existe e atualiza não é true: nada é alterado (204).
Existe e atualiza: true: atualiza somente os campos enviados no produto base (204).
Campos omitidos ou vazios não são alterados. Campos atualizáveis: nome_produto,
unidade_referencia, movimenta_estoque, indicativo_estoque, garantia_cl, garantia_fn,
seguro, status, origem (ou cfpsr), cest e GTIN.
As variantes existentes não são alteradas (peso, dimensões, referências, nome e situação
ficam como estão), com exceção do GTIN, que é replicado para todas elas. A grade do produto
não é alterada pela atualização. Variantes novas enviadas em variantes são incluídas.

Código do produto#

Omita codigo_produto (ou envie %) para o ERP gerar o código automaticamente, conforme a
parametrização de código do tipo do produto. Se o tipo não tiver geração automática configurada,
a requisição é recusada e o código deve ser enviado. Um código já usado por outro tipo de item é
recusado.

GTIN (código de barras)#

O GTIN pertence ao produto base e é gravado igual em todas as variantes. GTIN enviado dentro
de variantes é ignorado (com aviso). Um GTIN já cadastrado em outro produto base é recusado.

Grade (cor, tamanho etc.)#

Para produto com grade, informe o tipo de grade em tipo_grade_1 / tipo_grade_2 (códigos
cadastrados em Variantes do ERP) e liste em variantes exatamente as combinações a criar,
usando os códigos das variantes (ex.: AZU, não AZUL). O ERP não gera a matriz completa.
Produto com grade sem a lista variantes é recusado. Sem grade, o produto recebe uma única
variante padrão; duas variantes sem grade são a mesma variante (a segunda é ignorada, com aviso).

Avisos#

Dados não aceitos que não impedem o cadastro (categoria inexistente, unidade fora do cadastro,
GTIN informado na variante, variante repetida, CST ICMS não cadastrado) são devolvidos em
content.avisos no 201. Na atualização (204) não há corpo de resposta.

O que o endpoint não faz#

Não cria preço de venda (use POST /erp-preco) e não dispara webhooks de produto.

Requisição

Authorization
API Key
Adicionar parâmetro em header
WGX-API-KEY
Exemplo:
WGX-API-KEY: ********************
or
Parâmetros Bodyapplication/jsonObrigatório

Examples

Respostas

🟢201
application/json
Produto criado. content traz o código e o ID do produto base e de cada variante.
Bodyapplication/json

🟢204
🟠400
🟠401
🟠429
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location '/erp-produto' \
--header 'WGX-API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "nome_produto": "Placa Sensor de Giro DS-18911-SF",
    "id_classificacao_contabil": 1,
    "tipo": "P",
    "categoria": "00100",
    "unidade_referencia": "UN",
    "ncm": "85437099",
    "cest": "0100100",
    "marca": "HIKVISION",
    "modelo": "DS-18911-SF",
    "origem": "2",
    "cst_icms": "00",
    "cst_ibs_cbs": "000",
    "cclastrib": "000001",
    "GTIN": "7891234567918",
    "referencia_fabricante": "DS-18911-SF",
    "peso_bruto": 0.15,
    "peso_liquido": 0.12,
    "status": "PD"
}'
Response Response Example
201 - Sucesso
{
    "success": true,
    "status": "CREATED",
    "date": "2026-11-04T12:06:47.787189",
    "contentType": "application/json",
    "content": {
        "status": "INSERTED",
        "ipsr": "0011398",
        "zk_bpsr": 27079,
        "bpsi": {
            "status": "INSERTED",
            "ipsr": "0011398",
            "ccst": "00",
            "ufs": 6
        },
        "avisos": [],
        "variantes": [
            {
                "status": "INSERTED",
                "ipsv": "0011398000001",
                "zk": 17005,
                "ivar1": "AZU",
                "ivar2": "P",
                "npsv": "CAMISETA BASICA AZUL TAMANHO P"
            },
            {
                "status": "INSERTED",
                "ipsv": "0011398000002",
                "zk": 17006,
                "ivar1": "AZU",
                "ivar2": "M",
                "npsv": "CAMISETA BASICA AZUL TAMANHO M"
            },
            {
                "status": "INSERTED",
                "ipsv": "0011398000003",
                "zk": 17007,
                "ivar1": "VER",
                "ivar2": "G",
                "npsv": "CAMISETA BASICA VERMELHO TAMANHO G"
            }
        ]
    }
}
Modificado em 2026-11-04 19:33:55
Página anterior
ProblemDetail
Próxima página
ProdutoRequest
Built with