Atualizar catálogos em massa

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

Realiza a atualização de catálogos em massa.


Body Params

Field Type optional description Searchable
code (unique) string not required Código do catálogo.
O código deve ser único e é o identificador global do catálogo.
true
name string required Nome do catálogo. true
description string not required Descrição do catálogo. false
enabled boolean not required Indica se o catálogo está ativo ou não. false
products array(ObjectId) not required Identificadores globais dos produtos. false
categories array(ObjectId) not required Identificadores globais das categorias. false
users_groups array(ObjectId) not required Identificadores globais dos grupos de usuários. false
users array(ObjectId) not required Identificadores globais dos usuários. false
tags array(String) not required Tags do catálogo. false
image string not required Imagem do catálogo. false
Exemplo em JSON
{
  "code": "catalogo_001",
  "name": "Catálogo de Verão",
  "description": "Coleção de produtos para a temporada de verão.",
  "enabled": true,
  "products": [
    "64f8a123bcf0a1e45f8c9d01",
    "64f8a123bcf0a1e45f8c9d02"
  ],
  "categories": [
    "64f8a123bcf0a1e45f8c9c11",
    "64f8a123bcf0a1e45f8c9c12"
  ],
  "users_groups": [
    "64f8a123bcf0a1e45f8c9b21"
  ],
  "users": [
    "64f8a123bcf0a1e45f8c9a01",
    "64f8a123bcf0a1e45f8c9a02"
  ],
  "tags": ["oferta", "sazonal", "lançamento"],
  "image": "https://cdn.exemplo.com/catalogos/catalogo_001.png"
}

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