Objetivo

Método de consulta que retorna informações dos códigos de acesso dos produtos.

Chamada

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

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

Parâmetros URI (URI Parameters)

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

CodigoAcesso

Código de Acesso

string

Não há.

CgcFornecedor

CGC do Fornecedor

stringNão há.

TipoCodigo

Lista de tipos de Código de Acesso. Tipos válidos = F, C, E, I, B, D, A, R e L

array[string]

Não há.

SeqProduto

Sequencial do Produto

integer($int32)

Não há.

SeqFamilia

Sequencial do Produto

integer($int32)

Não há.
QtdEmbalagemQuantidade da Embalagemnumber($double)Não há.
PagePáginas

integer($int32)

Não há.
PageSizeTamanho das páginas

integer($int32)

Não há.

Parâmetros do Corpo (Body Parameters)

Não há.

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

Formatos de Resposta (Response Formats)

application/json, text/json

CODE 200 - SUCCESS

{
  "hasNext": true,
  "items": [
    {
      "cgcFornecedor": "string",
      "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
    }
  ]
}