Atualizar categorias em massa

PUT https://.account-name.krzlabs.io/api/v1/categories/bulk

Realiza a atualização de categorias em massa.


Body Params

Field Type Description optional searchable
category_id ObjectId O identificador da categoria. not required false
code String Código da categoria.
O código deve ser único e é o identificador global da categoria.
required true
name Translate Nome de como a categoria será referenciada no sistema. required true
description Translate Descrição da categoria.
Mais especificamente, sua descrição comercial ou todas as informações que julgar necessário da categoria.
not required true
tags Array(String) Tags da categoria.
Tags são utilizadas para categorizar as categorias, permitindo regras de negócio específicas para cada tag e novas organizações de dados.
not required false
enabled Boolean Indica se a categoria está ativa ou não. required false
category_tree_id ObjectId Identificador global da categoria pai. required false
catalog_id ObjectId Identificador global do catálogo. not required false
catalogs array(ObjectId) Identificador global do catálogo. not required false
depth number Profundidade da categoria. not required false
attribute_groups array(ObjectId) Identificador global do catálogo. not required false
Exemplo em JSON
{
  "category_id": "64f1b3d4e5d987654321cdef",
  "code": "CAT001",
  "name": {
    "pt": "Nome da Categoria",
    "en": "Category Name"
  },
  "description": {
    "pt": "Descrição da categoria",
    "en": "Category description"
  },
  "tags": [
    "promoção",
    "oferta",
    "novidade"
  ],
  "enabled": true,
  "category_tree_id": "64f1c4e6e5d567890abcd123",
  "catalog_id": "64f1d5f8e5d135790abcdef1",
  "catalogs": [
    "64f1d5f8e5d135790abcdef2",
    "64f1d5f8e5d135790abcdef3"
  ],
  "depth": 2,
  "attribute_groups": [
    "64f1d5f8e5d135790abcdef4",
    "64f1d5f8e5d135790abcdef5"
  ]
}

Response

Resposta de sucesso

200
Successfully retrieved API registry entry.
Field Type optional description Searchable
insertedCount number required Quantidade de documentos inseridos. false
matchedCount number required Quantidade de documentos que correspondem ao filtro de atualização. false
modifiedCount number required Quantidade de documentos modificados. false
deletedCount number required Quantidade de documentos deletados. false
upsertedCount number required Quantidade de documentos upsertados. false
upsertedIds any required IDs dos documentos upsertados. false
insertedIds any required ID do documento inserido. false
ok number required Indica se a operação foi bem sucedida. false
Exemplo em JSON
{
  "insertedCount": 1,
  "matchedCount": 2,
  "modifiedCount": 2,
  "deletedCount": 0,
  "upsertedCount": 1,
  "upsertedIds": {
    "0": "66b8f6f9d9f4ab1234567890"
  },
  "insertedIds": {
    "0": "66b8f6f9d9f4ab1234567891"
  },
  "ok": 1
}

Resposta de erro

400
Bad Request
Field Type Description
code Number Código da resposta http
kind String Tipo de mensagem
name String Nome da exceção lançada pela plataforma
title String Titulo do erro lançado pela plataforma
message String Mensagem indicando o probloma ocorrido
solution String Mensagem indicando uma possível solução para o problema

Copyright © 2025 kruzer | All Rights Reserved