Histórico da Página

Tempo aproximado para leitura: 10 min

Objetivo

Método que permite inserir/atualizar o produto.

Chamada

POST api/v1/importacao/produto

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Não há.

Parâmetros do Corpo (Body Parameters)

Nome (Name)	Descrição (Description)	Tipo (Type)	Informações Adicionais (Adittional Information)
SEQPRODUTO*	Código sequencial do produto.	integer
NROEMPRESA*	Número da empresa ou código do depositante (quando utilizado Operador Logístico).	integer	Valor Máximo: 999
SEQFORNECEDOR*	Código ou CNPJ do fornecedor. Vinculado ao campo TIPCODIGO.	integer
TIPCODIGO*	Tipo do código do fornecedor: I – Código Interno(Padrão) C – CNPJ.	string	Tamanho Máximo: 1
CODTIPENDERECO	Código do tipo do endereço(normal, alto, baixo, etc.) previamente cadastrado no ACRUX LOCUS PARÂMETRO / Tipos de Endereços. Caso esse campo não seja enviado, será considerado o valor padrão "N".	string	Tamanho Máximo: 3
DESCCOMPLETA*	Descrição completa do produto.	string	Tamanho Máximo: 70
DESCREDUZIDA*	Descrição reduzida do produto.	string	Tamanho Máximo: 20
STATUSCOMPRA*	Status de compra do produto: A – Ativo I – Inativo.	string	Tamanho Máximo: 1
STATUSVENDA*	Status de venda do produto: A – Ativo I – Inativo.	string	Tamanho Máximo: 1
TIPARMAZENAGEM	Tipo de armazenagem do produto, previamente cadastrado no ACRUX LOCUS PARÂMETRO / Atributo Fixo. Caso esse campo não seja enviado, será considerado o valor padrão "N".	string	Tamanho Máximo: 5
TIPSEPARACAO	Tipo de separação do produto, previamente cadastrado no ACRUX LOCUS PARÂMETRO / Atributo Fixo. Caso esse campo não seja enviado, será considerado o valor padrão "N".	string	Tamanho Máximo: 1
PZOVALIDADEDIA*	Prazo de validade do produto a partir da data da fabricação(em dias). Caso não utilize este conceito enviar "0".	integer	Valor Máximo: 9999
PESAVEL	Indica se o produto é pesável: S – Sim N – Não.	string	Tamanho Máximo: 1

ADVARMAZENAGEMAdvertência de Armazenagem. Mensagem que será mostrada no momento da armazenagem do produto.stringTamanho Máximo: 80

EMTETIQUETA	Indicador de emissão de etiquetas de códigos de barra: S – Sim N – Não. Quando "S", emite as etiquetas que vão substituir códigos dos produtos que não possuem código de barras. Caso esse campo não seja enviado, será considerado o valor padrão "S".	string	Tamanho Máximo: 1
INDPROCFABRICACAO	Indica se é um produto de composição: S – Sem processo de produção B – Produto base para desmembramento F – Produto final composto V – Produto de composição variável I – Insumo para produção C – Composto para separação. Caso esse campo não seja enviado, será considerado o valor padrão "S".	string	Tamanho Máximo: 1
MEDVDIAGERAL	Média de venda geral por dia. Valor da média de venda geral do produto.	decimal (12,6)	Valor Máximo: 999999,999999
EXGNROLOTE	Indica se o produto exige que seja informado lote de fabricação: S – Sim N – Não.	string	Tamanho Máximo: 1
SEQPRODUTOBASE	Código sequencial do produto base.	integer
ADVARMAZENAGEM	Advertência de Armazenagem. Mensagem que será mostrada no momento da armazenagem do produto.	string	Tamanho Máximo: 80
REFFABRICANTE	Descrição da referência do produto enviada pelo fabricante.	string	Tamanho Máximo: 20
EXGNROSERIE	Indica se o produto exige que seja informado o número da série na conferência: S – Sim N – Não.	string	Tamanho Máximo: 1
QTDTOLARMAZPROD	Quantidade para tolerância na armazenagem.	integer	Valor Máximo: 999999999
REFERENCIA	Referência do produto que será concatenada na descrição completa do produto.	string	Tamanho Máximo: 20
UTZESTRUTDRIVEIN	Indica se o produto utiliza estrutura Drive-In: S – Sim N – Não.	string	Tamanho Máximo: 1
EXGCERTIFICADO	Indica se o produto exige certificado: S – Sim N – Não.	string	Tamanho Máximo: 1
INDALTORISCO	Indica se o produto é de alto risco: S – Sim N – Não. Parâmetro vinculado ao processo de Sorter.	string	Tamanho Máximo: 1
INDEXGVALIDACAOMONTAGEMPALETE	Indica se o produto exige validação na montagem do palete: S – Sim N – Não. Parâmetro vinculado ao processo de Sorter.	string	Tamanho Máximo: 1
QTDVOLGERAETQMASTER	Quantidade de volumes para que seja gerada etiqueta master automaticamente, para que não passe pelo processo de montagem. Parâmetro vinculado ao processo de Sorter.	integer	Valor Máximo: 999
SEQFAMILIA	Código sequencial da família do produto.	integer

USUARIOALTERACAOUsuário que realizou a última alteração no cadastro do produto.stringTamanho Máximo: 12INDCONTROLATEMPERATURAIndica se o produto controla temperatura:


