Home TOTVS Varejo Supermercados

Árvore de páginas

Objetivo

Método para inclusão de produto.

Chamada

POST [URLAPI]/CadastrosEstruturaisAPI/api/v1/Produto

Permissionamento

Antes de prosseguir, certifique-se de que o usuário, utilizado para autenticação de uso na API, está com as devidas permissões no Sistema/Módulo/Aplicações e na empresa desejada.

Para isso, acesse o módulo SegurançaWeb > Permissões > Associação de Permissão Usuário / Grupo >  Sistemas/Módulo/Aplicações > Comercial Web > API Cadastros Estruturais > API Cadastros Estruturais 


Imagem 01 - Configurações de Sistemas/Módulos/Aplicações

Assuntos Relacionados

Para saber mais sobre permissionamentos acesse Permissões - Segurança Web.

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

Parâmetros URI (URI Parameters)

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)
idProduto*

Identificador do produto

integer($int64)

Tamanho Mínimo: 0 

Tamanho Máximo: 2147483647

idFamilia*

Identificador da família

integer($int64)

Tamanho Mínimo: 0 

Tamanho Máximo: 2147483647

complementoComplementostringTamanho Máximo: 50
descricaoReduzida*

Descrição reduzida

stringTamanho Máximo: 24
descricaoGenerica

Descrição genérica

stringTamanho Máximo: 120
referenciaFabricante

Referência do fabricante

stringTamanho Máximo: 60
especificacaoDetalhada

Especificação detalhada

stringTamanho Máximo: 200
processoFabricacaoIndica o processo de fabricação do produto em si. Valores: S - Nenhum processo de produção, B - Produto base para decomposição, F - Produto final composto, V - Produto de composição variável, I - Insumo para produção, C - Composto para separação, M - Movimento automático.string

Tamanho Máximo: 1

idProdutoBase

Identificador do produto base

integer($int64)

Tamanho Mínimo: 0 

Tamanho Máximo: 2147483647

numeroDiasValidadeRecebimento

Número Dias de Validade Recebimento

integer($int32)

Tamanho Mínimo: 0 

Tamanho Máximo: 9999

codigoANP

Código ANP

integer($int32)

Tamanho Mínimo: 0 

Tamanho Máximo: 2147483647

descricaoANP

Descrição do produto de acordo com a ANP

string

Tamanho Máximo: 95

Parâmetros do Corpo (Body Parameters)

Não há.

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

  • OK (200)
  • BadRequest (400)

Formatos de Resposta (Response Formats)

application/json, text/json

CODE 200 - SUCCESS

{
  "expandables": [
    "string"
  ],
  "idProduto": 0,
  "idFamilia": 0,
  "complemento": "string",
  "descricaoCompleta": "string",
  "descricaoReduzida": "string",
  "descricaoGenerica": "string",
  "referenciaFabricante": "string",
  "especificacaoDetalhada": "string",
  "processoFabricacao": "string",
  "idProdutoBase": 0,
  "numeroDiasValidadeRecebimento": 0,
  "codigoANP": 0,
  "descricaoANP": "string",
  "usuarioInclusao": "string",
  "dataHoraInclusao": "2020-11-10T19:33:10.707Z"
}


application/json, text/json

CODE 400 - BAD

{
  "code": "string",
  "message": "string",
  "detailedMessage": "string",
  "helpUrl": "string",
  "details": [
    {
      "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "notificationType": 0,
      "code": "string",
      "message": "string",
      "detailedMessage": "string",
      "status": 0
    }
  ]
}