Cupons

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

GET /coupons

Listar cupons

curl

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

JavaScript

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

Python

import requests

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

GET /coupons/eligible/birthday

Cupons de aniversário elegíveis

curl

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

JavaScript

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

Python

import requests

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

POST /coupons/eligible/code

Validar código de cupom

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
code	string	sim	Código do cupom

curl

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

JavaScript

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

Python

import requests

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

GET /coupons/:id

Detalhe

Parâmetros de rota: id

curl

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

JavaScript

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

Python

import requests

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

POST /coupons

Criar cupom

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
code	string	sim	Código
name	string	sim	Nome
kind	string	sim	BIRTHDAY | GENERAL
discountType	string	sim	PERCENT | FIXED
discountValue	number	sim	Valor do desconto
status	string	não	ACTIVE | INACTIVE
validFrom	string	não	YYYY-MM-DD
validUntil	string	não	YYYY-MM-DD
maxUsesTotal	integer	não	Limite total de usos
maxUsesPerCustomer	integer	não	Limite por cliente

curl

curl -X POST "https://api.nivesistemas.com.br/coupons" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"code":"","name":"Exemplo","kind":"","discountType":"","discountValue":0,"status":"","validFrom":"","validUntil":"","maxUsesTotal":1,"maxUsesPerCustomer":1}'

JavaScript

const res = await fetch("https://api.nivesistemas.com.br/coupons", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "code": "",
    "name": "Exemplo",
    "kind": "",
    "discountType": "",
    "discountValue": 0,
    "status": "",
    "validFrom": "",
    "validUntil": "",
    "maxUsesTotal": 1,
    "maxUsesPerCustomer": 1
  }),
});
const data = await res.json();

Python

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/coupons",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "code": "",
      "name": "Exemplo",
      "kind": "",
      "discountType": "",
      "discountValue": 0,
      "status": "",
      "validFrom": "",
      "validUntil": "",
      "maxUsesTotal": 1,
      "maxUsesPerCustomer": 1
    },
)
print(res.json())

PATCH /coupons/:id

Atualizar cupom

Parâmetros de rota: id

curl

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

JavaScript

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

Python

import requests

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

DELETE /coupons/:id

Excluir cupom

Parâmetros de rota: id

curl

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

JavaScript

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

Python

import requests

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