INDCONTROLATEMPERATURA	Indica se o produto controla temperatura: S – Sim N – Não. Parâmetro vinculado ao processo de conferência de recebimento.	string	Tamanho Máximo: 1
INDCONTROLARASTREABILIDADE	Indica se o produto controla rastreabilidade: S – Sim N – Não. Parâmetro vinculado ao processo de rastreabilidade.	string	Tamanho Máximo: 1
QTDDIASCONTROLEQUARENTENA	Quantidade de dias para controle de rastreabilidade. Parâmetro vinculado ao processo de rastreabilidade. Obrigatório caso o campo INDCONTROLARASTREABILIDADE esteja marcado como "S".	integer	Valor Máximo: 999

SEQPRODUTOBASECódigo sequencial

USUARIOALTERACAO

Usuário que realizou a última alteração no cadastro do produto

base

.

integer

string

Tamanho Máximo: 12

*Campos Obrigatórios

Validações Logísticas

As validações logísticas, não impactam no retorno da requisição. Entretanto, para a correta importação do produto, os critérios listados abaixo devem ser atendidos. Caso contrário, será gerada uma crítica logística**, e o registro ficará pendente de verificação por um usuário.

O Tipo de Endereço (CodTipEndereco) deverá estar cadastrado previamente no Cadastro de Tipos de Endereco (WMS Parâmetros → Cadastro → Endereço → Tipos de Endereços);
O Tipo da Separação (TipSeparacao) deverá estar cadastrado previamente no Cadastro de Atributos Fixos, na opção Tipo de Atributo: Tipo de Separação (WMS Parâmetros → Cadastro → Atributos Fixos);
O Tipo da Armazenagem (TipArmazenagem) deverá estar cadastrado previamente no Cadastro de Atributos Fixos, na opção Tipo de Atributo: Tipo de Armazenagem (WMS Parâmetros → Cadastro → Atributos Fixos);
O Fornecedor (SeqFornecedor) deverá estar cadastrado previamente no sistema;
O Produto Base (SeqProdutoBase) não poderá estar relacionado a outro produto;
O Produto Base (SeqProdutoBase) não poderá ter a propriedade Pesável diferente do produto relacionado.

_{**As críticas logísticas podem ser visualizadas através da aplicação: WMS Centro de Distribuição -> Gerencial -> Consultas -> Exclusão de Rejeições da Importação Automática.}

Formatos de Request (Request Formats)

application/json, text/json

Bloco de código

language	actionscript3

{
   "seqProduto": 11,
  "nroEmpresa": 100,  
  "seqFornecedor": 752,
  "tipCodigo": "I",
  "codTipEndereco": "N",
  "descCompleta": "Teste descriçao completa",
  "descReduzida": "Teste reduzida",
  "statusCompra": "A",
  "statusVenda": "A",  
  "tipArmazenagem": "N",
  "tipSeparacao": "N",
  "pzoValidadeDia": 100,
  "pesavel": "N",
  "emtEtiqueta": "N",
  "indProcFabricacao": "S",
  "medVDiaGeral": 1500.000000,
  "ExgNroLoteexgNroLote" : "N",
  "AdvArmazenagemseqProdutoBase": 1,
  "advArmazenagem": "Teste Advertencia",
  "RefFabricanterefFabricante" : "Teste Ref.Fabricante",
  "ExgNroSerieexgNroSerie" : "N",
  "QtdTolArmazProdqtdTolArmazProd" : 1,
  "Referenciareferencia" : "Teste Referencia",
  "UtzEstrutDriveInutzEstrutDriveIn" : "N",
  "ExgCertificadoexgCertificado" : "N",
  "IndAltoRiscoindAltoRisco" : "N",
  "IndExgValidacaoMontagemPaleteindExgValidacaoMontagemPalete" : "N",
  "QtdVolGeraEtqMasterqtdVolGeraEtqMaster" : null,
  "SeqFamiliaseqFamilia" : null,
  "IndControlaTemperatura" indControlaTemperatura": "N",
  "indControlaRastreabilidade": "N",
  "IndControlaRastreabilidadeqtdDiasControleQuarentena": 1,
  "usuarioAlteracao": "SCONSINCO",
  "QtdDiasControleQuarentenaembalagensProduto": [
    {        
	  "qtdEmbalagem": 1,
  	  "UsuarioAlteracaoembalagem" : "CONSINCOUN"
}

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

OK (201)
BadRequest (400)

,
  	  "statusEmbalagem": "A",
  	  "indMiudezaGrandeza": "M",  
  	  "indEmbalado": "S",
  	  "codTara": "1",
  	  "pesoBruto": 1.5,
  	  "pesoLiquido": 1.25,
  	  "altura": 50.12,
  	  "largura": 25.0,
  	  "profundidade": 25.0,
  	  "pesoMedio": 1.5,
	  "indPadraoEmbCompra": "S",
  	  "indPadraoEmbVenda": "N"       
	}
  ],
  "codigosBarrasProduto": [
    {       
	  "qtdEmbalagem": 1.0,
      "codAcesso": "1234567890",
      "tipCodigo": "B"     
	}
  ],
  "especiesEnderecoProduto": [
    {         
	  "qtdEmbalagem": 12,
      "especieEndereco": "A",
      "paleteLastro": 10,
      "paleteAltura": 1,
      "estqMinimoRep": 10      
	}
  ]
  "categoriaProduto": {
    "nroDivisao": 1,
    "seqCategoria": 102
  },
  "componentesProdutoComposto": [
    {
  	  "seqProdComponente": 12987,
  	  "qtdEmbalagem": 1,
  	  "quantidade": 15
    }
  ]
}

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

OK (201)
BadRequest (400)

Requisições para adicionar as informações complementares do Produto:

