API docs by Redocly

API de integração com CISSLive (1.0)

Download OpenAPI specification:Download

API de integração com CISSLive

produto

Serviço para cadastrar e alterar produtos

Authorizations:
BearerAuth
header Parameters
Authorization
required
string
Example: Berear ...

Token para autenticação com a API.

Accept-Language
string
Example: en-US

Locale para tradução de mensagens.

Request Body schema:
idProduto
number

Identificador do produto interno no CissLive, somente usado para retorno.

SKU
required
string [ 1 .. 60 ] characters

Código SKU do produto.

dsProduto
required
string [ 2 .. 100 ] characters

Descrição principal do produto.

dsProdutoComplementar
string <= 100 characters

Descrição complementar do produto.

dsProdutoResumida
required
string [ 2 .. 40 ] characters

Descrição resumida do produto que será impressa no cupom fiscal.

nrEan
required
number <= 99999999999999

Código de barras principal do produto. Para relacionar mais EAN ao produto verifique o serviço de incluir multiplos EANs.

idMarca
number

Código da marca do produto.

idSubGrupo
required
number

Código do subgrupo do produto.

fgEnviaParaBalanca
required
boolean

Informação se o produto deve ser enviado para gerar etiqueta de balança ou não.

fgSolicitaPesagem
required
boolean

Informação se o produto deve ser pesado na frente de caixa.

nrDiasValidade
integer <int32> [ 1 .. 999 ]

Dias de validade do produto, quando enviado para balança.

nrCategoriaProduto
required
string (CategoriaProduto)
Enum: "00" "01" "02" "03" "04" "05" "06" "07" "08" "09" "10" "99"

Tipo do item (produto) disponibilizado pela Sefaz. 00 - Mercadoria para Revenda 01 - Matéria-Prima 02 - Embalagem 03 - Produto em Processo 04 - Produto Acabado 05 - Subproduto 06 - Produto Intermediário 07 - Material de Uso e Consumo 08 - Ativo Imobilizado 09 - Serviços 10 - Outros insumos 99 - Outras

fgAtivo
required
boolean

Indica se o produto está ativo ou não.

fgAtivoVenda
required
boolean

Indica se o produto está ativo para venda ou não.

sgUnidadeMedida
required
string

Abreviação da unidade de medida do produto.

nrOrigemMercadoria
required
integer (OrigemMercadoria)
Enum: 0 1 2 3 4 5 6 7 8

Origem da mercadoria. Preencher conforme tabela padrão da NF-e disponibilizada pela Sefaz. 0 - Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8. 1 - Estrangeira - Importação direta, exceto a indicada no código 6. 2 - Estrangeira - Adquirida no mercado interno, exceto a indicada no código 7. 3 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 40% e inferior ou igual a 70%. 4 - Nacional, cuja produção tenha sido feita em conformidade com os processos produtivos básicos de que tratam as legislações citadas nos Ajustes. 5 - Nacional, mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40%. 6 - Estrangeira - Importação direta, sem similar nacional, constante em lista da CAMEX e gás natural. 7 - Estrangeira - Adquirida no mercado interno, sem similar nacional, constante em lista da CAMEX e gás natural. 8 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70%.

nrNcm
string^\d{8}$

Código da Nomenclatura Comum do Mercosul (NCM) do produto. Deve ser preenchido conforme a tabela padrão da NF-e, disponibilizada pela SEFAZ. Caso não informado, o valor padrão 00000000 será atribuído.

nrCest
string^\d{7}$

Código especificador da substituição tributária. Preencher conforme tabela padrão da NF-e disponibilizada pela Sefaz.

Array of objects

Campos customizados para armazernar informações adicionais do produto.

object

Figura de ICMS do produto.

object

Figura de Pis/Cofins do produto.

vlMultiplicadorVenda
number

Multiplicador de venda

qtMaximaVenda
number

Quantidade maxima permitida para venda do produto

tipoProduto
string (TipoProduto)
Enum: "NORMAL" "VASILHAME"
cdSkuVasilhame
string

Sku do produto vasilhame associado a este item.

fgValidaPeso
boolean

Indica se o peso será validado ou não.

peToleranciaPeso
number

Percentual de tolerância na comparação de peso.

Responses

Request samples

Content type
{
  • "SKU": "123456789",
  • "dsProduto": "Água Mineral 500ML",
  • "dsProdutoComplementar": "Sem Gás",
  • "dsProdutoResumida": "Água Mineral",
  • "nrEan": 7894561230123,
  • "idMarca": 1,
  • "idSubGrupo": 1,
  • "fgSolicitaPesagem": false,
  • "fgEnviaParaBalanca": false,
  • "nrDiasValidade": 5,
  • "nrCategoriaProduto": "00",
  • "fgAtivo": true,
  • "fgAtivoVenda": true,
  • "sgUnidadeMedida": "UN",
  • "nrOrigemMercadoria": 0,
  • "nrNcm": "22011000",
  • "nrCest": "0000000",
  • "vlMultiplicadorVenda": 15.55,
  • "tipoProduto": "NORMAL",
  • "cdSkuVasilhame": "5005174",
  • "camposCustomizados": [
    ],
  • "figuraIcms": {
    },
  • "figuraPisCofins": {
    },
  • "qtMaximaVenda": 10,
  • "fgValidaPeso": true,
  • "peToleranciaPeso": 10.5
}

Response samples

Content type
{
  • "error": "Credenciais Inválidas"
}

Serviço para buscar os dados de produto

Authorizations:
BearerAuth
query Parameters
nrNsu
required
integer >= 0
Example: nrNsu=5

Número sequencial único para busca de dados

header Parameters
Authorization
required
string
Example: Berear ...

