Conferência de estoque

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

GET /inventory-counts

Listar conferências

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

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

GET /inventory-counts/:id

Detalhe da conferência

Parâmetros de rota: id

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

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

POST /inventory-counts

Criar conferência

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`name`	string	não	Nome/descrição

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

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

import requests

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

PATCH /inventory-counts/:id

Atualizar conferência

Parâmetros de rota: id

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`name`	string	não	Nome

curl -X PATCH "https://api.nivesistemas.com.br/inventory-counts/{id}" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"name":"Exemplo"}'

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

import requests

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

DELETE /inventory-counts/:id

Excluir conferência em rascunho

Parâmetros de rota: id

Resposta: 204 No Content

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

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

POST /inventory-counts/:id/scan

Registrar leitura (GTIN ou variante)

Parâmetros de rota: id

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`gtin`	string	não	Código de barras
`variantId`	uuid	não	ID da variante
`quantity`	integer	não	Quantidade contada

curl -X POST "https://api.nivesistemas.com.br/inventory-counts/{id}/scan" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"gtin":"","variantId":"00000000-0000-0000-0000-000000000000","quantity":1}'

const res = await fetch("https://api.nivesistemas.com.br/inventory-counts/{id}/scan", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "gtin": "",
    "variantId": "00000000-0000-0000-0000-000000000000",
    "quantity": 1
  }),
});
const data = await res.json();

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/inventory-counts/{id}/scan",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "gtin": "",
      "variantId": "00000000-0000-0000-0000-000000000000",
      "quantity": 1
    },
)
print(res.json())

PUT /inventory-counts/:id/lines

Substituir linhas da conferência

Parâmetros de rota: id

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`lines`	array	sim	Lista de { variantId, countedQty }

curl -X PUT "https://api.nivesistemas.com.br/inventory-counts/{id}/lines" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"lines":[]}'

const res = await fetch("https://api.nivesistemas.com.br/inventory-counts/{id}/lines", {
  method: "PUT",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "lines": []
  }),
});
const data = await res.json();

import requests

res = requests.request(
    "PUT",
    "https://api.nivesistemas.com.br/inventory-counts/{id}/lines",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "lines": []
    },
)
print(res.json())

DELETE /inventory-counts/:id/lines/:lineId

Remover linha

Parâmetros de rota: id, lineId

Resposta: 204 No Content

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

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

POST /inventory-counts/:id/load-all

Carregar todos os produtos

Parâmetros de rota: id

curl -X POST "https://api.nivesistemas.com.br/inventory-counts/{id}/load-all" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

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

POST /inventory-counts/:id/load-variants

Carregar variantes específicas na conferência

Parâmetros de rota: id

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`variantIds`	string[]	sim	IDs das variantes

curl -X POST "https://api.nivesistemas.com.br/inventory-counts/{id}/load-variants" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"variantIds":null}'

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

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/inventory-counts/{id}/load-variants",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "variantIds": None
    },
)
print(res.json())

POST /inventory-counts/:id/apply

Aplicar contagem ao estoque

Parâmetros de rota: id

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

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

POST /inventory-counts/:id/cancel

Cancelar conferência

Parâmetros de rota: id

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

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