Home TOTVS Varejo Supermercados

Árvore de páginas

Objetivo

Método de consulta que retorna informações de categorias das famílias em formato de árvore.

Chamada

GET [URLAPI]/CadastrosEstruturaisAPI/api/v1/Categoria/arvore-familia

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

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á.
NroDivisaoNúmero da divisão

integer($int64)

Não há.
TipoTipo da categoria. Valores: M - Mix, C - Consumidor, L - Lista de PreçostringNão há.
ExpandExpandir os camposstringNão há.

Fields

CamposstringNão há.

Order

OrdenaçãostringNã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)

  • OK (200)
  • BadRequest (400)

Formatos de Resposta (Response Formats)

application/json, text/json

CODE 200 - SUCCESS

{
  "hasNext": true,
  "items": [
    {
      "idCategoria": 0,
      "idCategoriaPai": 0,
      "nroDivisao": 0,
      "descricao": "string",
      "tipo": "string",
      "aceitaFamilia": "string",
      "objetivoNoNegocio": "string",
      "percMargemLucro": 0,
      "status": "string",
      "idCategoriaImportacaoERP": 0,
      "nroDivisaoImportacaoERP": 0,
      "categoriasFilho": [
        {
          "idCategoria": 0,
          "idCategoriaPai": 0,
          "nroDivisao": 0,
          "descricao": "string",
          "tipo": "string",
          "aceitaFamilia": "string",
          "objetivoNoNegocio": "string",
          "percMargemLucro": 0,
          "status": "string",
          "idCategoriaImportacaoERP": 0,
          "nroDivisaoImportacaoERP": 0,
          "categoriasFilho": [
            null
          ],
          "familiaCategoria": [
            {
              "idFamilia": 0,
              "idCategoria": 0,
              "nroDivisao": 0,
              "status": "string"
            }
          ]
        }
      ],
      "familiaCategoria": [
        {
          "idFamilia": 0,
          "idCategoria": 0,
          "nroDivisao": 0,
          "status": "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
    }
  ]
}