Token para autenticação com a API.

Accept-Language
string
Example: en-US

Locale para tradução de mensagens.

Responses

Response samples

Content type
{
  • "idProduto": 1000000,
  • "nrEan": "7891109367285",
  • "dsProduto": "HAVAIANAS SLIM - S SLIM SEASON 33/34 LILAS BEBE",
  • "dsProdutoComplementar": "S SLIM SEASON 33/34 LILAS BEBE",
  • "dsProdutoResumida": "HAVAIANAS SLIM",
  • "fgAtivo": false,
  • "fgAtivoVenda": true,
  • "nrNsu": 25,
  • "SKU": "1000000",
  • "vlMultiplicadorVenda": 15.55
}

Serviço para alterar produtos parcialmente

Permite alterar campos específicos de um produto. A resposta não retorna conteúdo.

Authorizations:
BearerAuth
header Parameters
Authorization
required
string
Example: Berear ...

Token para autenticação com a API.

Accept-Language
string
Example: en-US

Locale para tradução de mensagens.

Request Body schema:
SKU
required
string [ 1 .. 60 ] characters

Código SKU do produto.

dsProduto
string [ 2 .. 100 ] characters

Descrição principal do produto.

dsProdutoComplementar
string <= 100 characters

Descrição complementar do produto.

dsProdutoResumida
string [ 2 .. 40 ] characters

Descrição resumida do produto que será impressa no cupom fiscal.

nrEan
number <= 99999999999999

Código de barras principal do produto. Para relacionar mais EAN ao produto verifique o serviço de incluir multiplos EANs.

idMarca
number

Código da marca do produto.

idSubGrupo
number

Código do subgrupo do produto.

fgEnviaParaBalanca
boolean

Informação se o produto deve ser enviado para gerar etiqueta de balança ou não.

fgSolicitaPesagem
boolean

Informação se o produto deve ser pesado na frente de caixa.

nrDiasValidade
integer <int32> [ 1 .. 999 ]

Dias de validade do produto, quando enviado para balança.

nrCategoriaProduto
string (CategoriaProduto)
Enum: "00" "01" "02" "03" "04" "05" "06" "07" "08" "09" "10" "99"

Tipo do item (produto) disponibilizado pela Sefaz. 00 - Mercadoria para Revenda 01 - Matéria-Prima 02 - Embalagem 03 - Produto em Processo 04 - Produto Acabado 05 - Subproduto 06 - Produto Intermediário 07 - Material de Uso e Consumo 08 - Ativo Imobilizado 09 - Serviços 10 - Outros insumos 99 - Outras

fgAtivo
boolean

Indica se o produto está ativo ou não.

fgAtivoVenda
boolean

Indica se o produto está ativo para venda ou não.

sgUnidadeMedida
string

Abreviação da unidade de medida do produto.

nrOrigemMercadoria
integer (OrigemMercadoria)
Enum: 0 1 2 3 4 5 6 7 8

Origem da mercadoria. Preencher conforme tabela padrão da NF-e disponibilizada pela Sefaz. 0 - Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8. 1 - Estrangeira - Importação direta, exceto a indicada no código 6. 2 - Estrangeira - Adquirida no mercado interno, exceto a indicada no código 7. 3 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 40% e inferior ou igual a 70%. 4 - Nacional, cuja produção tenha sido feita em conformidade com os processos produtivos básicos de que tratam as legislações citadas nos Ajustes. 5 - Nacional, mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40%. 6 - Estrangeira - Importação direta, sem similar nacional, constante em lista da CAMEX e gás natural. 7 - Estrangeira - Adquirida no mercado interno, sem similar nacional, constante em lista da CAMEX e gás natural. 8 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70%.

nrNcm
string^\d{8}$

Código da Nomenclatura Comum do Mercosul (NCM) do produto. Deve ser preenchido conforme a tabela padrão da NF-e, disponibilizada pela SEFAZ. Caso não informado, o valor padrão 00000000 será atribuído.

nrCest
string^\d{7}$

Código especificador da substituição tributária. Preencher conforme tabela padrão da NF-e disponibilizada pela Sefaz.

object

Figura de ICMS do produto.

object

Figura de Pis/Cofins do produto.

vlMultiplicadorVenda
number

Multiplicador de venda

Responses

Request samples

Content type
{
  • "SKU": "123456789",
  • "dsProduto": "Água Mineral 500ML",
  • "dsProdutoComplementar": "Sem Gás",
  • "dsProdutoResumida": "Água Mineral",
  • "nrEan": 7894561230123,
  • "idMarca": 1,
  • "idSubGrupo": 1,
  • "fgSolicitaPesagem": false,
  • "fgEnviaParaBalanca": false,
  • "nrDiasValidade": 5,
  • "nrCategoriaProduto": "00",
  • "fgAtivo": true,
  • "fgAtivoVenda": true,
  • "sgUnidadeMedida": "UN",
  • "nrOrigemMercadoria": 0,
  • "nrNcm": "22011000",
  • "nrCest": "0000000",
  • "vlMultiplicadorVenda": 15.55,
  • "figuraIcms": {
    },
  • "figuraPisCofins": {
    }
}

Response samples

Content type
{
  • "error": "Credenciais Inválidas"
}

Serviço para verificar se produto é existente.

Authorizations:
BearerAuth
query Parameters
cdSku
required
integer >= 0
Example: cdSku=5001142

Número indetificador único do produto

header Parameters
Authorization
required
string
Example: Berear ...

Token para autenticação com a API.

Accept-Language
string
Example: en-US

Locale para tradução de mensagens.

Responses

Response samples

Content type
application/json
true

Serviço para buscar os dados do preço de produto