*Campos Obrigatórios

Validações Logísticas

As validações logísticas, não impactam no retorno da requisição. Entretanto, para a correta importação dos componentes do produto, os critérios listados abaixo devem ser atendidos. Caso contrário, será gerada uma crítica logística***, e o registro ficará pendente de verificação por um usuário.

O produto final (SeqProdFinal) deverá estar cadastrado previamente na empresa (NroEmpresa) informada.
O produto componente (SeqProdComponente) deverá estar cadastrado previamente na empresa (NroEmpresa) informada.
A embalagem (QtdEmbalagem) deverá estar cadastrada previamente para o SeqProdComponente informado.

_{***As críticas logísticas podem ser visualizadas através da aplicação: WMS Centro de Distribuição -> Gerencial -> Consultas -> Exclusão de Rejeições da Importação Automática.}

Formatos de Request (Request Formats)

application/json, text/json

Totvs custom tabs box

tabs	Embalagem do Produto, Código de Barras do Produto, Espécie de Endereço do Produto, Categoria do Produto, Componentes do Produto Composto
ids	passo1,passo2,passo3,passo4,passo5

Totvs custom tabs box items

default	yes
referencia	passo1

Adicionar Embalagem do Produto - POST

Objetivo

Método que permite inserir/atualizar as embalagens dos produtos. Podem ser enviadas várias embalagens, de compra ou de venda, para um mesmo produto, sendo exigido pelo menos uma de cada tipo.

Chamada

POST api/v1/importacao/produto/embalagem

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Não há.

Parâmetros do Corpo (Body Parameters)

Nome (Name)	Descrição (Description)	Tipo (Type)	Informações Adicionais (Adittional Information)
SEQPRODUTO*	Código sequencial do produto.	integer
NROEMPRESA*	Número da empresa ou código do depositante (quando utilizado Operador Logístico).	integer	Valor Máximo: 999
QTDEMBALAGEM*	Quantidade de unidades dentro de cada embalagem.	decimal (8,3)	Valor Máximo: 99999,999
EMBALAGEM*	Descrição da embalagem. Exemplo UN, CX, LT, etc.	string	Tamanho Máximo: 3
STATUSEMBALAGEM*	Status da embalagem: A – Ativo I – Inativo.	string	Tamanho Máximo: 1
INDMIUDEZAGRANDEZA	Indica se a embalagem do produto corresponde à: M – Miudeza G – Grandeza

Totvs custom tabs box

tabs	Embalagem do Produto, Código de Barras do Produto, Espécie de Endereço do Produto, Categorias dos Produtos, Componentes do Produto Composto
ids	passo1,passo2,passo3,passo4,passo5

Indica se a embalagem é padrão de venda:
N – Não
S – Sim.

Obs. Na importação da primeira embalagem do produto ela será considerada padrão de venda independente do valor passado e quando vier uma nova embalagem setada como padrão de venda, esta nova será considerada e a anterior deixará de ser padrão

Totvs custom tabs box items

default	yes
referencia	passo1

Adicionar Embalagem do Produto - POST

Objetivo

Método que permite inserir/atualizar as embalagens dos produtos. Podem ser enviadas várias embalagens, de compra ou de venda, para um mesmo produto, sendo exigido pelo menos uma de cada tipo.

Chamada

POST api/v1/importacao/produto/embalagem

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Não há.

Parâmetros do Corpo (Body Parameters)

Nome (Name)

Descrição (Description)

Tipo (Type)

Informações Adicionais (Adittional Information)

SEQPRODUTO*

Código sequencial do produto.

integer

NROEMPRESA*

Número da empresa ou código do depositante (quando utilizado Operador Logístico).

integer

Valor Máximo: 999

QTDEMBALAGEM*

Quantidade de unidades dentro de cada embalagem.

decimal (8,3)

Valor Máximo: 99999,999

EMBALAGEM*

Descrição da embalagem. Exemplo UN, CX, LT, etc.

string

Tamanho Máximo: 3

STATUSEMBALAGEM*

Status da embalagem:
A – Ativo
I – Inativo.

string

Tamanho Máximo: 1

INDMIUDEZAGRANDEZA

Indica se a embalagem do produto corresponde à:
M – Miudeza
G – Grandeza.

string

Tamanho Máximo: 1

PESOBRUTO**

Peso bruto na embalagem do produto. Unidade de medida: quilo (kg).

decimal (7,3)

Valor Máximo: 9999,999

PESOLIQUIDO**

Peso líquido na embalagem do produto. Unidade de medida: quilo (kg).

decimal (7,3)

Valor Máximo: 9999,999

ALTURA**

Altura na embalagem do produto. Unidade de medida: centímetro (cm).

decimal (9,6)

Valor Máximo: 999,999999

LARGURA**

Largura na embalagem do produto. Unidade de medida: centímetro (cm).

decimal (9,6)

Valor Máximo: 999,999999

PROFUNDIDADE**

Profundidade na embalagem do produto. Unidade de medida: centímetro (cm).

decimal (9,6)

Valor Máximo: 999,999999

INDEMBALADO

Indica se a embalagem do produto corresponde o tipo embalado:
N – Não
S – Sim.

string

Tamanho Máximo: 1

CODTARA

Código da tara na embalagem do produto. A tara deve estar previamente cadastrada no WMS Parâmetros → Produtos → Tara Balança.

string

Tamanho Máximo: 10

PESOMEDIO

Peso médio da embalagem do produto. Unidade de medida: quilo (kg). Utilizada na tolerância de separação.

decimal (7,3)

Valor Máximo: 9999,999

