API docs by Redocly

CISS Live Api V2 - Documentação das APIs V2 do CISSLive (2.0)

Download OpenAPI specification:Download

Atenção

O Header Authorization é obrigatório em todos os endpoints

Cadastro de Cliente

APIs para criação e alteração de Clientes

Cadastro Cliente

Cadastra/Altera um Cliente.

Authorizations:
BearerAuth
header Parameters
Accept
required
string
Default: application/json

Accepts content type

Content-Type
required
string
Default: application/json

Body content type

Request Body schema: application/json
idPessoa
integer

Código identificador da Pessoa (utilizado para retornar resultado da operação e para indicar o código que a pessoa será criada)

dsCpfCnpj
required
string

CPF/CNPJ da Pessoa

dsNome
required
string [ 2 .. 200 ] characters

Nome da Pessoa

dsIe
string

Número da Inscrição Estadual

dsRg
string

Número do RG

dtNascimento
string <date>

Data de Nascimento

required
object (Endereco)
object (Crediario)
object (Fiscal)
object (PessoaFisica)
Array of objects (PerfilPessoa)
Array of objects (Contato)

Responses

Request samples

Content type
application/json
{
  • "idPessoa": 1,
  • "dsCpfCnpj": "12345678901234",
  • "dsNome": "Pessoa Teste",
  • "dsIe": "1203910239",
  • "dsRg": "123091239",
  • "dtNascimento": "2023-01-30",
  • "endereco": {
    },
  • "crediario": {
    },
  • "fiscal": {
    },
  • "pessoaFisica": {
    },
  • "perfis": [
    ],
  • "contatos": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Inativar Cadastro de Cliente

Inativa um Cliente.

Authorizations:
BearerAuth
path Parameters
dsCpfCnpj
required
string
Example: 12345678901

Documento CPF ou CNPJ da Pessoa

header Parameters
Accept
required
string
Default: application/json

Accepts content type

Content-Type
required
string
Default: application/json

Body content type

Responses

Response samples

Content type
application/json
{ }

Cliente

APIs para consulta de Clientes

Find By Data de Alteração Cliente

Busca uma lista de clientes a partir da data informada.

Authorizations:
BearerAuth
query Parameters
limit
integer >= 1
Example: limit=100

Máximo de itens que serão retornados.

page
integer >= 1
Example: page=1

Especifica o número da página de onde retornará os dados.

dhAlteracao
required
string <date>
Example: dhAlteracao=2023-07-01T00:00:00

Data da alteração cliente

Responses

Response samples

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

XML Downloader

APIs para consulta e solicitação de exportação de XMLs de compra e venda

Exportar XML

Inicia o processo de exportação de XMLs conforme os parâmetros.

Authorizations:
BearerAuth
header Parameters
Accept
required
string
Default: application/json

Accepts content type

Content-Type
required
string
Default: application/json

Body content type

Request Body schema: application/json
tpPedidoDownload
required
string
Enum: "XML_SAIDA" "XML_ENTRADA"

Identificador do tipo de exportação

dtInicio
required
string <date>

Data de início do período

dtFim
required
string <date>

Data fim do período

Responses

Request samples

Content type
application/json
{
  • "tpPedidoDownload": "XML_SAIDA",
  • "dtInicio": "2023-02-01",
  • "dtFim": "2023-02-10"
}

Response samples

Content type
application/json
{
  • "idPedidoDownload": 1,
  • "dsPedidoDownload": "xml_saida 01-02-2023 a 05-02-2023",
  • "dsCaminho": "string",
  • "nrTamanhoArquivo": 7761,
  • "empresa": {
    },
  • "usuarioSolicitante": {
    },
  • "tipoPedidoDownload": {
    },
  • "tipoStatusPedidoDownload": {
    },
  • "tipoExtensaoArquivo": {
    },
  • "dhExpira": "2023-02-05T00:00:00",
  • "dhInclusao": "2023-02-01T10:59:14",
  • "dhAlteracao": "2023-02-01T11:02:48"
}

Find By Id XML

Busca uma exportação de XML pelo id informado.

Authorizations:
BearerAuth
path Parameters
idPedidoDownload
required
integer
Example: 1

Código identificador do Pedido de Download

header Parameters
Accept
required
string
Default: application/json

Accepts content type

Content-Type
required
string
Default: application/json

Body content type

Responses

Response samples

Content type
application/json
{
  • "idPedidoDownload": 1,
  • "dsPedidoDownload": "xml_saida 01-02-2023 a 05-02-2023",
  • "dsCaminho": "string",
  • "nrTamanhoArquivo": 7761,
  • "empresa": {
    },
  • "usuarioSolicitante": {
    },
  • "tipoPedidoDownload": {
    },
  • "tipoStatusPedidoDownload": {
    },
  • "tipoExtensaoArquivo": {
    },
  • "dhExpira": "2023-02-05T00:00:00",
  • "dhInclusao": "2023-02-01T10:59:14",
  • "dhAlteracao": "2023-02-01T11:02:48"
}

Inventário Estoque

APIs para consulta e alteração de Inventários de estoque

Insere Inventário Estoque

Insere um inventário de estoque

Authorizations:
BearerAuth
header Parameters
Accept
required
string
Default: application/json

Accepts content type

Content-Type
required
string
Default: application/json

Body content type

Request Body schema: application/json
idInventarioEstoque
integer <int32>

Código Identificador do Inventário de Estoque

dsInventarioEstoque
required
string [ 2 .. 200 ] characters

Descrição do Inventário de Estoque

object (Empresa-2)
required
object (LocalEstoque)
fgGerarNotaFiscalEncerramento
boolean

Indica se ao encerrar o inventário irá gerar notas de sobra e/ou perda

fgZerarEstoqueApenasProdutosAtivos
boolean

Indica se ao encerrar o inventário irá zerar apenas produtos ativos não contados

statusInventarioEstoque
string
Enum: "ABERTO" "ENCERRADO" "PROCESSANDO"

Status atual do Inventário de Estoque

object

Status da Geração das Notas Fiscais de Perda e/ou Sobra

fgAtivo
boolean

Indica se o inventário está ativo

dtAbertura
required
string <date>

Data de Abertura do Inventário de Estoque

Responses

Request samples

Content type
application/json
{
  • "idInventarioEstoque": 3025,
  • "dsInventarioEstoque": "Inventario Estoque 1",
  • "empresa": {
    },
  • "localEstoque": {
    },
  • "fgGerarNotaFiscalEncerramento": false,
  • "fgZerarEstoqueApenasProdutosAtivos": false,
  • "statusInventarioEstoque": "ABERTO",
  • "tipoStatusNotaFiscal": {
    },
  • "fgAtivo": true,
  • "dtAbertura": "2022-12-19"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Find By Id Estoque

Busca um inventário de estoque pelo id informado.

Authorizations:
BearerAuth
path Parameters
idInventarioEstoque
required
integer
Example: 1

Código identificador do Inventário de Estoque

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Atualiza Inventário Estoque

Atualiza um inventário de estoque

Authorizations:
BearerAuth
path Parameters
idInventarioEstoque
required
integer
Example: 1

Código identificador do Inventário de Estoque

header Parameters
Accept
required
string
Default: application/json

Accepts content type

Content-Type
required
string
Default: application/json

Body content type

Request Body schema: application/json
idInventarioEstoque
integer <int32>

Código Identificador do Inventário de Estoque

dsInventarioEstoque
required
string [ 2 .. 200 ] characters

Descrição do Inventário de Estoque

object (Empresa-2)
required
object (LocalEstoque)
fgGerarNotaFiscalEncerramento
boolean

Indica se ao encerrar o inventário irá gerar notas de sobra e/ou perda

fgZerarEstoqueApenasProdutosAtivos
boolean

Indica se ao encerrar o inventário irá zerar apenas produtos ativos não contados

statusInventarioEstoque
string
Enum: "ABERTO" "ENCERRADO" "PROCESSANDO"

Status atual do Inventário de Estoque

object

Status da Geração das Notas Fiscais de Perda e/ou Sobra

fgAtivo
boolean

Indica se o inventário está ativo

dtAbertura
required
string <date>

Data de Abertura do Inventário de Estoque

Responses

Request samples

Content type
application/json
{
  • "idInventarioEstoque": 3025,
  • "dsInventarioEstoque": "Inventario Estoque 1",
  • "empresa": {
    },
  • "localEstoque": {
    },
  • "fgGerarNotaFiscalEncerramento": false,
  • "fgZerarEstoqueApenasProdutosAtivos": false,
  • "statusInventarioEstoque": "ABERTO",
  • "tipoStatusNotaFiscal": {
    },
  • "fgAtivo": true,
  • "dtAbertura": "2022-12-19"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Encerrar Inventário Estoque

Encerra um inventário de estoque

Authorizations:
BearerAuth
path Parameters
idInventarioEstoque
required
integer
Example: 1

Código identificador do Inventário de Estoque

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Inventário Estoque Produto

APIs para consulta e alteração de produtos de um Inventários de estoque

Find All

Busca os produtos inseridos em um Inventário de Estoque

Authorizations:
BearerAuth
query Parameters
idInventarioEstoque
required
integer >= 1
Example: idInventarioEstoque=1

Código identificador do Inventário de Estoque

limit
integer >= 1
Example: limit=100

Máximo de itens que serão retornados.

page
integer >= 1
Example: page=1

Especifica o número da página de onde retornará os dados.

Responses

Response samples

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

Post

Insere um produto em um inventário de estoque

Authorizations:
BearerAuth
header Parameters
Accept
required
string
Default: application/json

Accepts content type

Content-Type
required
string
Default: application/json

Body content type

Request Body schema: application/json
idInventarioEstoqueProduto
integer <int64>
required
object (InventarioEstoque-2)
required
object (Produto)
vlCustoTotal
number
vlCustoUnitario
required
number

Valor do Custo Unitário do Produto

qtProduto
required
number

Quantidade do Produto

required
object (ProdutoLocalEstoque)

Responses

Request samples

Content type
application/json
{
  • "idInventarioEstoqueProduto": 10,
  • "inventarioEstoque": {
    },
  • "produto": {
    },
  • "vlCustoTotal": 1.23,
  • "vlCustoUnitario": 1.23,
  • "qtProduto": 1,
  • "produtoLocalEstoque": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Put

Atualiza um produto dentro de um inventário de estoque

Authorizations:
BearerAuth
path Parameters
idInventarioEstoqueProduto
required
integer
Example: 1

Código identificador do Produto dentro do Inventário de Estoque

header Parameters
Accept
required
string
Default: application/json

Accepts content type

Content-Type
required
string
Default: application/json

Body content type

Request Body schema: application/json
idInventarioEstoqueProduto
integer <int64>
required
object (InventarioEstoque-2)
required
object (Produto)
vlCustoTotal
number
vlCustoUnitario
required
number

Valor do Custo Unitário do Produto

qtProduto
required
number

Quantidade do Produto

required
object (ProdutoLocalEstoque)

Responses

Request samples

Content type
application/json
{
  • "idInventarioEstoqueProduto": 10,
  • "inventarioEstoque": {
    },
  • "produto": {
    },
  • "vlCustoTotal": 1.23,
  • "vlCustoUnitario": 1.23,
  • "qtProduto": 1,
  • "produtoLocalEstoque": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Local Estoque

APIs para consulta de Locais de Estoque

Find By Id Estoque

Busca um local de estoque pelo id informado.

Authorizations:
BearerAuth
path Parameters
idLocalEstoque
required
integer
Example: 1

Código identificador do Local de Estoque

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Find Locais Estoque Relacionados com a Empresa

Busca os locais de estoque relacionados com a empresa atual.

Authorizations:
BearerAuth
query Parameters
search
string

Termo para filtrar os resultados da busca

limit
integer >= 1
Example: limit=100

Máximo de itens que serão retornados.

page
integer >= 1
Example: page=1

Especifica o número da página de onde retornará os dados.

Responses

Response samples

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

Produto

APIs para consulta de produtos

Find All With Estoque

Busca os produtos com informações de estoque e custo atuais.

Authorizations:
BearerAuth
query Parameters
idLocalEstoque
required
integer >= 1
Example: idLocalEstoque=1

Código identificador do Local de Estoque

dtPosicaoEstoque
required
string <date>
Example: dtPosicaoEstoque=2022-12-20

Data da Posição de Estoque

idDivisao
integer
Example: idDivisao=1

Código identificador da Divisão do Produto

idSecao
integer
Example: idSecao=1

Código identificador da Seção do Produto

idGrupo
integer
Example: idGrupo=1

Código identificador do Grupo do Produto

idSubgrupo
integer
Example: idSubgrupo=1

Código identificador do Subgrupo do Produto

fgAtivo
boolean

Indica se deve buscar apenas por registros ativos ou inativos

search
string

Termo para filtrar os resultados da busca

limit
integer >= 1
Example: limit=100

Máximo de itens que serão retornados.

page
integer >= 1
Example: page=1

Especifica o número da página de onde retornará os dados.

Responses

Response samples

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

Divisão

APIs para consulta de divisões

Seção

APIs para consulta de seções

Grupo

APIs para consulta de grupos

Subgrupo

APIs para consulta de subgrupos

Cadastro de Subgrupo

Insere/Atualiza um subgrupo e sua estrutura (Grupo/Secão/Divisão)
Ao atualizar um subgrupo irá atualizar as descrições de toda a estrutura pelos seus respectivos ids (idGrupo, idSecao, idDivisao)

Authorizations:
BearerAuth
header Parameters
Accept
required
string
Default: application/json

Accepts content type

Content-Type
required
string
Default: application/json

Body content type

Request Body schema: application/json
idSubgrupo
required
integer

Identificador do subgrupo
Utilizado para definir se insere ou atualiza o subgrupo

dsSubgrupo
required
string [ 2 .. 200 ] characters

Descrição do subgrupo
Campo unico, só pode existir um subgrupo com uma descrição

required
object (Grupo-2)

Grupo

peCustoAdicional
number <double>

Percentual de custo adicional do subgrupo

fgAtivo
required
boolean

Indica se o subgrupo está ativo ou inativo

idSubgrupoExterno
string <= 50 characters

Identificador externo do subgrupo
Campo livre para gravar algum identificador se necessário
Não é usado no sistema do live para nenhuma validação

Responses

Request samples

Content type
application/json
{
  • "idSubgrupo": 1,
  • "dsSubgrupo": "Refrigerantes",
  • "grupo": {
    },
  • "peCustoAdicional": 10.5,
  • "fgAtivo": true,
  • "idSubgrupoExterno": "SG001"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Cadastro Produto Cesta

APIs para cadastro simplificado de Produtos Cesta

Merge Produto Cesta Simplificado

Cadastro Produto Cesta Simplificado

Authorizations:
BearerAuth
header Parameters
Accept
required
string
Default: application/json

Accepts content type

Content-Type
required
string
Default: application/json

Body content type

Request Body schema: application/json
cdSku
required
string [ 1 .. 60 ] characters

Código SKU do produto.

dsCesta
required
string [ 1 .. 100 ] characters

Descrição da cesta de produtos.

dsAbreviacaoUnidadeMedida
string

Abreviação da Unidade de Medida, possui valor default "UN".

nrEan
integer

Código EAN do produto.

fgPrecoFixo
required
boolean

Indicador de preço fixo para o produto.

fgTodasEmpresas
required
boolean

Indicador de inclusão de todas as empresas.

required
Array of objects (CadastroProdutoCestaItemWrapper) non-empty

Lista de itens da cesta.

Responses

Request samples

Content type
application/json
{
  • "cdSku": "533222-A",
  • "dsCesta": "PRODUTO DO TIPO CESTA PARA TESTE",
  • "dsAbreviacaoUnidadeMedida": "CX",
  • "nrEan": 1771,
  • "fgPrecoFixo": false,
  • "fgTodasEmpresas": false,
  • "itens": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Merge Cadastro Produto Cesta Rateio

Cadastro Produto Cesta Com Rateio Simplificado

Authorizations:
BearerAuth
header Parameters
Accept
required
string
Default: application/json

Accepts content type

Content-Type
required
string
Default: application/json

Body content type

Request Body schema: application/json
cdSku
required
string [ 1 .. 60 ] characters

Código SKU do produto.

dsCesta
required
string [ 1 .. 100 ] characters

Descrição da cesta de produtos.

dsAbreviacaoUnidadeMedida
string

Abreviação da Unidade de Medida, possui valor default "UN".

nrEan
integer

Código EAN do produto.

fgTodasEmpresas
required
boolean

Indicador de inclusão de todas as empresas.

required
Array of objects (CadastroProdutoCestaItemRateioWrapper) non-empty

Lista de itens da cesta.

vlPreco
required
number <decimal> [ 0.01 .. 999999999.99 ]

Valor do preço da cesta para todas as empresas. Requerido quando o campo fgTodasEmpresas for true.

Array of objects (CadastroProdutoCestaEmpresaRateioWrapper) non-empty

Lista de preços por empresa. Requerido quando o campo fgTodasEmpresas for false.

Responses

Request samples

Content type
application/json
{
  • "cdSku": "242939",
  • "dsCesta": "PRODUTO DO TIPO CESTA PARA TESTE",
  • "dsAbreviacaoUnidadeMedida": "CX",
  • "nrEan": 1771,
  • "fgTodasEmpresas": false,
  • "itens": [
    ],
  • "vlPreco": 199.99,
  • "precoEmpresaList": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Inativar Cadastro Produto Cesta

Inativa Produto Cesta

Authorizations:
BearerAuth
header Parameters
Accept
required
string
Default: application/json

Accepts content type

Content-Type
required
string
Default: application/json

Body content type

Request Body schema: application/json
cdSku
required
string [ 1 .. 60 ] characters

Código SKU do produto.

idEmpresaList
Array of integers

ID da empresa.

Responses

Request samples

Content type
application/json
{
  • "cdSku": "89991-B",
  • "idEmpresaList": [
    ]
}

Response samples

Content type
application/json
{ }

Produto Critério Desconto Atacarejo

API para merge de critérios de desconto para produtos Atacarejo

Merge Produto Critério Desconto Atacarejo

Insere/Atualiza um critério de desconto atacarejo.

Authorizations:
BearerAuth
header Parameters
Accept
required
string
Default: application/json

Accepts content type

Content-Type
required
string
Default: application/json

Body content type

Request Body schema: application/json
required
object (Produto-2)

Produto

idEmpresa
required
integer

Identificador da empresa

tpCriterio
required
string
Value: "A_PARTIR_DE"

Tipo de critério de desconto

qtProduto
required
integer

Quantidade de produto para aplicar o desconto

peDesconto
required
number <double>

Percentual de desconto

fgAtivo
boolean

Flag indicando se o registro está ativo

Responses

Request samples

Content type
application/json
{
  • "produto": {
    },
  • "idEmpresa": 101658,
  • "tpCriterio": "A_PARTIR_DE",
  • "qtProduto": 6,
  • "peDesconto": 10.5,
  • "fgAtivo": true
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Inativar Produto Critério Desconto Atacarejo

Inativa critérios de desconto atacarejo.

Authorizations:
BearerAuth
header Parameters
Accept
required
string
Default: application/json

Accepts content type

Content-Type
required
string
Default: application/json

Body content type

Request Body schema: application/json
cdSku
required
string [ 1 .. 60 ] characters

Código SKU do produto.

idEmpresa
required
integer

ID da empresa.

Responses

Request samples

Content type
application/json
{
  • "cdSku": "222275",
  • "idEmpresa": 1
}

Response samples

Content type
application/json
{ }

Código de Barras Adicional

API para merge de Código de Barras Adicionais

Cadastro de Código Barra Adicional

Insere/Altera códigos de barras adicionais para um produto.
Atualização é feita baseado no nrCodigoBarra e SKU do produto.

Authorizations:
BearerAuth
header Parameters
Accept
required
string
Default: application/json

Accepts content type

Content-Type
required
string
Default: application/json

Body content type

Request Body schema: application/json
idProdutoCodigoBarra
integer

Identificador de produto código de barras
utilizado somente na resposta com o id gerado

required
object (ProdutoWrapper)
required
object (UnidadeMedidaWrapper)
nrCodigoBarra
required
string

Código de barras

fgAtivo
boolean
Default: true

Indica se o código de barras adicional está ativo ou inativo

fgSobrescreveVlFatorConversao
required
boolean

Indica se o código de barras adicional usa um fator de conversão (Personalizar Gramatura)

vlFatorConversao
number
Default: 1

Quantidade de unidades que esse código de barras representa (Gramatura)
Ex: Se for uma caixa que contém 10 unidades de um produto, deve enviar 10.
Obrigatoriedade: Se fgSobrescreveVlFatorConversao = true

fgSobrescreveVlPrecoPrincipal
boolean
Default: false

Indica se o código de barras adicional sobrescreve o valor preço do produto principal
Necessário gravar um preço para o código de barras adicional através do Endpoint de Preço

fgGeraEtiqueta
boolean
Default: false

Indica se gera etiqueta no CissLive

fgSolicitaPesagem
boolean
Default: false

Indica se solicita pesagem no caixa

Responses

Request samples

Content type
application/json
{
  • "idProdutoCodigoBarra": 1,
  • "produto": {
    },
  • "unidadeMedida": {
    },
  • "nrCodigoBarra": 1234567891234,
  • "fgAtivo": true,
  • "fgSobrescreveVlFatorConversao": "true",
  • "vlFatorConversao": 10,
  • "fgSobrescreveVlPrecoPrincipal": "true",
  • "fgGeraEtiqueta": "true",
  • "fgSolicitaPesagem": "true"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Sobre

CISSLive API V2