Authorizations:
BearerAuth
query Parameters
nrNsu
required
integer >= 0
Example: nrNsu=5

Número sequencial único para busca de dados

nrCnpj
required
integer

Número CNPJ da loja para buscar os dados

header Parameters
Authorization
required
string
Example: Berear ...

Token para autenticação com a API.

Accept-Language
string
Example: en-US

Locale para tradução de mensagens.

Responses

Response samples

Content type
{
  • "idProduto": 129797,
  • "cdSku": "129797",
  • "nrEan": "7898043364325",
  • "vlPreco": 21.9,
  • "vlCusto": 14.7,
  • "dhInicioPromocao": "2021-01-27T12:14:01.640",
  • "dhFimPromocao": "2021-01-27T12:14:01.640",
  • "vlPrecoPromocao": 0,
  • "nrNsu": 12
}

Serviço para buscar os dados de produtos a partir de uma lista de códigos de barras

Authorizations:
BearerAuth
query Parameters
page
integer [ 1 .. 999999999 ]
Default: 1
Example: page=1

Número da página na paginação.

limit
integer [ 1 .. 100 ]
Default: 25
Example: limit=100

Limite de registros por página.

nrCodigosBarras
required
integer
Example: nrCodigosBarras=00000000000000,3430493439830

Códigos de barras a serem buscados

header Parameters
Authorization
required
string
Example: Berear ...

Token para autenticação com a API.

Accept-Language
string
Example: en-US

Locale para tradução de mensagens.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": -1,
  • "hasNext": false
}

Serviço para buscar os dados de estoque do produto

Authorizations:
BearerAuth
query Parameters
nrNsu
required
integer >= 0
Example: nrNsu=5

Número sequencial único para busca de dados

nrCnpj
required
integer

Número CNPJ da loja para buscar os dados

idLocalEstoque
required
integer

Código do local de estoque para buscar os dados

header Parameters
Authorization
required
string
Example: Berear ...

Token para autenticação com a API.

Accept-Language
string
Example: en-US

Locale para tradução de mensagens.

Responses

Response samples

Content type
{
  • "idProduto": 119888,
  • "cdSku": "119888",
  • "nrEan": "7891109367285",
  • "qtEstoque": 60,
  • "nrNsu": 2
}

Serviço de cadastro/atualização de custo médio.

Authorizations:
BearerAuth
header Parameters
Authorization
required
string
Example: Berear ...

Token para autenticação com a API.

Accept-Language
string
Example: en-US

Locale para tradução de mensagens.

Request Body schema:
SKU
required
string

Código SKU do produto.

empresas
required
Array of integers

Código das empresas onde o custo médio do produto será alterado.

vlCustoMedio
required
number

Valor do custo médido do produto.

Responses

Request samples

Content type
{
  • "SKU": "123456789",
  • "empresas": [
    ],
  • "vlCustoMedio": 5.99
}

Response samples

Content type
{
  • "SKU": "123456789",
  • "empresas": [
    ],
  • "vlCustoMedio": 5.99
}

Serviço para buscar todos os produtos de uma empresa por data de alteração.

Authorizations:
BearerAuth
query Parameters
nrCnpj
required
integer

Número CNPJ da loja para buscar os dados

dhUltimaSincronizacao
required
string <date-time>
Example: dhUltimaSincronizacao=2023-01-01T01:00:00.000

Data e hora da última sincronização

page
integer [ 1 .. 999999999 ]
Default: 1
Example: page=1

Número da página na paginação.

limit
integer [ 1 .. 100 ]
Default: 25
Example: limit=100

Limite de registros por página.

header Parameters
Authorization
required
string
Example: Berear ...

Token para autenticação com a API.

Accept-Language
string
Example: en-US

Locale para tradução de mensagens.

Responses

Response samples

Content type
[
  • {
    }
]

Serviço para buscar todos os produtos de uma empresa por tag e quantidade miníma de estoque.

Retorna qtSaldoAtual = 0 se menor ou igual a quantidade miníma configurada.

Authorizations:
BearerAuth
query Parameters
nrCnpj
required
integer

Número CNPJ da loja para buscar os dados

dsTag
required
string
Example: dsTag=2023-01-01T01:00:00.000

Tag vinculada ao produto

dhUltimaSincronizacao
required
string <date-time>
Example: dhUltimaSincronizacao=2023-01-01T01:00:00.000

Data e hora da última sincronização

page
integer [ 1 .. 999999999 ]
Default: 1
Example: page=1

Número da página na paginação.

limit
integer [ 1 .. 100 ]
Default: 25
Example: limit=100

Limite de registros por página.

header Parameters
Authorization
required
string
Example: Berear ...

Token para autenticação com a API.

Accept-Language
string
Example: en-US

Locale para tradução de mensagens.

Responses

Response samples

Content type
[
  • {
    }
]

preco

Serviço de cadastro/atualização de preço.

Authorizations:
BearerAuth
header Parameters
Authorization
required
string
Example: Berear ...

Token para autenticação com a API.

Accept-Language
string
Example: en-US

Locale para tradução de mensagens.

Request Body schema:
SKU
required
string [ 1 .. 60 ] characters

Código SKU do produto.

empresas
required
Array of integers

Código das empresas onde o preço do produto será alterado.

nrEan
required
number <= 99999999999999

Código de barras do preço em questão.

vlPreco
required
number [ 0 .. 999999999.99 ]

Preço de venda do produto.

peMargemLucro
required
number [ -999999999.99 .. 999999999.99 ]

Percentual de margem de lucro.

vlPrecoPromocao
number [ 0 .. 999999999.99 ]

Valor de venda do produto em promoção.

