Skip to main content
O endpoint de configuracoes permite consultar e atualizar os parametros globais da sua conta na CGD. Atualmente, a configuracao disponivel e a margem padrao aplicada aos orcamentos.

​
Endpoints

MetodoEndpointDescricao
GET/settingsConsultar configuracoes atuais
PUT/settingsAtualizar configuracoes

​
Consultar configuracoes

curl -X GET https://gds.fretatech.com.br/api/partner/v1/settings \
  -H "Authorization: Bearer SEU_TOKEN"

​
Resposta

{
  "data": {
    "default_margin_percentage": 15
  }
}

​
Campos da resposta

CampoTipoDescricao
default_margin_percentagenumberPercentual de margem aplicado automaticamente aos orcamentos quando nao informado explicitamente

​
Atualizar configuracoes

curl -X PUT https://gds.fretatech.com.br/api/partner/v1/settings \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "default_margin_percentage": 18
  }'

​
Campos da requisicao

CampoTipoObrigatorioDescricao
default_margin_percentagenumberSimPercentual de margem padrao (ex: 15 para 15%)

​
Resposta

{
  "data": {
    "default_margin_percentage": 18
  },
  "message": "Configuracoes atualizadas com sucesso."
}

​
Como a margem padrao funciona

A default_margin_percentage e usada automaticamente ao criar orcamentos quando o parametro default_margin_percentage nao e informado na requisicao POST /quotes. Exemplo de fluxo:
  1. Configuracao atual: default_margin_percentage = 15
  2. Criacao de orcamento sem informar margem → margem de 15% e aplicada
  3. Criacao de orcamento com default_margin_percentage: 20 → margem de 20% e aplicada (sobrescreve o padrao)
Isso permite flexibilidade: voce pode ter uma margem padrao global e sobrescreve-la pontualmente por orcamento.