Árvore de páginas

Objetivo

Método para inclusão de código de acesso do produto.

Chamada

POST [URLAPI]/CadastrosEstruturaisAPI/api/v1/Produto/produto-codigo

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

Quando o tipo de código é F, grava-se os 8 primeiros dígitos do CNPJ, considerar zeros à esquerda - Total 14. Quando o TipCodigo for 'C' é gravado o SeqPessoa

integer($int64)

Mínimo: 0

Máximo: 99999999

tipoCodigo*Tipo de código - F, C, E, I, B, D, A, R e l F = Fornecedor C = Cliente E = EAN/UCC I = Transição B = Interno D = DUN A = AFV R = AFV p/ Devolução L = Rede ClientestringMáximo: 1
idFamilia

Identificador da família

integer($int64)
Mínimo: 0
qtdPorEmbalagem

Quantidade por embalagem

number($double)

Mínimo: 0

Máximo: 999999.999999

idProduto*

Identificador do produto

integer($int64)
Mínimo: 0
indUtilVenda

Util para Venda. S - Sim / N - Não.

stringMáximo: 1
codigoAcesso*

Código de Acesso

stringMáximo: 60
indPrefEdi

Indica qual código é preferencial na geração de EDIs. S - Sim / N - Não.

stringMáximo: 1
indEanTribNfe

EAN Tributação DANFE

stringMáximo: 1

Parâmetros do Corpo (Body Parameters)

Não há.

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

  • Success(201)
  • BadRequest (400)

Formatos de Resposta (Response Formats)

application/json, text/json

CODE 200 - SUCCESS

{
  "cgcFornecedor": 0,
  "tipoCodigo": "string",
  "idFamilia": 0,
  "qtdPorEmbalagem": 0,
  "idProduto": 0,
  "indUtilVenda": "string",
  "codigoAcesso": "string",
  "indPrefEdi": "string",
  "indEanTribNfe": "string",
  "usuarioAlteracao": "string"
}


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
    }
  ]
}