dtInicioPromocao
string

Data de início da vigência da promoção.

dtFimPromocao
string

Data de termino da vigência da promoção.

Responses

Request samples

Content type
{
  • "SKU": "123456789",
  • "empresas": [
    ],
  • "nrEan": 7894561230123,
  • "vlPreco": 9.99,
  • "peMargemLucro": 60,
  • "vlPrecoPromocao": 7.99,
  • "dtInicioPromocao": "2020-01-01",
  • "dtFimPromocao": "2020-01-05"
}

Response samples

Content type
{
  • "SKU": "123456789",
  • "empresas": [
    ],
  • "nrEan": 7894561230123,
  • "vlPreco": 9.99,
  • "peMargemLucro": 60,
  • "vlPrecoPromocao": 7.99,
  • "dtInicioPromocao": "2020-01-01",
  • "dtFimPromocao": "2020-01-05"
}

tributacao

Serviço para cadastrar e alterar tributação de ICMS.

Authorizations:
BearerAuth
header Parameters
Authorization
required
string
Example: Berear ...

Token para autenticação com a API.

Accept-Language
string
Example: en-US

Locale para tradução de mensagens.

Request Body schema:
cdFigura
required
string <= 50 characters

Código da Figura de ICMS.

dsFigura
required
string <= 200 characters

Descrição da Figura de ICMS.

required
Array of objects (CenarioIcms)

Cenários de ICMS da figura.

Responses

Request samples

Content type
{
  • "cdFigura": "09011110",
  • "dsFigura": "Café em grão",
  • "cenariosIcms": [
    ]
}

Response samples

Content type
{
  • "cdFigura": "09011110",
  • "dsFigura": "Café em grão",
  • "cenariosIcms": [
    ]
}

Serviço para cadastrar e alterar tributação de Pis/Cofins.

Authorizations:
BearerAuth
header Parameters
Authorization
required
string
Example: Berear ...

Token para autenticação com a API.

Accept-Language
string
Example: en-US

Locale para tradução de mensagens.

Request Body schema:
cdFigura
required
string <= 50 characters

Código da Figura de Pis/Cofins.

dsFigura
required
string <= 200 characters

Descrição da Figura de Pis/Cofins.

required
Array of objects (CenarioPisCofins)

Cenários de Pis/Cofins da figura.

Responses

Request samples

Content type
{
  • "cdFigura": "09011110",
  • "dsFigura": "Café em grão",
  • "cenariosPisCofins": [
    ]
}

Response samples

Content type
{
  • "cdFigura": "09011110",
  • "dsFigura": "Café em grão",
  • "cenariosPisCofins": [
    ]
}

compra

Serviço para inclusão de pedidos de compra.

Authorizations:
BearerAuth
header Parameters
Authorization
required
string
Example: Berear ...

Token para autenticação com a API.

Accept-Language
string
Example: en-US

Locale para tradução de mensagens.

Request Body schema:
nrCnpjFornecedor
required
string

CNPJ do fornecedor do pedido de compra.

idEmpresa
required
number

Código da empresa onde será disponibilizado o pedido de compra.

dtPedido
required
string

Data do pedido de compra.

dtPrevisaoEntrega
string

Data da previsão de entrega.

cdReferencia
string

Código de referência do pedido de compra.

required
Array of objects (PedidoCompraProduto)

Produtos do pedido de compra.

Responses

Request samples

Content type
{
  • "nrCnpjFornecedor": "00000000000000",
  • "idEmpresa": 1,
  • "dtPedido": "2020-05-13",
  • "dtPrevisaoEntrega": "2020-06-13",
  • "cdReferencia": "A1B2C3",
  • "produtos": [
    ]
}

Response samples

Content type
{
  • "nrCnpjFornecedor": "00000000000000",
  • "idEmpresa": 1,
  • "dtPedido": "2020-05-13",
  • "dtPrevisaoEntrega": "2020-06-13",
  • "cdReferencia": "A1B2C3",
  • "produtos": [
    ]
}

status_integracao

Serviço para inclusão de evento de logs

Authorizations:
BearerAuth
header Parameters
Authorization
required
string
Example: Berear ...

Token para autenticação com a API.

Accept-Language
string
Example: en-US

Locale para tradução de mensagens.

Request Body schema:
idTipoIntegracao
required
integer <int64>
Enum: 1 2 3

Código do tipo da integração. "1 - Venda", "2 - Venda Cancelada", "3 - Cancelamento"

idTipoEvento
required
integer <int64>
Enum: 1 2 3 4 5

Código do tipo do evento. 1 - Aguardando, 2 - Aguardando Reenvio, 3 - Envio, 4 - Sucesso, 5 - Erro

cdExterno
required
string [ 1 .. 30 ] characters

Código externo.

dsMensagem
string

Mensagem ou conteúdo do evento de log.

Responses

Request samples

Content type
{
  • "idTipoIntegracao": 1,
  • "idTipoEvento": 1,
  • "cdExterno": 26685972,
  • "dsMensagem": "Cancelamento processado com sucesso."
}

Response samples

Content type
{
  • "idTipoIntegracao": 1,
  • "idTipoEvento": 1,
  • "cdExterno": 26685972,
  • "dsMensagem": "Cancelamento processado com sucesso."
}

movimentacao

Serviço para buscar resumo das movimentações por períodos

Authorizations:
BearerAuth
query Parameters
page
integer [ 1 .. 999999999 ]
Default: 1
Example: page=1

Número da página na paginação.

limit
integer [ 1 .. 100 ]
Default: 25
Example: limit=100

Limite de registros por página.

dtMovimentacaoInicio
required
string
Example: dtMovimentacaoInicio=2020-08-25

