Campanhas promocionais

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

GET /promotional-campaigns

Listar campanhas

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

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

GET /promotional-campaigns/settings

Configurações de campanhas

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

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

PATCH /promotional-campaigns/settings

Atualizar configurações

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

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

POST /promotional-campaigns

Criar campanha

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`name`	string	sim	Nome
`type`	string	sim	LIVE \| QUEIMA_ESTOQUE \| BLACK_FRIDAY \| FEIRAO \| OUTLET \| PROMOCAO \| OUTRO
`description`	string	não	Descrição
`startsAt`	string	não	Início
`endsAt`	string	não	Fim
`commissionPercent`	number \| null	não	Comissão do vendedor na campanha (%). Null = usa o cadastro do vendedor

curl -X POST "https://api.nivesistemas.com.br/promotional-campaigns" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"name":"Exemplo","type":"","description":"","startsAt":"","endsAt":"","commissionPercent":null}'

const res = await fetch("https://api.nivesistemas.com.br/promotional-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": "",
    "description": "",
    "startsAt": "",
    "endsAt": "",
    "commissionPercent": null
  }),
});
const data = await res.json();

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/promotional-campaigns",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "name": "Exemplo",
      "type": "",
      "description": "",
      "startsAt": "",
      "endsAt": "",
      "commissionPercent": None
    },
)
print(res.json())

GET /promotional-campaigns/:id

Detalhe

Parâmetros de rota: id

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

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

GET /promotional-campaigns/:id/details

Totais por cliente, faturamento e gráficos

Parâmetros de rota: id

Query params

Campo	Tipo	Obrigatório	Descrição
`from`	string	não	Data inicial (YYYY-MM-DD). Omite para toda a campanha
`to`	string	não	Data final (YYYY-MM-DD). Omite para toda a campanha

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

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

PATCH /promotional-campaigns/:id

Atualizar

Parâmetros de rota: id

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

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

POST /promotional-campaigns/:id/activate

Ativar

Parâmetros de rota: id

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

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

import requests

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

POST /promotional-campaigns/:id/finish

Encerrar

Parâmetros de rota: id

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

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

import requests

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

POST /promotional-campaigns/:id/cancel

Cancelar

Parâmetros de rota: id

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

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

import requests

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

DELETE /promotional-campaigns/:id

Excluir

Parâmetros de rota: id

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

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

GET /promotional-campaigns/:id/prices

Listar preços da campanha

Parâmetros de rota: id

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

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

GET /promotional-campaigns/:id/prices/:productId

Preço de um produto

Parâmetros de rota: id, productId

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

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

PUT /promotional-campaigns/:id/prices/:productId

Definir preço de campanha do produto

Parâmetros de rota: id, productId

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`price`	number	sim	Preço promocional

curl -X PUT "https://api.nivesistemas.com.br/promotional-campaigns/{id}/prices/{productId}" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"price":0}'

const res = await fetch("https://api.nivesistemas.com.br/promotional-campaigns/{id}/prices/{productId}", {
  method: "PUT",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "price": 0
  }),
});
const data = await res.json();

import requests

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

DELETE /promotional-campaigns/:id/prices/:productId

Remover preço de campanha do produto

Parâmetros de rota: id, productId

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

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