Skip to main content

​
Visão geral

Além dos custos de produto enviados no catálogo, a sua operação tem custos que não vêm da loja: aluguel, ferramentas, contabilidade, investimento em mídia, etc. Esses custos adicionais podem ser cadastrados e mantidos pela API, do mesmo jeito que são geridos no dashboard. Cada custo pertence a uma frequência e é projetado em linhas diárias para compor as métricas de margem e de marketing da plataforma.
As rotas de custos exigem os escopos costs.read (leitura) e costs.write (escrita) na sua API Key.

​
Frequências

O campo frequency define como o custo se repete ao longo do período (date até end_date): Quando end_date é omitido, o custo é projetado até a data atual.

​
Tipos que afetam as métricas

O campo type é livre (ex.: aluguel, plataformas, contabilidade, outros), mas dois tipos têm efeito especial e disparam o recálculo automático das métricas ao serem gravados:
  • marketing — entra na análise de marketing por canal (fonte manual)
  • product — entra no custo de produto
O recálculo é assíncrono. Após criar, editar ou remover um custo de marketing/product, os números podem levar alguns instantes para refletir na plataforma.

​
Ciclo de vida

O mesmo recurso cobre criar, listar, editar e remover:
  • Criar custo — POST /costs. Se você não informar additional_cost_id, a Solomon gera um (até 10 caracteres).
  • Listar custos — GET /costs, agrupados por frequência.
  • Histórico diário — GET /costs/historical?start=&end=, as linhas projetadas dia a dia.
  • Atualizar custo — PUT /costs. Informe old_frequency quando a frequência mudar. A edição só recalcula as métricas quando muda algo que afeta os números (valor, nome, datas ou frequência); alternar apenas o status não dispara recálculo.
  • Remover custo — DELETE /costs.
additional_cost_id tem no máximo 10 caracteres. Ao editar ou remover, use exatamente o mesmo id retornado na criação.

​
Exemplo