INDPADRAOEMBCOMPRA

Indica se a embalagem é padrão de compra:
N – Não
S – Sim.

Obs. Na importação da primeira embalagem do produto ela será considerada padrão de compra independente do valor passado e quando vier uma nova embalagem setada como padrão de compra, esta nova será considerada e a anterior deixará de ser padrão.

string

Tamanho Máximo: 1

INDPADRAOEMBVENDA

.	string	Tamanho Máximo: 1
PESOBRUTO*

Campos Obrigatórios
**Campos Obrigatórios caso o parâmetro dinâmico CRITICA_PRODUTO_INFO_FISICA tenha o valor "S - Sim". Pode ser verificado em: WMS Parâmetros → Parâmetro → Dinâmico.

Validações Logísticas

As validações logísticas, não impactam no retorno da requisição. Entretanto, para a correta importação da embalagem, os critérios listados abaixo devem ser atendidos. Caso contrário, será gerada uma crítica logística***, e o registro ficará pendente de verificação por um usuário.

O Produto (SeqProduto) deverá estar cadastrada previamente para a empresa (NroEmpresa) informada;
A Empresa (NroEmpresa) deverá estar cadastrada previamente no Cadastro de Depositantes (WMS Parâmetros → Cadastro → Depositante);
O Códiga da Tara (CodTara), quando informado, deverá estar cadastrado previamente no Cadastro de Tara Balança (WMS Parâmetros → Cadastro → Produtos → Tara Balança).

_{***As críticas logísticas podem ser visualizadas através da aplicação: WMS Centro de Distribuição -> Gerencial -> Consultas -> Exclusão de Rejeições da Importação Automática.}

Formatos de Request (Request Formats)

application/json, text/json

Bloco de código

language	actionscript3

[
  {
  	"seqProduto": 1,
    "nroEmpresa": 1,
  	"qtdEmbalagem": 1,
  	"embalagem": "UN",
  	"statusEmbalagem": "A",
  	"indMiudezaGrandeza": "M",  
  	"indEmbalado": "S",
  	"codTara": "1",
  	"pesoBruto": 1.5,
  	"pesoLiquido": 1.25,
  	"altura": 50.12,
  	"largura": 25.0,
  	"profundidade": 25.0,
  	"pesoMedio": 1.5,
  	"indPadraoEmbCompra": "S",
  	"indPadraoEmbVenda": "N" 
  }
]

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

OK (201)
BadRequest (400)

Totvs custom tabs box items

default	no
referencia	passo2

*	Peso bruto na embalagem do produto. Unidade de medida: quilo (kg).	decimal (7,3)	Valor Máximo: 9999,999
PESOLIQUIDO**	Peso líquido na embalagem do produto. Unidade de medida: quilo (kg).	decimal (7,3)	Valor Máximo: 9999,999
ALTURA**	Altura na embalagem do produto. Unidade de medida: centímetro (cm).	decimal (9,6)	Valor Máximo: 999,999999
LARGURA**	Largura na embalagem do produto. Unidade de medida: centímetro (cm).	decimal (9,6)	Valor Máximo: 999,999999
PROFUNDIDADE**	Profundidade na embalagem do produto. Unidade de medida: centímetro (cm).	decimal (9,6)	Valor Máximo: 999,999999
INDEMBALADO	Indica se a embalagem do produto corresponde o tipo embalado: N – Não S – Sim.	string	Tamanho Máximo: 1
CODTARA	Código da tara na embalagem do produto. A tara deve estar previamente cadastrada no WMS Parâmetros → Produtos → Tara Balança.	string	Tamanho Máximo: 10
PESOMEDIO	Peso médio da embalagem do produto. Unidade de medida: quilo (kg). Utilizada na tolerância de separação.	decimal (7,3)	Valor Máximo: 9999,999
INDPADRAOEMBCOMPRA	Indica se a embalagem é padrão de compra: N – Não S – Sim. Obs. Na importação da primeira embalagem do produto ela será considerada padrão de compra independente do valor passado e quando vier uma nova embalagem setada como padrão de compra, esta nova será considerada e a anterior deixará de ser padrão.	string	Tamanho Máximo: 1
INDPADRAOEMBVENDA	Indica se a embalagem é padrão de venda: N – Não S – Sim. Obs. Na importação da primeira embalagem do produto ela será considerada padrão de venda independente do valor passado e quando vier uma nova embalagem setada como padrão de venda, esta nova será considerada e a anterior deixará de ser padrão.	string	Tamanho Máximo: 1

*Campos Obrigatórios
**Campos Obrigatórios caso o parâmetro dinâmico CRITICA_PRODUTO_INFO_FISICA tenha o valor "S - Sim". Pode ser verificado em: WMS Parâmetros → Parâmetro → Dinâmico.

Validações Logísticas

As validações logísticas, não impactam no retorno da requisição. Entretanto, para a correta importação da embalagem, os critérios listados abaixo devem ser atendidos. Caso contrário, será gerada uma crítica logística***, e o registro ficará pendente de verificação por um usuário.

O Produto (SeqProduto) deverá estar cadastrada previamente para a empresa (NroEmpresa) informada;
A Empresa (NroEmpresa) deverá estar cadastrada previamente no Cadastro de Depositantes (WMS Parâmetros → Cadastro → Depositante);
O Códiga da Tara (CodTara), quando informado, deverá estar cadastrado previamente no Cadastro de Tara Balança (WMS Parâmetros → Cadastro → Produtos → Tara Balança).

