Custos adicionais

Custos extras (valor fixo ou percentual) somados ao custo gerencial dos produtos, opcionalmente limitados a categorias. Exigem a permissão de gerenciar catálogo.

Base: https://api.nivesistemas.com.br · 5 endpoints

GET /additional-costs

Listar custos adicionais e ver se o recurso está ligado

Resposta: { enabled, items }. Cada item: id, name, kind (FIXED ou PERCENT), value, active, categoryIds (vazio = vale para todas as categorias) e position.

curl -X GET "https://api.nivesistemas.com.br/additional-costs" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/additional-costs", {
  method: "GET",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

import requests

res = requests.request(
    "GET",
    "https://api.nivesistemas.com.br/additional-costs",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

PUT /additional-costs/settings

Ligar ou desligar o uso de custos adicionais na loja

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`enabled`	boolean	sim	Recurso ligado

Resposta: Retorna o mesmo payload de GET /additional-costs.

curl -X PUT "https://api.nivesistemas.com.br/additional-costs/settings" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"enabled":true}'

const res = await fetch("https://api.nivesistemas.com.br/additional-costs/settings", {
  method: "PUT",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "enabled": true
  }),
});
const data = await res.json();

import requests

res = requests.request(
    "PUT",
    "https://api.nivesistemas.com.br/additional-costs/settings",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "enabled": True
    },
)
print(res.json())

POST /additional-costs

Criar custo adicional

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`name`	string	sim	Nome (até 80)
`kind`	string	sim	FIXED (valor em R$) ou PERCENT (percentual, até 100)
`value`	number	sim	Valor ou percentual (0 a 100000; em PERCENT, no máximo 100)
`active`	boolean	não	Ativo (padrão true)
`categoryIds`	string[]	não	Categorias às quais se aplica (até 500; vazio = todas)

Resposta: 201 Created — o custo criado, no fim da ordenação.

curl -X POST "https://api.nivesistemas.com.br/additional-costs" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"name":"Exemplo","kind":"","value":0,"active":true,"categoryIds":null}'

const res = await fetch("https://api.nivesistemas.com.br/additional-costs", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "Exemplo",
    "kind": "",
    "value": 0,
    "active": true,
    "categoryIds": null
  }),
});
const data = await res.json();

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/additional-costs",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "name": "Exemplo",
      "kind": "",
      "value": 0,
      "active": True,
      "categoryIds": None
    },
)
print(res.json())

PATCH /additional-costs/:id

Atualizar custo adicional (campos parciais)

Parâmetros de rota: id

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`name`	string	não	Nome (até 80)
`kind`	string	não	FIXED ou PERCENT
`value`	number	não	Valor ou percentual
`active`	boolean	não	Ativo
`categoryIds`	string[]	não	Categorias às quais se aplica

curl -X PATCH "https://api.nivesistemas.com.br/additional-costs/{id}" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"name":"Exemplo","kind":"","value":0,"active":true,"categoryIds":null}'

const res = await fetch("https://api.nivesistemas.com.br/additional-costs/{id}", {
  method: "PATCH",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "Exemplo",
    "kind": "",
    "value": 0,
    "active": true,
    "categoryIds": null
  }),
});
const data = await res.json();

import requests

res = requests.request(
    "PATCH",
    "https://api.nivesistemas.com.br/additional-costs/{id}",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "name": "Exemplo",
      "kind": "",
      "value": 0,
      "active": True,
      "categoryIds": None
    },
)
print(res.json())

DELETE /additional-costs/:id

Excluir custo adicional

Parâmetros de rota: id

Resposta: 204 No Content

curl -X DELETE "https://api.nivesistemas.com.br/additional-costs/{id}" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/additional-costs/{id}", {
  method: "DELETE",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

import requests

res = requests.request(
    "DELETE",
    "https://api.nivesistemas.com.br/additional-costs/{id}",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())