Início da faixa de busca de movimentações.
Intervalor entre este campo e o dtMovimentacaoFim deve ser de no máximo 31 dias.

dtMovimentacaoFim
required
string
Example: dtMovimentacaoFim=2020-08-26

Fim da faixa de busca de movimentações.
Intervalor entre este campo e o dtMovimentacaoInicio deve ser de no máximo 31 dias.

header Parameters
Authorization
required
string
Example: Berear ...

Token para autenticação com a API.

Accept-Language
string
Example: en-US

Locale para tradução de mensagens.

Responses

Response samples

Content type
{
  • "total": -1,
  • "hasNext": true,
  • "data": [
    ]
}

Serviço para buscar resumo das movimentações por períodos V2

Authorizations:
BearerAuth
query Parameters
page
integer [ 1 .. 999999999 ]
Default: 1
Example: page=1

Número da página na paginação.

limit
integer [ 1 .. 100 ]
Default: 25
Example: limit=100

Limite de registros por página.

idEmpresa
required
integer
Example: idEmpresa=1

Código da empresa para buscar os dados

dhMovimentacaoInicio
required
string <date-time>
Example: dhMovimentacaoInicio=2024-05-01T08:26:50.286

Início da faixa de busca de movimentações.
Intervalo entre este campo e o dhMovimentacaoInicio deve ser de no máximo 31 dias.

dhMovimentacaoFim
required
string <date-time>
Example: dhMovimentacaoFim=2024-05-28T08:26:50.286

Fim da faixa de busca de movimentações.
Intervalo entre este campo e o dhMovimentacaoFim deve ser de no máximo 31 dias.

dhAlteracaoInicio
string <date-time>
Example: dhAlteracaoInicio=2024-05-01T08:26:50.286

Início da faixa de busca de movimentações.
Intervalo entre este campo e o dhAlteracaoInicio deve ser de no máximo 31 dias.

dhAlteracaoFim
string <date-time>
Example: dhAlteracaoFim=2024-05-28T08:26:50.286

Fim da faixa de busca de movimentações.
Intervalo entre este campo e o dhAlteracaoFim deve ser de no máximo 31 dias.

header Parameters
Authorization
required
string
Example: Berear ...

Token para autenticação com a API.

Accept-Language
string
Example: en-US

Locale para tradução de mensagens.

Responses

Response samples

Content type
{
  • "total": -1,
  • "hasNext": true,
  • "data": [
    ]
}

Serviço para buscar movimentações pelo seu identificador

Este serviço tem o objetivo de buscar os dados da movimentação

Authorizations:
BearerAuth
path Parameters
idMovimentacao
required
integer
Example: 123456

Identificador da movimentação

query Parameters
expand
string
Example: expand=movimentacaoProdutoList.produto.producao,movimentacaoClubeBeneficio

Permite buscar informações detalhadas para objetos adicionais.

header Parameters
Authorization
required
string
Example: Berear ...

Token para autenticação com a API.

Accept-Language
string
Example: en-US

Locale para tradução de mensagens.

Responses

Response samples

Content type
{
  • "idMovimentacao": 123456,
  • "idEmpresa": 123456,
  • "nrCaixa": 123456,
  • "dhMovimentacao": "2020-08-25T16:53:11.424",
  • "nrMovimentacao": 123,
  • "vlTotalLiquido": 23,
  • "vlDesconto": 2.5,
  • "vlDescontoFinanceiro": 1.25,
  • "vlTotalDescontos": 3.75,
  • "vlAcrescimo": 1.25,
  • "vlTotalBruto": 36,
  • "vlOutrasDespesasAcessorias": 0.5,
  • "vlTotalAcrescimos": 1.75,
  • "fgCancelado": false,
  • "nrDocumentoCliente": "12345678909",
  • "nrDocumentoEmpresa": "21426387002247",
  • "tpOrigemPedido": 1,
  • "movimentacaoProdutoList": [
    ],
  • "financeiroReceberList": [
    ],
  • "movimentacaoPessoa": [
    ],
  • "usuario": [
    ],
  • "idOperacao": 1300,
  • "tpOperacao": 96,
  • "tpMovimentacao": "ENTRADA",
  • "tpOrigemVenda": "SISTEMA",
  • "cdIdentificadorDispositivo": "CD123",
  • "tpMovimentacaoStatus": "AUTORIZADA",
  • "movimentacaoFiscal": {
    },
  • "movimentacaoPedido": {
    },
  • "movimentacaoClubeBeneficio": {
    }
}

Serviço para buscar os ids das movimentações por empresa, caixa e data de movimento

Este serviço tem o objetivo de buscar os IDs movimentações de cupons que foram emitidos pelo Box e que estejam aprovados ou cancelados

Authorizations:
BearerAuth
query Parameters
idEmpresa
required
integer
Example: idEmpresa=1

Código da empresa para buscar os dados

idCaixa
integer
Example: idCaixa=1

Código do caixa para buscar os dados

dtMovimento
required
string <ISODate>
Example: dtMovimento=2021-07-20

Data de movimento para buscar os dados

page
integer [ 1 .. 999999999 ]
Default: 1
Example: page=1

Número da página na paginação.

limit
integer [ 1 .. 100 ]
Default: 25
Example: limit=100

Limite de registros por página.

header Parameters
Authorization
required
string
Example: Berear ...

Token para autenticação com a API.

Accept-Language
string
Example: en-US

Locale para tradução de mensagens.

Responses

Response samples

Content type
{
  • "total": 3,
  • "hasNext": true,
  • "data": [
    ]
}

Serviço para buscar os ids das movimentações por empresa, caixa, data de movimento e Status da movimentação

