Criar um novo produto

POST https://.account-name.krzlabs.io/api/v1/products

Realiza a criação de um novo produto.

Body Params

Field Type Description Optional Searchable
family_id ObjectId Referência à família do produto. not required false
brand_id ObjectId Referência à marca do produto. not required false
fulfilled number Quantidade já atendida ou processada do produto. not required false
categories Array(ObjectId) Lista de IDs de categorias associadas ao produto. not required false
category_trees Array(ObjectId) Lista de IDs de árvores de categoria associadas ao produto. not required false
product_id ObjectId Referência a outro produto (por exemplo, em composições). not required false
catalogs Array(Object) Lista de catálogos onde o produto está publicado, incluindo quais user_groups podem acessá‑lo.
Estrutura:
   - _id: ObjectId (required, relacionado ao CatalogModule)
   - user_groups: Array(ObjectId) (required, relacionado ao UserGroupsModule)		 not required false
attribute_groups Array(ObjectId) Lista de IDs de grupos de atributos relacionados ao produto. not required false
attributes_schema_snapshot Object Snapshot da configuração de schema de atributos no momento da criação/atualização. not required false
attributes_options_snapshot Object Snapshot das opções de atributos no momento da criação/atualização. not required false
code string Código único do produto. required true
name Translate Nome do produto em vários idiomas. required true
description Translate Descrição do produto em vários idiomas. not required false
image string URL da imagem principal do produto. not required false
images Array(string) URLs de imagens adicionais do produto. not required false
attributes Object Valores dinâmicos de atributos do produto. not required false
enabled boolean Indica se o produto está ativo. not required false
tags Array(string) Tags livres para categorização e busca. not required false
type enum(ProductTypeEnum) Tipo do produto (ex.: simples, variação, kit). required false
product_approval ObjectId Referência ao fluxo de aprovação ao qual o produto pertence. not required false
last_approval_at date Data e hora da última aprovação do produto. not required false
published boolean Indica se o produto está publicado. not required false
last_publishment_id date Timestamp ou ID da última ação de publicação. not required false
last_published_at date Data e hora da última publicação. not required false
publishments
 Array(Object) Histórico de publicações do produto por canal. not required false
Exemplo em JSON 
{
  "family_id": "64b7f9e2c9a8f2a1d3e6b701",
  "brand_id": "64b7f9e2c9a8f2a1d3e6b702",
  "fulfilled": 120,
  "categories": ["64b7f9e2c9a8f2a1d3e6c101", "64b7f9e2c9a8f2a1d3e6c102"],
  "category_trees": ["64b7f9e2c9a8f2a1d3e6c201"],
  "product_id": "64b7f9e2c9a8f2a1d3e6b703",
  "catalogs": [
    {
      "_id": "64b7f9e2c9a8f2a1d3e6d301",
      "user_groups": ["64b7f9e2c9a8f2a1d3e6u001", "64b7f9e2c9a8f2a1d3e6u002"]
    }
  ],
  "attribute_groups": ["64b7f9e2c9a8f2a1d3e6ag01"],
  "attributes_schema_snapshot": {
    "color": "string",
    "size": "string"
  },
  "attributes_options_snapshot": {
    "color": ["red", "blue", "green"],
    "size": ["S", "M", "L", "XL"]
  },
  "code": "PRD-001",
  "name": {
    "pt": "Camiseta Básica",
    "en": "Basic T-Shirt",
    "es": "Camiseta Básica"
  },
  "description": {
    "pt": "Camiseta básica de algodão.",
    "en": "Basic cotton t-shirt.",
    "es": "Camiseta básica de algodón."
  },
  "image": "https://example.com/images/product-001.jpg",
  "images": [
    "https://example.com/images/product-001-1.jpg",
    "https://example.com/images/product-001-2.jpg"
  ],
  "attributes": {
    "color": "blue",
    "size": "M"
  },
  "enabled": true,
  "tags": ["moda", "camiseta", "algodão"],
  "type": "simple",
  "product_approval": "64b7f9e2c9a8f2a1d3e6pa01",
  "last_approval_at": "2023-12-10T14:30:00Z",
  "published": true,
  "last_publishment_id": "64b7f9e2c9a8f2a1d3e6pb01",
  "last_published_at": "2023-12-12T10:00:00Z",
  "publishments": [
    {
      "channel": "ecommerce",
      "published_at": "2023-12-12T10:00:00Z",
      "status": "success"
    },
    {
      "channel": "marketplace",
      "published_at": "2023-12-12T10:05:00Z",
      "status": "success"
    }
  ]
}

Responses

Resposta de sucesso

200
Successfully retrieved API registry entry.
Field Type Description Optional Searchable
family_id ObjectId Referência à família do produto. not required false
brand_id ObjectId Referência à marca do produto. not required false
fulfilled number Quantidade já atendida ou processada do produto. not required false
categories Array(ObjectId) Lista de IDs de categorias associadas ao produto. not required false
category_trees Array(ObjectId) Lista de IDs de árvores de categoria associadas ao produto. not required false
product_id ObjectId Referência a outro produto (por exemplo, em composições). not required false
catalogs Array(Object) Lista de catálogos onde o produto está publicado, incluindo quais user_groups podem acessá‑lo.
Estrutura:
   - _id: ObjectId (required, relacionado ao CatalogModule)
   - user_groups: Array(ObjectId) (required, relacionado ao UserGroupsModule)		 not required false
attribute_groups Array(ObjectId) Lista de IDs de grupos de atributos relacionados ao produto. not required false
attributes_schema_snapshot Object Snapshot da configuração de schema de atributos no momento da criação/atualização. not required false
attributes_options_snapshot Object Snapshot das opções de atributos no momento da criação/atualização. not required false
code string Código único do produto. required true
name Translate Nome do produto em vários idiomas. required true
description Translate Descrição do produto em vários idiomas. not required false
image string URL da imagem principal do produto. not required false
images Array(string) URLs de imagens adicionais do produto. not required false
attributes Object Valores dinâmicos de atributos do produto. not required false
enabled boolean Indica se o produto está ativo. not required false
tags Array(string) Tags livres para categorização e busca. not required false
type enum(ProductTypeEnum) Tipo do produto (ex.: simples, variação, kit). required false
product_approval ObjectId Referência ao fluxo de aprovação ao qual o produto pertence. not required false
last_approval_at date Data e hora da última aprovação do produto. not required false
published boolean Indica se o produto está publicado. not required false
last_publishment_id date Timestamp ou ID da última ação de publicação. not required false
last_published_at date Data e hora da última publicação. not required false
publishments
 Array(Object) Histórico de publicações do produto por canal. not required false

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