Fidelidade

Programa de pontos. Requer entitlement loyalty e permissões loyalty.*

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

GET /loyalty/settings

Configurações do programa

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

const res = await fetch("https://api.nivesistemas.com.br/loyalty/settings", {
  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/loyalty/settings",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

PUT /loyalty/settings

Atualizar configurações do programa

curl -X PUT "https://api.nivesistemas.com.br/loyalty/settings" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

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

import requests

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

GET /loyalty/accounts

Listar contas de fidelidade

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

const res = await fetch("https://api.nivesistemas.com.br/loyalty/accounts", {
  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/loyalty/accounts",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

GET /loyalty/accounts/by-customer/:customerId

Saldo/status da conta por cliente

Parâmetros de rota: customerId

curl -X GET "https://api.nivesistemas.com.br/loyalty/accounts/by-customer/{customerId}" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/loyalty/accounts/by-customer/{customerId}", {
  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/loyalty/accounts/by-customer/{customerId}",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

GET /loyalty/accounts/:accountId/ledger

Extrato de pontos

Parâmetros de rota: accountId

curl -X GET "https://api.nivesistemas.com.br/loyalty/accounts/{accountId}/ledger" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/loyalty/accounts/{accountId}/ledger", {
  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/loyalty/accounts/{accountId}/ledger",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

POST /loyalty/accounts/:accountId/status

Ativar/bloquear conta

Parâmetros de rota: accountId

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`status`	string	sim	ACTIVE \| BLOCKED

curl -X POST "https://api.nivesistemas.com.br/loyalty/accounts/{accountId}/status" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"status":""}'

const res = await fetch("https://api.nivesistemas.com.br/loyalty/accounts/{accountId}/status", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "status": ""
  }),
});
const data = await res.json();

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/loyalty/accounts/{accountId}/status",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "status": ""
    },
)
print(res.json())

POST /loyalty/adjust

Ajuste manual de pontos

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`customerId`	uuid	sim	Cliente
`points`	integer	sim	Quantidade (positiva)
`direction`	string	sim	credit \| debit
`reason`	string	sim	Motivo (mín. 5 caracteres)

curl -X POST "https://api.nivesistemas.com.br/loyalty/adjust" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"customerId":"00000000-0000-0000-0000-000000000000","points":1,"direction":"","reason":""}'

const res = await fetch("https://api.nivesistemas.com.br/loyalty/adjust", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "customerId": "00000000-0000-0000-0000-000000000000",
    "points": 1,
    "direction": "",
    "reason": ""
  }),
});
const data = await res.json();

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/loyalty/adjust",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "customerId": "00000000-0000-0000-0000-000000000000",
      "points": 1,
      "direction": "",
      "reason": ""
    },
)
print(res.json())

POST /loyalty/preview

Prévia de ganho/resgate em uma venda

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`customerId`	uuid	não	Cliente
`channel`	string	não	POS \| CONVENIENCE
`priceBasis`	string	não	CASH \| CREDIT \| MIXED
`totalDue`	number	sim	Total devido
`redeemPoints`	integer	não	Pontos a resgatar

curl -X POST "https://api.nivesistemas.com.br/loyalty/preview" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"customerId":"00000000-0000-0000-0000-000000000000","channel":"","priceBasis":"","totalDue":0,"redeemPoints":1}'

const res = await fetch("https://api.nivesistemas.com.br/loyalty/preview", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "customerId": "00000000-0000-0000-0000-000000000000",
    "channel": "",
    "priceBasis": "",
    "totalDue": 0,
    "redeemPoints": 1
  }),
});
const data = await res.json();

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/loyalty/preview",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "customerId": "00000000-0000-0000-0000-000000000000",
      "channel": "",
      "priceBasis": "",
      "totalDue": 0,
      "redeemPoints": 1
    },
)
print(res.json())

GET /loyalty/campaigns

Listar campanhas de fidelidade

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

const res = await fetch("https://api.nivesistemas.com.br/loyalty/campaigns", {
  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/loyalty/campaigns",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

GET /loyalty/campaigns/:id

Detalhe da campanha

Parâmetros de rota: id

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

const res = await fetch("https://api.nivesistemas.com.br/loyalty/campaigns/{id}", {
  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/loyalty/campaigns/{id}",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

POST /loyalty/campaigns

Criar campanha

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`name`	string	sim	Nome
`type`	string	sim	MULTIPLIER \| BONUS_FIXED \| BONUS_PERCENT_BASE
`status`	string	não	DRAFT \| ACTIVE \| FINISHED \| CANCELLED
`multiplier`	number	não	Multiplicador (tipo MULTIPLIER)
`bonusPoints`	integer	não	Pontos bônus
`bonusPercent`	number	não	Percentual bônus

curl -X POST "https://api.nivesistemas.com.br/loyalty/campaigns" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"name":"Exemplo","type":"","status":"","multiplier":0,"bonusPoints":1,"bonusPercent":0}'

const res = await fetch("https://api.nivesistemas.com.br/loyalty/campaigns", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "Exemplo",
    "type": "",
    "status": "",
    "multiplier": 0,
    "bonusPoints": 1,
    "bonusPercent": 0
  }),
});
const data = await res.json();

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/loyalty/campaigns",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "name": "Exemplo",
      "type": "",
      "status": "",
      "multiplier": 0,
      "bonusPoints": 1,
      "bonusPercent": 0
    },
)
print(res.json())

PATCH /loyalty/campaigns/:id

Atualizar campanha

Parâmetros de rota: id

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

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

import requests

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

DELETE /loyalty/campaigns/:id

Excluir campanha

Parâmetros de rota: id

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

const res = await fetch("https://api.nivesistemas.com.br/loyalty/campaigns/{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/loyalty/campaigns/{id}",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

GET /loyalty/report

Relatório de fidelidade

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

const res = await fetch("https://api.nivesistemas.com.br/loyalty/report", {
  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/loyalty/report",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())