CUBO CRM
    CUBO CRM
    • Comece por aqui
    • Activities
      • Listar todas as atividades
        GET
      • Criar nova atividade
        POST
      • Obter atividade por ID
        GET
      • Atualizar atividade
        PUT
      • Excluir atividade
        DELETE
    • Annotation
      • Criar nova anotação
        POST
      • Obter anotação por ID
        GET
      • Atualizar anotação
        PUT
      • Excluir anotação
        DELETE
    • Apikey
      • Listar todas as apikeys
        GET
      • Criar nova apikey
        POST
      • Obter apikey por ID
        GET
      • Atualizar apikey
        PUT
      • Excluir apikey
        DELETE
    • Category
      • Listar todas as categorias
        GET
      • Criar nova categoria
        POST
      • Obter categoria por ID
        GET
      • Atualizar categoria
        PUT
      • Excluir categoria
        DELETE
    • Company
      • Obter empresa
        GET
      • Atualizar empresa
        PUT
    • Custom Field
      • Listar todos os campos personalizados
        GET
      • Criar novo campo personalizado
        POST
      • Obter campo personalizado por ID
        GET
      • Atualizar campo personalizado
        PUT
      • Excluir campo personalizado
        DELETE
    • Deal
      • Listar todos os negócios
      • Criar novo negócio
      • Obter negócio por ID
      • Atualizar negócio
      • Excluir negócio
    • Domain
      • Listar todos os domínios
      • Criar novo domínio
      • Obter domínio por ID
      • Excluir domínio
    • LostReason
      • Listar todos os motivos de perda
      • Criar motivo de perda
      • Obter motivo de perda por ID
      • Atualizar motivo de perda
      • Excluir motivo de perda
    • Organization
      • Listar todas as organizações
      • Criar nova organização
      • Obter organização por ID
      • Atualizar organização
      • Excluir organização
    • People
      • Listar todas as pessoas
      • Criar nova pessoa
      • Obter pessoa por ID
      • Atualizar pessoa
      • Excluir pessoa
    • Pipe
      • Listar todos os funis
      • Criar novo funil
      • Listar funil por ID
      • Atualizar Funil
      • Excluir funil
    • Product
      • Listar todos os produtos
      • Criar novo produto
      • Obter produto por ID
      • Atualizar produto
      • Excluir produto
    • Proposal
      • Listar todos as propostas
      • Criar proposta para negociação pelo ID
      • Obter proposta por ID
      • Atualizar proposta
    • Stage
      • Buscar todos os estágios do funil pelo ID
      • Criar estágios
      • Obter estágios por ID
      • Atualizar estágio
      • Excluir estágio
    • Template
      • Listar todos os templates de mensagem
      • Criar template de mensagem
      • Criar template de mensagem para negócio pelo ID
      • Obter template de mensagem por ID
      • Atualizar template de mensagem
      • Excluir template de mensagem
    • Webhooks
      • Receber dados do BotConversa para criação
      • Receber dados do BotConversa para atualização
      • Receber dados do ManyChat para criação
      • Receber dados do ManyChat para atualização

    Product

    Entidade: Product#

    Visão Geral#

    A entidade Product representa os produtos/serviços oferecidos pela empresa. Cada produto é vinculado a uma empresa específica e pode ter categorias associadas

    Estrutura da Entidade#

    Campos Principais#

    CampoTipoDescriçãoObrigatório
    idnumberIdentificador único do produto✅ (auto)
    namestringNome do produto✅
    descriptiontextDescrição detalhada do produto❌
    pricedecimalPreço do produto❌
    skustringCódigo SKU único do produto❌
    urlImagestringURL da imagem principal do produto❌
    urlThumbnailstringURL da imagem thumbnail do produto❌
    statusenumStatus do produto (active/inactive)✅
    companyIdnumberID da empresa proprietária✅
    createdAtDateTimeData/hora de criação✅ (auto)
    updatedAtDateTimeData/hora da última atualização✅ (auto)

    Relacionamentos#

    Company: Vinculado à empresa proprietária.
    Categories: Relacionamento many-to-many com categorias.
    Deals: Pode ser associado a negociações.

    Status Disponíveis#

    StatusDescrição
    activeProduto ativo e disponível
    inactiveProduto desabilitado

    Casos de Uso Detalhados#

    1. Catálogo de Produtos#

    Cenário: Uma empresa deseja gerenciar seu catálogo de produtos/serviços para usar em negociações.
    Fluxo:
    O usuário cria produtos com informações detalhadas.
    Associa categorias para organização.
    Vincula produtos às propostas e negociações.
    Benefícios: Padronização de produtos e facilidade na criação de propostas.

    Regras de Negócio#

    Criação de Produtos#

    Produtos são únicos por empresa.
    SKU deve ser único quando informado.
    Status padrão é definido na criação.

    Controle de Acesso#

    Usuários só podem gerenciar produtos de sua empresa.
    Isolamento por empresa (multi-tenancy).
    Produtos inativos não aparecem em listas ativas.

    Tracking de Empresa#

    Primeiro produto criado atualiza firstProductCreated da empresa.
    Último produto criado atualiza lastProductCreated da empresa.

    Operações Disponíveis#

    OperaçãoDescriçãoMétodo HTTP
    ListarRecupera produtos com filtros e paginaçãoGET
    CriarCria um novo produtoPOST
    VisualizarExibe detalhes de um produto específicoGET
    AtualizarModifica produto e reorganiza imagensPUT/PATCH
    ExcluirRemove um produtoDELETE

    Fluxo de Uso#

    Segurança e Boas Práticas#

    Para Desenvolvedores#

    Validar SKU único por empresa antes de salvar.
    Usar transações para operações que envolvem múltiplas tabelas.

    Para Usuários#

    Usar SKUs únicos para facilitar identificação.
    Categorizar produtos adequadamente para facilitar busca.

    Limitações e Restrições#

    Produtos são específicos por empresa.
    SKU deve ser único dentro da empresa.
    Página anterior
    Excluir funil
    Próxima página
    Listar todos os produtos
    Built with