Árvore de páginas

Versões comparadas

Chave

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

Objetivo

A finalidade deste método é possibilitar a consulta do código de acesso dos produtos.

Chamada

GET /api/v4/produtos/codigos-acesso-prod

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

Parâmetros URI (URI Parameters)

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)
idCategoriaCódigo sequencial do cadastro de categoria.IntegerNão há
codigoAcessoCódigos de acessos associados ao produto (GTIN, Interno, Fornecedor)stringNão há
descricaoProdutoDescrição cadastrada para o produtostringNão há
dataAtualizacaoData da ultima atualização Formato: YYYY-MM-DDThh:mm:ssstringNão há
idFamiliaCódigo sequencial do cadastro de família do produtoIntegerNão há
idProdutoCódigo sequencial do cadastro do produtoIntegerNão há
idFornecedorCódigo sequencial do cadastro de fornecedorIntegerNão há
somenteInativosTraz somente os códigos de acesso inativos. Se não informado, traz somente os código de acesso ativos. Valores: S – Traz somente os inativos; N – Traz somente os ativosStringAtenção! Se informado ‘S’ o unico outro parametro aceito será [DataAtualizacao].
_pageNo
IntegerNão há
_pageSize
IntegerNão há

Parâmetros do Corpo (Body Parameters)

Não há.

Informações para Resposta (Response Information)

Descrição do Recurso (Resource Description)

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)
CodigosAcessosLista de principios ativosArray
of 
of objects (CodigosAcessoProdCodAcessoRespostaDTO)Não há
CodigoAcessoCódigo de acesso principalStringPertence ao array CodigosAcessos
TipoCodigoTipo do código de acesso (B – Código Interno / D – DUN / E – EAN / F – Fornecedor / I – Transição)StringPertence ao array CodigosAcessos
QtdEmbalagemQuantidade da embalagem vinculada ao códigoIntegerPertence ao array CodigosAcessos
StatusStatus do código de acesso: A – Ativo / I – InativoStringPertence ao array CodigosAcessos
DataExclusaoData/Hora da exclusão do código de acesso. Nulo se o código ainda estiver ativo.StringPertence ao array CodigosAcessos
CodigoAcessoPrincipalCódigo de acesso principalStringNão há
IdProdutoCódigo sequencial do cadastro do produtoIntegerNão há
IdFamiliaCódigo sequencial do cadastro da família do produtoIntegerNão há
IdProdutoBaseCódigo sequencial do cadastro do produto baseIntegerNão há
DataUltimaAtualizacaoData da ultima atualizaçãoStringNão há

Formatos de Resposta (Response Formats)

application/json, text/json

Exemplo (Sample):

{
  "CodigosAcessos": [
    {
      "CodigoAcesso": "string",
      "TipoCodigo": "string",
      "QtdEmbalagem": 0,
      "Status": "string",
      "DataExclusao": "2020-06-30T11:53:05Z"
    }
  ],
  "CodigoAcessoPrincipal": "string",
  "IdProduto": 0,
  "IdFamilia": 0,
  "IdProdutoBase": 0,
  "DataUltimaAtualizacao": "2020-06-30T11:53:05Z"
}