Este serviço tem o objetivo de buscar os IDs movimentações de cupons que foram emitidos pelo Box conforme o status da movimentação

Authorizations:
BearerAuth
query Parameters
idEmpresa
required
integer
Example: idEmpresa=1

Código da empresa para buscar os dados

idCaixa
integer
Example: idCaixa=1

Código do caixa para buscar os dados

tpMovimentacaoStatus
required
integer
Example: tpMovimentacaoStatus=1

Código do status da movimentação

dhInicio
required
string <ISODate>
Example: dhInicio=2021-01-27T01:02:03.456Z

Data de início (esta data deve ser informada padrão UTC 0)

dhFim
required
string <ISODate>
Example: dhFim=2021-01-27T01:02:03.456Z

Data de fim (esta data deve ser informada padrão UTC 0)

page
integer [ 1 .. 999999999 ]
Default: 1
Example: page=1

Número da página na paginação.

limit
integer [ 1 .. 100 ]
Default: 25
Example: limit=100

Limite de registros por página.

header Parameters
Authorization
required
string
Example: Berear ...

Token para autenticação com a API.

Accept-Language
string
Example: en-US

Locale para tradução de mensagens.

Responses

Response samples

Content type
application/json
{
  • "total": 3,
  • "hasNext": true,
  • "data": [
    ]
}

Buscar Movimentação Recarga de Celular

Este serviço tem o objetivo de buscar os dados da movimentação de recarga de celular

Authorizations:
BearerAuth
path Parameters
idMovimentacao
required
integer
Example: 123456

Identificador da movimentação

header Parameters
Authorization
required
string
Example: Berear ...

Token para autenticação com a API.

Accept-Language
string
Example: en-US

Locale para tradução de mensagens.

Responses

Response samples

Content type
{
  • "idMovimentacao": 15407655,
  • "idEmpresa": 102103,
  • "dhMovimentacao": "2025-03-25T08:52:17",
  • "vlTotalLiquido": 10,
  • "vlTotalDescontos": 0,
  • "vlTotalAcrescimos": 0,
  • "tpOrigemPedido": 1,
  • "movimentacaoRecargaCelular": {
    },
  • "financeiroReceberList": [
    ],
  • "usuario": [
    ],
  • "movimentacaoFiscal": {
    }
}

movimentacao_totalizador

Serviço para buscar totalizadores das movimentaçõe do CissLive a partir do somatório de movimentacões registradas no dia, por empresa e caixa.

Authorizations:
BearerAuth
query Parameters
idEmpresa
required
integer
Example: idEmpresa=1

Código da empresa para buscar os dados

idCaixa
integer
Example: idCaixa=1

Código do caixa para buscar os dados

dtMovimento
required
string <ISODate>
Example: dtMovimento=2021-07-20

Data de movimento para buscar os dados

header Parameters
Authorization
required
string
Example: Berear ...

Token para autenticação com a API.

Accept-Language
string
Example: en-US

Locale para tradução de mensagens.

Responses

Response samples

Content type
application/json
{
  • "total": -1,
  • "hasNext": true,
  • "data": [
    ]
}

caixa_resumo_abertura

Serviço para buscar resumo de abertura agrupando pela chave pesquisada

Authorizations:
BearerAuth
query Parameters
idEmpresa
required
integer
Example: idEmpresa=1

Código da empresa para buscar os dados

idCaixa
required
integer
Example: idCaixa=1

Código do caixa para buscar os dados

dtMovimento
required
string <ISODate>
Example: dtMovimento=2021-07-20

Data de movimento para buscar os dados

header Parameters
Authorization
required
string
Example: Berear ...

Token para autenticação com a API.

Accept-Language
string
Example: en-US

Locale para tradução de mensagens.

Responses

Response samples

Content type
{
  • "idEmpresa": 1,
  • "idCaixa": 11,
  • "dtMovimento": "2020-08-25",
  • "qtVenda": 123,
  • "vlVenda": 1499,
  • "qtVendaCancelada": 5,
  • "vlVendaCancelada": 325
}

Serviço para buscar os cabeçalhos de resumo de abertura agrupando por empresa, caixa e data de movimento

Authorizations:
BearerAuth
query Parameters
idEmpresa
required
integer
Example: idEmpresa=1

Código da empresa para buscar os dados

idCaixa
integer
Example: idCaixa=1

Código do caixa para buscar os dados

dtMovimento
required
string <ISODate>
Example: dtMovimento=2021-07-20

Data de movimento para buscar os dados

page
integer [ 1 .. 999999999 ]
Default: 1
Example: page=1

Número da página na paginação.

limit
integer [ 1 .. 100 ]
Default: 25
Example: limit=100

Limite de registros por página.

header Parameters
Authorization
required
string
Example: Berear ...

Token para autenticação com a API.

Accept-Language
string
Example: en-US

Locale para tradução de mensagens.

Responses

Response samples

Content type
{
  • "total": -1,
  • "hasNext": true,
  • "data": [
    ]
}

Serviço para buscar os resumos de abertura que possuem notas canceladas no Live agrupando por empresa e data de cancelamento

Authorizations:
BearerAuth
query Parameters
idEmpresa
required
integer
Example: idEmpresa=1

Código da empresa para buscar os dados

dtCancelamento
required
string <ISODate>
Example: dtCancelamento=2021-01-27

Data de cancelamnto

header Parameters
Authorization
required
string
Example: Berear ...

Token para autenticação com a API.

Accept-Language
string
Example: en-US

Locale para tradução de mensagens.

Responses

Response samples