_{***As críticas logísticas podem ser visualizadas através da aplicação: WMS Centro de Distribuição -> Gerencial -> Consultas -> Exclusão de Rejeições da Importação Automática.}

Formatos de Request (Request Formats)

application/json, text/json

Bloco de código

language	actionscript3

[
  {
  	"seqProduto": 1,
    "nroEmpresa": 1,
  	"qtdEmbalagem": 1,
  	"embalagem": "UN",
  	"statusEmbalagem": "A",
  	"indMiudezaGrandeza": "M",  
  	"indEmbalado": "S",
  	"codTara": "1",
  	"pesoBruto": 1.5,
  	"pesoLiquido": 1.25,
  	"altura": 50.12,
  	"largura": 25.0,
  	"profundidade": 25.0,
  	"pesoMedio": 1.5,
	"indPadraoEmbCompra": "S",
  	"indPadraoEmbVenda": "N"

Objetivo

Método que permite inserir/atualizar os dados do produto composto, incluindo os dados de produto componente, quantidades, etc.

Não é obrigatório o envio dessa informação quando não for utilizado o conceito de Produto Composto.

Chamada

POST /api/v1/importacao/produto/componenteprodutocomposto

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Não há.

Parâmetros do Corpo (Body Parameters)

Nome (Name)

Descrição (Description)

Tipo (Type)

Informações Adicionais (Adittional Information)

SEQPRODFINAL*

Código sequencial do produto final que é gerado após a finalização da composição.

integer

SEQPRODCOMPONENTE*

Código sequencial do produto que serão componentes na composição do produto final acabado, que deverá estar previamente cadastrada no WMS.

integer

NROEMPRESA*

Número da empresa ou código do depositante (quando utilizado Operador Logístico).

integer

Valor Máximo: 999

QTDEMBALAGEM*

Quantidade de unidades dentro de cada embalagem do produto componente na composição do produto final acabado.

integer

Valor Máximo: 999999999999,999999

QUANTIDADE*

Quantidade utilizada do produto componente na composição do produto final acabado.

integer

Valor Máximo: 999999999999,999

Bloco de código

language	actionscript3

[
  {
  	"seqProdFinal": 120612,
  	"seqProdComponente": 12987,
  	"nroEmpresa": 100,
  	"qtdEmbalagem": 1,
  	"quantidade": 15
  }
]

Informações para

Resposta

Resposta (Response Information)

Códigos do Recurso (Response Codes)

OK (201)
BadRequest (400)

Totvs custom tabs box items

default	no
referencia	passo3	passo2

Adicionar Código de Barras do Produto - POST

Objetivo

Método que permite inserir/atualizar os códigos de barras dos produtos (códigos DUN, EAN, Internos ou Transição).

Chamada

POST api/v1/importacao/produto/codigobarras

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Não há.

Parâmetros do Corpo (Body Parameters)

Nome (Name)	Descrição (Description)	Tipo (Type)	Informações Adicionais (Adittional Information)
SEQPRODUTO*	Código sequencial do produto.	integer
NROEMPRESA*	Número da empresa ou código do depositante (quando utilizado Operador Logístico).	integer	Valor Máximo: 999
QTDEMBALAGEM*	Quantidade de unidades dentro de cada embalagem.	decimal (8,3)	Valor Máximo: 99999,999
CODACESSO*	Código de barras do produto, podendo ser EAN8, EAN13, UCC12, DUN14 ou código de barras próprio definido internamente pela empresa.	string	Tamanho Máximo: 20
TIPCODIGO*	Tipo do código do produto: E – Código de barras de unidade de consumo (EAN/UCC) D – Código de barras de unidade de despacho (DUN) I – Transição B – Código interno do produto	string	Tamanho Máximo: 1

*Campos Obrigatórios

Validações Logísticas

As validações logísticas, não impactam no retorno da requisição. Entretanto, para a correta importação do código de barras, o critério listado abaixo deve ser atendido. Caso contrário, será gerada uma crítica logística**, e o registro ficará pendente de verificação por um usuário.

A quantidade da embalagem (QTDEMBALAGEM) deverá estar previamente cadastrada para o Produto (SeqProduto) informado.

_{**As críticas logísticas podem ser visualizadas através da aplicação: WMS Centro de Distribuição -> Gerencial -> Consultas -> Exclusão de Rejeições da Importação Automática.}

Formatos de Request(Request Formats)

application/json, text/json

Bloco de código

language	actionscript3

[
  {
    "seqProduto": 1,
    "nroEmpresa": 1,
    "qtdEmbalagem": 1.0,
    "codAcesso": "1234567890",
    "tipCodigo": "B"
  }
]

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

OK (201)
BadRequest (400)

Totvs custom tabs box items

default	no
referencia	passo3

Adicionar Espécie de Endereço do Produto - POST

Objetivo

Método que permite inserir/atualizar as espécies de endereços dos produtos, incluindo os dados de norma de paletização, estoque mínimo para reposição, etc.

Não é obrigatório o envio dessa informação, e quando não é enviada, a mesma pode ser cadastrada diretamente no módulo WMS Centro de Distribuição.

Chamada

POST api/v1/importacao/produto/especieendereco

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Não há.

Parâmetros do Corpo (Body Parameters)

Nome (Name)	Descrição (Description)	Tipo (Type)	Informações Adicionais (Adittional Information)
SEQPRODUTO*	Código sequencial do produto.	integer
NROEMPRESA*	Número da empresa ou código do depositante (quando utilizado Operador Logístico).	integer	Valor Máximo: 999
QTDEMBALAGEM*	Quantidade de unidades dentro de cada embalagem.	decimal (8,3)	Valor Máximo: 99999,999
ESPECIEENDERECO*	Espécie de endereço previamente cadastrada em WMS Parâmetros → Cadastro → Endereços → Espécie de Endereços.	string	Tamanho Máximo: 1
PALETELASTRO*	Quantidade do lastro da norma.	integer	Tamanho Máximo: 99999
PALETEALTURA*	Quantidade da altura da norma.	integer	Tamanho Máximo: 99999
ESTQMINIMOREP	Quantidade de estoque mínimo da espécie de endereço do produto para que seja iniciado o processo de reposição.	decimal (12,3)	Valor Máximo: 999999999,999

*Campos Obrigatórios

Validações Logísticas

As validações logísticas, não impactam no retorno da requisição. Entretanto, para a correta importação da espécie de endereço, os critérios listados abaixo devem ser atendidos. Caso contrário, será gerada uma crítica logística**, e o registro ficará pendente de verificação por um usuário.

O Produto (SeqProduto) deverá estar cadastrada previamente para a empresa (NroEmpresa) informada;
A Embalagem (QtdEmbalagem) deverá estar cadastrada previamente para o produto (SeqProduto) e empresa (NroEmpresa) informada;
A Espécie de Endereco (EspecieEndereco) deverá estar cadastrada previamente para a empresa (NroEmpresa) informada.

_{**As críticas logísticas podem ser visualizadas através da aplicação: WMS Centro de Distribuição -> Gerencial -> Consultas -> Exclusão de Rejeições da Importação Automática.}

Formatos de Request(Request Formats)

application/json, text/json

Bloco de código

language	actionscript3

[
  {
    "seqProduto": 1,
    "nroEmpresa": 1,
    "qtdEmbalagem": 12,
    "especieEndereco": "A",
    "paleteLastro": 10,
    "paleteAltura": 1,
    "estqMinimoRep": 10
  }
]

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

OK (201)
BadRequest (400)

PDV

Tratamento dos campos:

Criação dos campos novos da NT 2021.004:

Tabela AG1PDVPD:

PDV_MSG_ITEM_CONTRIBUINTE VARCHAR2(60) - MENSAGEM ITEM CONTRIBUINTE
PDV_MSG_ITEM_FISCAL VARCHAR2(60) - MENSAGEM ITEM FISCAL
PDV_MSG_GENERICA_FISCAL VARCHAR2(60) - MENSAGEM GENERICA FISCAL

Tabela AG1WPDVX:

PDVX_MSG_ITEM_CONTRIBUINTE VARCHAR2(60) - MENSAGEM ITEM CONTRIBUINTE
PDVX_MSG_ITEM_FISCAL VARCHAR2(60) - MENSAGEM ITEM FISCAL
PDVX_MSG_GENERICA_FISCAL VARCHAR2(60) - MENSAGEM GENERICA FISCAL

Alteração na PC_RMS_PDV_EXPORTACAO:

Buscar as mensagens por item (Contribuinte e Fiscal). Caso não existam, buscar a mensagem genérica fiscal.

Tabela AG1PDVCC:

PDVCC_FST_DFD_VAL - Valor FCP ST DIFAL|Valor FECOP-ST DIFAL Destino
PDVCC_IST_DFD_VAL - Valor ICMS ST DIFAL|Valor ICMS ST DIFAL Destino
PDVCC_FCP_DFD_VAL - Valor FCP DIFAL|Valor FECOP DIFAL Destino

Tabela AG1PDVCI:

PDVCI_FST_DFD_BAS - Base FCP ST DIFAL|Base FECOP-ST DIFAL Destino
PDVCI_FST_DFD_VAL - Valor FCP ST DIFAL|Valor FECOP-ST DIFAL Destino
PDVCI_FST_DFD_ALQ - Aliq. FCP ST DIFAL|Aliquota FECOP-ST DIFAL Destino
PDVCI_IST_DFD_BAS - Base ICMS ST DIFAL|Base ICMS ST DIFAL Dstino
PDVCI_IST_DFD_VAL - Valor ICMS ST DIFAL|Valor ICMS ST DIFAL Destino
PDVCI_IST_DFD_ALQ - Aliq. ICMS ST DIFAL|Aliquota ICMS ST DIFAL Destino
PDVCI_FCP_DFD_BAS - Base FCP DIFAL|Base FECOP DIFAL Destino
PDVCI_FCP_DFD_VAL - Valor FCP DIFAL|Valor FECOP DIFAL Destino
PDVCI_FCP_DFD_ALQ - Aliq. FCP DIFAL|Aliquta FECOP DIFAL Destino
PDVCI_EAN_COM_XML - EAN Com. XML|EAN da Unidade Comercial do XML
PDVCI_UNI_COM_XML - Uni. Com. XML|Unidade Comercial do XML
PDVCI_QTD_COM_XML - Qtd. Com. XML|Quantidade Comercial do XML
PDVCI_EAN_TRB_XML - EAN Trib. XML|EAN da Unidade Tributavel do XML
PDVCI_UNI_TRB_XML - Uni. Trib. XML|Unidade Tributavel do XML
PDVCI_QTD_TRB_XML - Qtd. Trib. XML|Quantidade Trib do XML
PDVCI_IDE_FIS - Ide. Obs. Fisco|Identificacao do campo de Observacao do Fisco
PDVCI_OBS_FIS - Obs. Fisco|Observacao do Fisco
PDVCI_IDE_CTR - Ide. Obs. Ctb.|Identificacao do campo de Observacao do Contribuinte
PDVCI_OBS_CTR - Obs. Ctb.|Observacao do Contribuinte

Tabela PDV_WSIMPORTLOGAG1PDVCC:

PDVCC_FST_DFD_VAL - Valor FCP ST DIFAL|Valor FECOP-ST DIFAL Destino
PDVCC_IST_DFD_VAL - Valor ICMS ST DIFAL|Valor ICMS ST DIFAL Destino
PDVCC_FCP_DFD_VAL - Valor FCP DIFAL|Valor FECOP DIFAL Destino

Tabela PDV_WSIMPORTLOGAG1PDVCI:

PDVCI_FST_DFD_BAS - Base FCP ST DIFAL|Base FECOP-ST DIFAL Destino
PDVCI_FST_DFD_VAL - Valor FCP ST DIFAL|Valor FECOP-ST DIFAL Destino
PDVCI_FST_DFD_ALQ - Aliq. FCP ST DIFAL|Aliquota FECOP-ST DIFAL Destino
PDVCI_IST_DFD_BAS - Base ICMS ST DIFAL|Base ICMS ST DIFAL Dstino
PDVCI_IST_DFD_VAL - Valor ICMS ST DIFAL|Valor ICMS ST DIFAL Destino
PDVCI_IST_DFD_ALQ - Aliq. ICMS ST DIFAL|Aliquota ICMS ST DIFAL Destino
PDVCI_FCP_DFD_BAS - Base FCP DIFAL|Base FECOP DIFAL Destino
PDVCI_FCP_DFD_VAL - Valor FCP DIFAL|Valor FECOP DIFAL Destino
PDVCI_FCP_DFD_ALQ - Aliq. FCP DIFAL|Aliquta FECOP DIFAL Destino
PDVCI_EAN_COM_XML - EAN Com. XML|EAN da Unidade Comercial do XML
PDVCI_UNI_COM_XML - Uni. Com. XML|Unidade Comercial do XML
PDVCI_QTD_COM_XML - Qtd. Com. XML|Quantidade Comercial do XML
PDVCI_EAN_TRB_XML - EAN Trib. XML|EAN da Unidade Tributavel do XML
PDVCI_UNI_TRB_XML - Uni. Trib. XML|Unidade Tributavel do XML
PDVCI_QTD_TRB_XML - Qtd. Trib. XML|Quantidade Trib do XML
PDVCI_IDE_FIS - Ide. Obs. Fisco|Identificacao do campo de Observacao do Fisco
PDVCI_OBS_FIS - Obs. Fisco|Observacao do Fisco
PDVCI_IDE_CTR - Ide. Obs. Ctb.|Identificacao do campo de Observacao do Contribuinte
PDVCI_OBS_CTR - Obs. Ctb.|Observacao do Contribuinte

Conversão de NFC-e

Tratamento dos campos:

Criação dos campos novos da NT 2021.004:

Tabela AG3VNFCC e tabelas mensais AG3VNFCC_aaaamm:

NFCC_FST_DFD_VAL - Valor do FCP ST do DIFAL
NFCC_IST_DFD_VAL - Valor do ICMS ST do DIFAL
NFCC_FCP_DFD_VAL - Valor do FCP ICMS do DIFAL

Tabela AG3VNFCI e tabelas mensais AG3VNFCI_aaaamm:

NFCI_FST_DFD_BAS - Base de Cálculo do FCP ST do DIFAL
NFCI_FST_DFD_VAL - Valor do FCP ST do DIFAL
NFCI_FST_DFD_ALQ - Alíquota do FCP ST do DIFAL
NFCI_IST_DFD_BAS - Base de Cálculo do ICMS ST do DIFAL
NFCI_IST_DFD_VAL - Valor do ICMS ST do DIFAL
NFCI_IST_DFD_ALQ - Alíquota do ICMS ST do DIFAL
NFCI_FCP_DFD_BAS - Base de Cálculo do FCP ICMS do DIFAL
NFCI_FCP_DFD_VAL - Valor do FCP ICMS do DIFAL
NFCI_FCP_DFD_ALQ - Alíquota do FCP ICMS do DIFAL
NFCI_EAN_COM_XML - EAN da Unidade Comercial do XML
NFCI_UNI_COM_XML - Unidade Comercial do XML
NFCI_QTD_COM_XML - Quantidade Comercial do XML
NFCI_EAN_TRB_XML - EAN da Unidade Tributável do XML
NFCI_UNI_TRB_XML - Unidade Tributável do XML
NFCI_QTD_TRB_XML - Quantidade Tributável do XML
NFCI_IDE_FIS - Identificação do campo de Observação do Fisco
NFCI_OBS_FIS - Observação do Fisco
NFCI_IDE_CTR - Identificação do campo de Observação do Contribuinte
NFCI_OBS_CTR - Observação do Contribuinte

Tabela AG3VNFCI_202104 sem os campos novos

Image Removed

Executando o programa de NFC-e – VGTUNFCE

Image Removed

Mensagem da conversão

Image Removed

Conversão efetuada

Registro da NFC-e - Seleção

Image Removed

Consulta da NFC-e

Image Removed

Campos novos adicionados ao registro

Image Removed

Tabela alterada

Image Removed

Totvs custom tabs box items

default	no
referencia	passo4

Adicionar Categorias dos Produtos - POST

Objetivo

Método que permite inserir/atualizar os dados de associação das categorias aos produtos.

Chamada

POST /api/v1/importacao/produto/categoriaproduto

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Não há.

Parâmetros do Corpo (Body Parameters)

Nome (Name)	Descrição (Description)	Tipo (Type)	Informações Adicionais (Adittional Information)
SEQPRODUTO*	Código sequencial do Produto.	integer
NRODIVISAO*	Número da divisão da empresa ( Quando o ERP não utiliza deste recurso passar ZERO ).	integer	Valor Máximo: 999
NROEMPRESA*	Código da empresa do Produto.	integer	Valor Máximo: 999
SEQCATEGORIA*	Código Sequencial da Categoria em que o produto está vinculado. Somente pode vincular uma categoria que estiver com MAXHIERARQUIA = 'S'.	integer	Valor Máximo: 99999

*Campos Obrigatórios

Validações Logísticas

As validações logísticas, não impactam no retorno da requisição. Entretanto, para a correta importação de associação das categorias aos produtos, o critério listado abaixo deve ser atendido. Caso contrário, será gerada uma crítica logística***, e o registro ficará pendente de verificação por um usuário.

O produto (SeqProduto) deverá estar cadastrado previamente na empresa (NroEmpresa) informada.

_{***As críticas logísticas podem ser visualizadas através da aplicação: WMS Centro de Distribuição -> Gerencial -> Consultas -> Exclusão de Rejeições da Importação Automática.}

Formatos de Request (Request Formats)

application/json, text/json

Bloco de código

language	actionscript3

{
   "seqProduto": 407640,
   "nroEmpresa": 100,
   "nroDivisao": 1,
   "seqCategoria": 102
}

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

OK (201)
BadRequest (400)

Totvs custom tabs box items

default	no
referencia	passo5

Adicionar Componentes do Produto Composto - POST

Objetivo

Método que permite inserir/atualizar os dados do produto composto, incluindo os dados de produto componente, quantidades, etc.

Não é obrigatório o envio dessa informação quando não for utilizado o conceito de Produto Composto.

Chamada

POST /api/v1/importacao/produto/componenteprodutocomposto

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Não há.

Parâmetros do Corpo (Body Parameters)

Nome (Name)	Descrição (Description)	Tipo (Type)	Informações Adicionais (Adittional Information)
SEQPRODFINAL*	Código sequencial do produto final que é gerado após a finalização da composição.	integer
SEQPRODCOMPONENTE*	Código sequencial do produto que serão componentes na composição do produto final acabado, que deverá estar previamente cadastrada no WMS.	integer
NROEMPRESA*	Número da empresa ou código do depositante (quando utilizado Operador Logístico).	integer	Valor Máximo: 999
QTDEMBALAGEM*	Quantidade de unidades dentro de cada embalagem do produto componente na composição do produto final acabado.	integer	Valor Máximo: 999999999999,999999
QUANTIDADE*	Quantidade utilizada do produto componente na composição do produto final acabado.	integer	Valor Máximo: 999999999999,999

*Campos Obrigatórios

Validações Logísticas

As validações logísticas, não impactam no retorno da requisição. Entretanto, para a correta importação dos componentes do produto, os critérios listados abaixo devem ser atendidos. Caso contrário, será gerada uma crítica logística***, e o registro ficará pendente de verificação por um usuário.

O produto final (SeqProdFinal) deverá estar cadastrado previamente na empresa (NroEmpresa) informada.
O produto componente (SeqProdComponente) deverá estar cadastrado previamente na empresa (NroEmpresa) informada.
A embalagem (QtdEmbalagem) deverá estar cadastrada previamente para o SeqProdComponente informado.

_{***As críticas logísticas podem ser visualizadas através da aplicação: WMS Centro de Distribuição -> Gerencial -> Consultas -> Exclusão de Rejeições da Importação Automática.}

Formatos de Request (Request Formats)

application/json, text/json

Bloco de código

language	actionscript3

[
  {
  	"seqProdFinal": 120612,
  	"seqProdComponente": 12987,
  	"nroEmpresa": 100,
  	"qtdEmbalagem": 1,
  	"quantidade": 15
  }
]

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

OK (201)
BadRequest (400)

Templatedocumentos

Árvore de páginas

Histórico da Página

Versões comparadas

Versão antiga 5

Nova versão Atual

Chave

Chamada

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Parâmetros do Corpo (Body Parameters)

Validações Logísticas

Formatos de Request (Request Formats)

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

Requisições para adicionar as informações complementares do Produto:

Adicionar Embalagem do Produto - POST

Objetivo

Chamada

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Parâmetros do Corpo (Body Parameters)

Adicionar Embalagem do Produto - POST

Objetivo

Chamada

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Parâmetros do Corpo (Body Parameters)

Validações Logísticas

Formatos de Request (Request Formats)

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

Validações Logísticas

Formatos de Request (Request Formats)

Objetivo

Chamada

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Parâmetros do Corpo (Body Parameters)

Validações Logísticas

Formatos de Request (Request Formats)

Informações para

Resposta (Response Information)

Códigos do Recurso (Response Codes)

Adicionar Código de Barras do Produto - POST

Objetivo

Chamada

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Parâmetros do Corpo (Body Parameters)

Validações Logísticas

Formatos de Request(Request Formats)

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

Adicionar Espécie de Endereço do Produto - POST

Objetivo

Chamada

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Parâmetros do Corpo (Body Parameters)

Validações Logísticas

Formatos de Request(Request Formats)

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

PDV

Conversão de NFC-e

Adicionar Categorias dos Produtos - POST

Objetivo

Chamada

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Parâmetros do Corpo (Body Parameters)

Validações Logísticas

Formatos de Request (Request Formats)

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

Adicionar Componentes do Produto Composto - POST

Objetivo

Chamada