Exibir origem

Objetivo

Método para incluir categorias em árvore.

Chamada

POST [URLAPI]/CadastrosEstruturaisAPI/api/v1/Categoria/arvore

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

Home TOTVS Varejo Supermercados > Incluir Categoria em Árvore - POST > image-2024-5-6_12-37-49.png

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)

Não há.

Parâmetros do Corpo (Body Parameters)

Nome (Name)	Descrição (Description)	Tipo (Type)	Informações Adicionais (Adittional Information)
expandables	Propriedade para expandir os componentes.	string	Não há.
nroDivisao	Número da divisão	integer($int64)	Não há.
tipo	Tipo da categoria. Valores: M - Mix, C - Consumidor, L - Lista de Preço	string	Não há.
categoriaRaiz	Categoria raiz	CategoriaArvoreReqDto	Não há.
expandables	Propriedade para expandir os componentes.	string	Não há.
idCategoria	Identificador da categoria	integer($int64)	Não há.
descricao	Descrição da categoria	string	Obrigatório
aceitaFamilia	Define se a categoria aceita famílias. Valores: S - Sim, N - Não	string	Obrigatório
objetivoNoNegocio	Objetivo no negócio. Valores: L - Gerar Lucro, M - Gerar Movimento	string	Não há.
percMargemLucro	Percentual de margem de lucro	number($double)	Não há.
status	Status da categoria. Valores: A - Ativo, I - Inativo	string	Obrigatório
idCategoriaImportacaoERP	Identificador da categoria utilizada para importação ERP	integer($int64)	Não há.
nroDivisaoImportacaoERP	Número da divisão utilizada para importação ERP	integer($int64)	Não há.
categoriasFilho	Objeto que representa os filhos da categoria atual	CategoriaArvoreReqDto	Não há.
expandables	Propriedade para expandir os componentes.	string	Não há.
idCategoria	Identificador da categoria	integer($int64)	Não há.
descricao	Descrição da categoria	string	Obrigatório
aceitaFamilia	Define se a categoria aceita famílias. Valores: S - Sim, N - Não	string	Obrigatório
objetivoNoNegocio	Objetivo no negócio. Valores: L - Gerar Lucro, M - Gerar Movimento	string	Não há.
percMargemLucro	Percentual de margem de lucro	number($double)	Não há.
status	Status da categoria. Valores: A - Ativo, I - Inativo	string	Obrigatório
idCategoriaImportacaoERP	Identificador da categoria utilizada para importação ERP	integer($int64)	Não há.
nroDivisaoImportacaoERP	Número da divisão utilizada para importação ERP	integer($int64)	Não há.
categoriasFilho	Objeto que representa os filhos da categoria atual	string	Não há.

{
  "expandables": [
    "string"
  ],
  "nroDivisao": 0,
  "tipo": "string",
  "categoriaRaiz": {
    "expandables": [
      "string"
    ],
    "idCategoria": 0,
    "descricao": "string",
    "aceitaFamilia": "string",
    "objetivoNoNegocio": "string",
    "percMargemLucro": 0,
    "status": "string",
    "idCategoriaImportacaoERP": 0,
    "nroDivisaoImportacaoERP": 0,
    "categoriasFilho": [
      {
        "expandables": [
          "string"
        ],
        "idCategoria": 0,
        "descricao": "string",
        "aceitaFamilia": "string",
        "objetivoNoNegocio": "string",
        "percMargemLucro": 0,
        "status": "string",
        "idCategoriaImportacaoERP": 0,
        "nroDivisaoImportacaoERP": 0,
        "categoriasFilho": [
          null
        ]
      }
    ]
  }
}

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

Success (200)
BadRequest (400)

Formatos de Resposta (Response Formats)

application/json, text/json

CODE 200 - SUCCESS

{
  "categoriasRaiz": {
    "idCategoria": 0,
    "nroDivisao": 0,
    "descricao": "string",
    "tipo": "string",
    "aceitaFamilia": "string",
    "objetivoNoNegocio": "string",
    "percMargemLucro": 0,
    "status": "string",
    "idCategoriaImportacaoERP": 0,
    "nroDivisaoImportacaoERP": 0,
    "categoriasFilho": [
      {
        "idCategoria": 0,
        "nroDivisao": 0,
        "descricao": "string",
        "tipo": "string",
        "aceitaFamilia": "string",
        "objetivoNoNegocio": "string",
        "percMargemLucro": 0,
        "status": "string",
        "idCategoriaImportacaoERP": 0,
        "nroDivisaoImportacaoERP": 0,
        "categoriasFilho": [
          null
        ]
      }
    ]
  }
}

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