Content type
application/json
{
  • "idEmpresa": 1,
  • "idCaixa": 11,
  • "dtMovimento": "2020-08-25",
  • "qtVenda": 123,
  • "vlVenda": 1499,
  • "qtVendaCancelada": 5,
  • "vlVendaCancelada": 325
}

Serviço para buscar resumo de abertura agrupando pela chave pesquisada, sumarizando também os cancelamentos feitos pelo Live.

Authorizations:
BearerAuth
query Parameters
idEmpresa
required
integer
Example: idEmpresa=1

Código da empresa para buscar os dados

idCaixa
required
integer
Example: idCaixa=1

Código do caixa para buscar os dados

dtMovimento
required
string <ISODate>
Example: dtMovimento=2021-07-20

Data de movimento para buscar os dados

header Parameters
Authorization
required
string
Example: Berear ...

Token para autenticação com a API.

Accept-Language
string
Example: en-US

Locale para tradução de mensagens.

Responses

Response samples

Content type
{
  • "idEmpresa": 1,
  • "idCaixa": 11,
  • "dtMovimento": "2020-08-25",
  • "qtVenda": 123,
  • "vlVenda": 1499,
  • "qtVendaCancelada": 5,
  • "vlVendaCancelada": 325
}

promocao

Serviço para cadastrar novas promoções

Authorizations:
BearerAuth
header Parameters
Authorization
required
string
Example: Berear ...

Token para autenticação com a API.

Accept-Language
string
Example: en-US

Locale para tradução de mensagens.

Request Body schema: application/json
idPromocao
number

Código interno da promoção.

dsPromocao
required
string [ 1 .. 200 ] characters

Descrição da promoção.

idTipoPromocao
required
integer (TipoPromocao)
Enum: 1 2 3 4

Código do tipo de promoção 1 - Produto 2 - Forma Pagamento 3 - Faixas Desconto 4 - Combo

idTipoTemplatePromocao
integer (TipoTemplatePromocao)
Enum: 1 2 3 4 5

Código do tipo de template para promoções. 1 - Desconto em determinados produtos 2 - Desconto em determinadas formas de pagamento 3 - Desconto em vendas a partir de determinada quantidade 4 - Brinde na venda de determinados produtos 5 - Desconto em vendas com combinações de produtos

idTipoOrigemIntegracao
integer (TipoOrigemIntegracao)
Value: 1

Código da origem da integraçao. 1 - Scantech

dhInicioPromocao
required
string <datetime>

Data e hora de início da promoção.

dhFimPromocao
required
string <datetime>

Data e hora de fim da promoção.

fgAtivo
required
boolean

Flag para ativar ou desativar a promoção.

fgTodosClientes
required
boolean

Flag para indicar que a promoção é para todos os clientes.

peDesconto
required
number

Percentual de desconto a ser aplicado nesta promoção.

vlDesconto
required
number

Valor de desconto a ser aplicado nesta promoção.

idPessoa
number

Id da pessoa que criou / alterou a promoção.

idEmpresaList
required
Array of arrays

Código das empresas as quais será aplicada a promoção.

Array of objects (FormaPagamentoDto)

Lista de forma de pagamento que a promoção deve ser aplicada.

object (PromocaoCombo)

Dados para as promoções do tipo de combo, devem ser informados para os templates 3, 4 e 5.

Array of objects (PromocaoComboAtributo)

Atributos da promoção do tipo combo. Utilizado para permitir condições adicionais na promoção.

Responses

Request samples

Content type
application/json
{
  • "idPromocao": 10004,
  • "dsPromocao": "Promoção de batatas",
  • "idTipoPromocao": 1,
  • "idTipoTemplatePromocao": 1,
  • "idTipoOrigemIntegracao": 1,
  • "dhInicioPromocao": "2021-09-09T00:00:00",
  • "dhFimPromocao": "2021-09-09T23:59:59",
  • "fgAtivo": "true / false",
  • "fgTodosClientes": "true / false",
  • "peDesconto": 10.7,
  • "vlDesconto": 5.1,
  • "idPessoa": 100,
  • "idEmpresaList": [
    ],
  • "formaPagamentoList": [
    ],
  • "promocaoCombo": {
    },
  • "promocaoComboAtributoList": [
    ]
}

Response samples

Content type
application/json
{
  • "idPromocao": 1263,
  • "dsPromocao": "Nova promo API 2",
  • "idTipoTemplatePromocao": 4,
  • "idTipoOrigemIntegracao": 1,
  • "idTipoPromocao": 4,
  • "dhInicioPromocao": "2021-09-09T00:00:00",
  • "dhFimPromocao": "2021-09-09T23:59:59",
  • "fgAtivo": true,
  • "fgTodosClientes": true,
  • "vlDesconto": 0,
  • "peDesconto": 0,
  • "idPessoa": 2089,
  • "idEmpresaList": [
    ],
  • "promocaoCombo": {
    },
  • "promocaoComboAtributoList": [
    ]
}

Serviço para cadastrar produtos para as promoções

Authorizations:
BearerAuth
header Parameters
Authorization
required
string
Example: Berear ...

Token para autenticação com a API.

Accept-Language
string
Example: en-US

Locale para tradução de mensagens.

Request Body schema: application/json
Array
idPromocao
required
number

ID da promoção a qual o produto será vinculado.

idProduto
required
number

ID do produto que será adicionado à promoção.

idTipoDescontoPromocaoProduto
required
integer (TipoDescontoPromocaoProduto)
Value: 1

Código do tipo de desconto a ser aplicado no produto da promoção. 1 - Quantidade

vlMinimo
number

Valor mínimo necessário para ativar a promoção neste produto (utilizado em determinados tipos de promoção).

vlMaximo
number

Valor máximo para ativar a promoção neste produto (utilizado em determinados tipos de promoção).

