Skip to navigation

Overview

O catálogo reúne os produtos e serviços que entram nas propostas, com preço, quantidade padrão, unidade e categoria. Um item do catálogo vira uma linha quando é adicionado a uma oportunidade.

Rotas

MétodoRotaPara quê
GET/itemsListar produtos e serviços ativos.
GET/items/{id}Consultar produto ou serviço, inclusive inativo.
POST/itemsCriar produto ou serviço.
PUT/items/{id}Atualizar produto ou serviço parcialmente.
DELETE/items/{id}Excluir produto ou serviço sem vínculos.

Catálogo × linha da oportunidade

Catálogo (/items)Linha da oportunidade
Identificadorid do produto ou serviçoitemId da linha
Onde se editaPUT /items/{id}PUT /budgets/{id}/items/{itemId}
EfeitoMuda o cadastro para propostas futurasMuda só aquela proposta

Para colocar itens numa oportunidade, envie os id do catálogo em items ao criar a oportunidade ou em Adicionar itens do catálogo.

Cuidados

  • Escrita exige permissão de edição do cadastro de produtos.
  • type é product ou service. Na criação, a unidade padrão é un para produto e hour para serviço.
  • PUT é parcial. Campos omitidos são preservados; 0 e false são valores válidos. null limpa category, description, tag, sku e pn.
  • Inativo some da listagem. Item com active: false deixa de aparecer em GET /items, mas continua acessível por GET /items/{id}.
  • Exclusão com vínculo dá 409. Para tirar de uso sem perder o histórico, envie {"active": false} em PUT /items/{id}.