Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

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).

integerValor 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.
stringTamanho 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".

stringTamanho Máximo: 3
DESCCOMPLETA*Descrição completa do produto.stringTamanho Máximo: 70
DESCREDUZIDA*Descrição reduzida do produto.stringTamanho Máximo: 20
STATUSCOMPRA*Status de compra do produto:
A – Ativo
I  – Inativo.
stringTamanho Máximo: 1
STATUSVENDA*Status de venda do produto:
A – Ativo
I  – Inativo.
stringTamanho 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".

stringTamanho 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".

stringTamanho 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".

integerValor Máximo: 9999
PESAVELIndica se o produto é pesável:
S  – Sim
N – Não.
stringTamanho Máximo: 1
ADVARMAZENAGEMAdvertência de Armazenagem. Mensagem que será mostrada no momento da armazenagem do produto.stringTamanho Máximo: 80
EMTETIQUETAIndicador 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".

stringTamanho 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".

stringTamanho Máximo: 1
MEDVDIAGERALMé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.

stringTamanho Máximo: 1
REFFABRICANTEDescrição da referência do produto enviada pelo fabricante.stringTamanho Máximo: 20
EXGNROSERIEIndica se o produto exige que seja informado o número da série na conferência:
S  – Sim
N – Não.
stringTamanho Máximo: 1
QTDTOLARMAZPRODQuantidade para tolerância na armazenagem.integerValor Máximo: 999999999
REFERENCIAReferência do produto que será concatenada na descrição completa do produto.stringTamanho Máximo: 20
UTZESTRUTDRIVEINIndica se o produto utiliza estrutura Drive-In:
S  – Sim
N – Não.
stringTamanho Máximo: 1
EXGCERTIFICADOIndica se o produto exige certificado:
S  – Sim
N – Não.
stringTamanho Máximo: 1
INDALTORISCOIndica se o produto é de alto risco:
S  – Sim
N – Não.

Parâmetro vinculado ao processo de Sorter.

stringTamanho Máximo: 1
INDEXGVALIDACAOMONTAGEMPALETEIndica se o produto exige validação na montagem do palete:
S  – Sim
N – Não.

Parâmetro vinculado ao processo de Sorter.

stringTamanho 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.

integerValor Máximo: 999
SEQFAMILIACódigo sequencial da família do produto.integer
USUARIOALTERACAOUsuário que realizou a última alteração no cadastro do produto.stringTamanho Máximo: 12
INDCONTROLATEMPERATURAIndica se o produto controla temperatura:
S  – Sim
N – Não.

Parâmetro vinculado ao processo de conferência de recebimento.

stringTamanho Máximo: 1
INDCONTROLARASTREABILIDADEIndica se o produto controla rastreabilidade:
S  – Sim
N – Não.

Parâmetro vinculado ao processo de rastreabilidade.

stringTamanho 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".

integerValor Máximo: 999
SEQPRODUTOBASECódigo sequencial do produto base.integer

*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. 

  1. 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);
  2. 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);
  3. 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);
  4. O Fornecedor (SeqFornecedor) deverá estar cadastrado previamente no sistema;
  5. O Produto Base (SeqProdutoBase) não poderá estar relacionado a outro produto;
  6. 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
languageactionscript3
{
  "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,
  "ExgNroLote" : "N",
  "AdvArmazenagem" : "Teste Advertencia",
  "RefFabricante" : "Teste Ref.Fabricante",
  "ExgNroSerie" : "N",
  "QtdTolArmazProd" : 1,
  "Referencia" : "Teste Referencia",
  "UtzEstrutDriveIn" : "N",
  "ExgCertificado" : "N",
  "IndAltoRisco" : "N",
  "IndExgValidacaoMontagemPalete" : "N",
  "QtdVolGeraEtqMaster" : null,
  "SeqFamilia" : null,
  "IndControlaTemperatura" : "N",
  "IndControlaRastreabilidade" : "S",
  "QtdDiasControleQuarentena" : 1,
  "UsuarioAlteracao" : "CONSINCO"
}

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:

Totvs custom tabs box
tabsEmbalagem do Produto, Código de Barras do Produto, Espécie de Endereço do Produto, Categorias dos Produtos, Componentes do Produto Composto
idspasso1,passo2,passo3,passo4,passo5
Totvs custom tabs box items
defaultyes
referenciapasso1

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).

integerValor 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.stringTamanho Máximo: 3
STATUSEMBALAGEM*Status da embalagem:
A – Ativo
I – Inativo.
stringTamanho Máximo: 1
INDMIUDEZAGRANDEZAIndica se a embalagem do produto corresponde à:
M – Miudeza
G – Grandeza.
stringTamanho 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
INDEMBALADOIndica se a embalagem do produto corresponde o tipo embalado:
N – Não
S – Sim.
stringTamanho Máximo: 1
CODTARACódigo da tara na embalagem do produto. A tara deve estar previamente cadastrada no WMS Parâmetros → Produtos → Tara Balança.stringTamanho Máximo: 10
PESOMEDIOPeso 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.

stringTamanho 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.

stringTamanho 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. 

  1. O Produto (SeqProduto) deverá estar cadastrada previamente para a empresa (NroEmpresa) informada;
  2. A Empresa (NroEmpresa) deverá estar cadastrada previamente no Cadastro de Depositantes (WMS Parâmetros → Cadastro → Depositante);
  3. 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
languageactionscript3
[
  {
  	"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
defaultno
referenciapasso2

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).

integerValor 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

stringTamanho 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. 

  1. 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
languageactionscript3
[
  {
    "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
defaultno
referenciapasso3

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).

integerValor 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.

integerTamanho Máximo: 99999
PALETEALTURA*Quantidade da altura da norma.integerTamanho Máximo: 99999
ESTQMINIMOREPQuantidade 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. 

  1. O Produto (SeqProduto) deverá estar cadastrada previamente para a empresa (NroEmpresa) informada;
  2. A Embalagem (QtdEmbalagem) deverá estar cadastrada previamente para o produto (SeqProduto) e empresa (NroEmpresa) informada;
  3. 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
languageactionscript3
[
  {
    "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)
Totvs custom tabs box items
defaultno
referenciapasso4

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 ).

integerValor Máximo: 999
NROEMPRESA*

Código da empresa do Produto.

integerValor 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'.integerValor 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. 

  1. 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
languageactionscript3
{
   "seqProduto": 407640,
   "nroEmpresa": 100,
   "nroDivisao": 1,
   "seqCategoria": 102
}

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

  • OK (201)
  • BadRequest (400)
<style> div.theme-default .ia-splitter #main { margin-left: 0px; } .ia-fixed-sidebar, .ia-splitter-left { display: none; } #main { padding-left: 10px; padding-right: 10px; overflow-x: hidden; } .aui-header-primary .aui-nav, .aui-page-panel { margin-left: 0px !important; } .aui-header-primary .aui-nav { margin-left: 0px !important; } </style>
Totvs custom tabs box items
defaultno
referenciapasso5

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).

integerValor Máximo: 999
QTDEMBALAGEM*Quantidade de unidades dentro de cada embalagem do produto componente na composição do produto final acabado.integerValor Máximo: 999999999999,999999
QUANTIDADE*Quantidade utilizada do produto componente na composição do produto final acabado.integerValor 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. 

  1. O produto final (SeqProdFinal) deverá estar cadastrado previamente na empresa (NroEmpresa) informada. 
  2. O produto componente (SeqProdComponente) deverá estar cadastrado previamente na empresa (NroEmpresa) informada. 
  3. 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
languageactionscript3
[
  {
  	"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)
HTML


Templatedocumentos