vlDesconto
required
number

Valor do desconto a ser aplicado neste produto (utilizado em determinados tipos de promoção).

peDesconto
required
number

Percentual de desconto a ser aplicado neste produto (utilizado em determinados tipos de promoção).

fgAtivo
required
boolean

Flag para ativar ou desativar a participação do produto na promoção.

vlPrecoPromocao
required
number

Valor a ser aplicado neste produto nesta promoção (utilizado em determinados tipos de promoção).

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Serviço para cadastrar produtos para promoções do tipo combo

Authorizations:
BearerAuth
header Parameters
Authorization
required
string
Example: Berear ...

Token para autenticação com a API.

Accept-Language
string
Example: en-US

Locale para tradução de mensagens.

Request Body schema: application/json
Array
idPromocaoCombo
required
number

ID da promoção do tipo combo a qual o produto será vinculado.

idProduto
required
number

Id do produto que será adicionado à promoção do tipo combo.

idTipoPromocaoComboProduto
required
integer (TipoPromocaoComboProduto)
Enum: 1 2

Código do tipo de produto para produtos de promoção combo. 1 - Produto de Venda 2 - Produto de Brinde

nrCombinacao
required
number <integer>

Número da combinação para promoção de combinação de produtos.

nrConjunto
required
number

Número do conjunto para promoção de combinação de produtos.

qtVenda
required
number

Quantidade de venda do produto necessária para aplicar a promoção de combinação de produtos.

vlDesconto
required
number

Valor do desconto a ser aplicado neste produto (utilizado em determinados tipos de promoção).

peDesconto
required
number

Percentual de desconto a ser aplicado neste produto (utilizado em determinados tipos de promoção).

idTipoDescontoPromocaoCombo
required
integer (TipoDescontoPromocaoComboProduto)
Enum: 1 2

Código do tipo de desconto a ser aplicado no produto da promoção combo. 1 - Total 2 - Unitário

idTipoOperadorLogico
integer (TipoOperadorLogico)
Enum: 1 2

Código do tipo de promoção combo. Definido a partir do template da promoção. 1 - E 2 - OU

fgAtivo
required
boolean

Flag para ativar ou desativar a participação do produto na promoção combo.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Serviço para ativar ou desativar uma promoção

Authorizations:
BearerAuth
path Parameters
idPromocao
required
integer
Example: 1

Código da promoção

fgAtivo
required
boolean
Example: true / false

Flag ativo true / false

header Parameters
Authorization
required
string
Example: Berear ...

Token para autenticação com a API.

Accept-Language
string
Example: en-US

Locale para tradução de mensagens.

Responses

Response samples

Content type
{
  • "error": "Credenciais Inválidas"
}

financeiro_receber

Serviço para buscar os os dados financeiros a receber agrupados por movimentação para conciliação de cartão e ecomerces

Authorizations:
BearerAuth
query Parameters
idEmpresa
required
integer
Example: idEmpresa=1

Código da empresa para buscar os dados

idMovimentacao
required
integer
Example: idMovimentacao=1

Código da movimentação para buscar os dados

idsFormaPagamento
required
integer
Example: idsFormaPagamento=1,2,3

Lista de código de formas de pagamento para buscar os dados

page
integer [ 1 .. 999999999 ]
Default: 1
Example: page=1

Número da página na paginação.

limit
integer [ 1 .. 100 ]
Default: 25
Example: limit=100

Limite de registros por página.

header Parameters
Authorization
required
string
Example: Berear ...

Token para autenticação com a API.

Accept-Language
string
Example: en-US

Locale para tradução de mensagens.

Responses

Response samples

Content type
application/json
{
  • "total": -1,
  • "hasNext": true,
  • "data": [
    ]
}

produto_estoque_ecommerce

Serviço para buscar estoque dos produtos ecommerce

Authorizations:
BearerAuth
query Parameters
idEmpresa
required
integer
Example: idEmpresa=1

Código da empresa para buscar os dados

dhAlteracao
required
string <date-time>
Example: dhAlteracao=2021-01-27T12:14:01.640

Data e hora da última consulta

page
integer [ 1 .. 999999999 ]
Default: 1
Example: page=1

Número da página na paginação.

limit
integer [ 1 .. 100 ]
Default: 25
Example: limit=100

Limite de registros por página.

header Parameters
Authorization
required
string
Example: Berear ...

Token para autenticação com a API.

Accept-Language
string
Example: en-US

Locale para tradução de mensagens.

Responses

Response samples

Content type
application/json
{
  • "total": -1,
  • "hasNext": true,
  • "data": [
    ]
}

agenda_preco

Serviço para agendar a alteração de preço de um produto

Authorizations:
BearerAuth
header Parameters
Authorization
required
string
Example: Berear ...

Token para autenticação com a API.

Accept-Language
string
Example: en-US

Locale para tradução de mensagens.

Request Body schema:
SKU
required
string [ 1 .. 60 ] characters

Código SKU do produto.

empresas
required
Array of integers

Código das empresas onde o preço do produto será alterado.

vlPreco
required
number [ 0 .. 999999999.99 ]

Preço de venda do produto.

dhInicioVigencia
required
string <datetime>

Data e hora que o preço será alterado.

Responses

Request samples

Content type
{
  • "SKU": "123456789",
  • "empresas": [
    ],
  • "vlPreco": 5.99,
  • "dhInicioVigencia": "2023-01-01T00:00:00"
}

Response samples

Content type
{
  • "SKU": "123456789",
  • "empresas": [
    ],
  • "vlPreco": 5.99,
  • "dhInicioVigencia": "2023-01-01T00:00:00"
}