Objetivo
Consultar a categoria dos produtos.
Chamada
GET [URLAPI]/CadastrosEstruturaisAPI/api/v1/Categoria
Parâmetros URI (URI Parameters)
Nome (Name) | Descrição (Description) | Tipo (Type) | Informações Adicionais (Adittional Information) |
---|
IdFamilia | identificador da família | array[integer] | Não há. |
IdCategoria | identificador da categoria | integer($int64) | Não há. |
NroDivisao | numero da divisão | integer($int64) | Não há. |
Tipo | tipo da categoria | string | Não há. |
IdCategoriaImportacaoErp | identificador da categoria na importação do ERP | integer($int64) | Não há. |
NroDivisaoImportacaoErp | número da divisão na importação do ERP | integer($int64) | Não há. |
DataHoraAlteracao | data/hora da alteração | string($date-time) | Não há. |
Expand | propriedade para expandir os campos | string | Não há. |
Fields | campos | string | Não há. |
Order | ordenação dos campos | string | Não há. |
Page | numero da página | integer($int32) | Não há. |
PageSize | tamanho da página | 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": [
{
"expandables": [
"string"
],
"idCategoria": 0,
"idDivisao": 0,
"tipo": "string",
"nivelHierarquia": 0,
"descricao": "string",
"aceitaFamilia": "string",
"objetivoNoNegocio": "string",
"idCategoriaPai": 0,
"status": "string",
"dataHoraAlteracao": "string",
"caminhoCompleto": "string",
"idCategoriaImportacaoERP": 0,
"nroDivisaoImportacaoERP": 0
}
]
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
}
]
}