Catálogo online (admin)

Catálogo, zonas de entrega e pedidos do catálogo online — as rotas mantêm o nome interno /convenience.

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

GET /convenience/settings

Obter configurações

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

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

PUT /convenience/settings

Atualizar configurações

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

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

GET /convenience/cities

Listar cidades

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

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

POST /convenience/cities

Criar cidade

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

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

PUT /convenience/cities/:id

Atualizar cidade

Parâmetros de rota: id

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

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

DELETE /convenience/cities/:id

Excluir

Parâmetros de rota: id

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

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

POST /convenience/cities/:cityId/neighborhoods

Criar bairro

Parâmetros de rota: cityId

curl -X POST "https://api.nivesistemas.com.br/convenience/cities/{cityId}/neighborhoods" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

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

PUT /convenience/neighborhoods/:id

Atualizar bairro

Parâmetros de rota: id

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

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

DELETE /convenience/neighborhoods/:id

Excluir bairro

Parâmetros de rota: id

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

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

GET /convenience/catalog-products

Listar produtos do catálogo (paginado)

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

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

PATCH /convenience/catalog-products/:id

Atualizar

Parâmetros de rota: id

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

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

GET /convenience/orders

Listar pedidos

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

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

GET /convenience/orders/summary

Resumo

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

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

GET /convenience/orders/:id

Detalhe

Parâmetros de rota: id

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

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

PATCH /convenience/orders/:id/fulfillment

Atualizar fulfillment do pedido

Parâmetros de rota: id

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

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

POST /convenience/orders/:id/finalize-cod

Finalizar pedido COD

Parâmetros de rota: id

curl -X POST "https://api.nivesistemas.com.br/convenience/orders/{id}/finalize-cod" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

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

GET /convenience/catalogs

Listar catálogos online

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

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

POST /convenience/catalogs

Criar catálogo

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`name`	string	sim	Nome
`active`	boolean	não	Ativo
`templateId`	string	não	Modelo visual
`brandColor`	string	não	Cor da marca
`whatsappOrderEnabled`	boolean	não	Pedido via WhatsApp
`whatsappPhone`	string	não	WhatsApp
`showInactiveProducts`	boolean	não	Mostra produtos inativos como Indisponível (sem compra)
`showOutOfStock`	boolean	não	Mostra produtos esgotados como Esgotado (sem compra)
`carouselLayout`	boolean	não	Vitrine em carrossel por categoria (padrão: grade)
`showWhatsappContact`	boolean	não	Botão de WhatsApp no topo da vitrine (usa whatsappPhone)
`bannerDataUrl`	string	não	Banner no topo da vitrine (data URL PNG/JPEG/WebP; null remove)
`fulfillmentLocationId`	uuid	não	Local que atende

Resposta: 201 Created

curl -X POST "https://api.nivesistemas.com.br/convenience/catalogs" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"name":"Exemplo","active":true,"templateId":"","brandColor":"","whatsappOrderEnabled":true,"whatsappPhone":"","showInactiveProducts":true,"showOutOfStock":true,"carouselLayout":true,"showWhatsappContact":true,"bannerDataUrl":"","fulfillmentLocationId":"00000000-0000-0000-0000-000000000000"}'

const res = await fetch("https://api.nivesistemas.com.br/convenience/catalogs", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "Exemplo",
    "active": true,
    "templateId": "",
    "brandColor": "",
    "whatsappOrderEnabled": true,
    "whatsappPhone": "",
    "showInactiveProducts": true,
    "showOutOfStock": true,
    "carouselLayout": true,
    "showWhatsappContact": true,
    "bannerDataUrl": "",
    "fulfillmentLocationId": "00000000-0000-0000-0000-000000000000"
  }),
});
const data = await res.json();

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/convenience/catalogs",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "name": "Exemplo",
      "active": True,
      "templateId": "",
      "brandColor": "",
      "whatsappOrderEnabled": True,
      "whatsappPhone": "",
      "showInactiveProducts": True,
      "showOutOfStock": True,
      "carouselLayout": True,
      "showWhatsappContact": True,
      "bannerDataUrl": "",
      "fulfillmentLocationId": "00000000-0000-0000-0000-000000000000"
    },
)
print(res.json())

PATCH /convenience/catalogs/:id

Atualizar catálogo

Parâmetros de rota: id

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

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

DELETE /convenience/catalogs/:id

Excluir catálogo

Parâmetros de rota: id

Resposta: 204 No Content

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

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

PATCH /convenience/orders/:id/delivery-fee

Ajustar a taxa de entrega do pedido

Parâmetros de rota: id

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`fee`	number	sim	Taxa

curl -X PATCH "https://api.nivesistemas.com.br/convenience/orders/{id}/delivery-fee" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"fee":0}'

const res = await fetch("https://api.nivesistemas.com.br/convenience/orders/{id}/delivery-fee", {
  method: "PATCH",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "fee": 0
  }),
});
const data = await res.json();

import requests

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

POST /convenience/catalog-products/add-all

Incluir no catálogo online todos os produtos ativos que ainda não estão nele

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`catalogId`	string	não	Catálogo (omitido = o catálogo padrão)
`q`	string	não	Só produtos cuja descrição contenha o texto (até 200)

Resposta: { catalog: { id, name }, added }. Não inclui produto composto com composição incompleta. 404 se o catálogo informado não existe.

curl -X POST "https://api.nivesistemas.com.br/convenience/catalog-products/add-all" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"catalogId":"","q":""}'

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

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/convenience/catalog-products/add-all",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "catalogId": "",
      "q": ""
    },
)
print(res.json())