API-SGF

Este documento apresenta as especificações da API de integração com o sistema Trier Drogarias, desenvolvida para atender clientes e parceiros da Trier Sistemas. A API tem como objetivo facilitar a comunicação entre sistemas externos e o SGF, promovendo interoperabilidade e automação de processos.

A interface pode ser acessada por meio do endereço do servidor, conforme o exemplo: http://localhost:4647/sgfpod1/rest/*

Para utilizar os métodos disponíveis, é necessário realizar autenticação via token do tipo Bearer, fornecido pela Trier Sistemas.

Informações técnicas:

BASE_URL: http://localhost:4647/sgfpod1 (localhost deve ser substituído pelo IP do servidor no ambiente do cliente)
Acesso externo: requer IP fixo ou DDNS e redirecionamento da porta 4647 no modem ou roteador da farmácia (NAT ou Virtual Server)
Acesso interno: não é necessário redirecionamento de porta

Em caso de dúvidas durante o processo de homologação ou desenvolvimento, entre em contato com a equipe de parcerias da Trier Sistemas pelo e-mail: parcerias@grupotrier.com.br.

More information: https://triersistemas.com.br/suporte/

Contact Info: hello@helloreverb.com

Version: 1.5.14

http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

AgileGO

post /integracao/agilego/atualizar-status-v1

Atualiza o status da venda conforme notificação do Agilego. (atualizarStatusV1)

Para fazer uma requisição para esse endpoint, é necessário que o Agilego esteja configurado no sistema.

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body WebhookDto (required)

Body Parameter — Objeto contendo as informações do webhook do Agilego.

Return type

String

Example data

Content-Type: application/json

"OK"

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Status da venda atualizado com sucesso. String

400

Requisição inválida.

401

Não autorizado.

500

Erro na atualização do status da venda.

Carto

get /integracao/cartao/obter-v1

Lista cartões. (obterCartaoV1)

Retorna os cartões cadastrados conforme os filtros informados.

Query parameters

codigoCartao (optional)

Query Parameter — Código do cartão.

ativo (optional)

Query Parameter — Indica se o cartão está ativo ou inativo.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[CartaoIntegracaoRetornoDto]

Example data

Content-Type: application/json

[ {
  "ativo" : true,
  "descontoMaximoCartao" : 6.027456183070403,
  "codigoCartao" : 1,
  "taxaAdministrativaParcela" : [ {
    "parcelaInicial" : "1",
    "parcelaFinal" : "1",
    "taxaAdministrativa" : "1.23"
  } ],
  "modalidadeVenda" : "DÉBITO",
  "administradora" : {
    "codigoFornecedor" : "1",
    "nomeFornecedor" : "ADMINISTRADORA PADRÃO"
  },
  "descontoCartao" : 0.8008281904610115,
  "nomeCartao" : "CARTAO PADRAO",
  "carteiraDigital" : "PIC PAY",
  "vencimentoParcelas" : [ "30", "60", "90" ],
  "taxaAdministrativa" : 1.23,
  "gerenciadorTEF" : {
    "codigoBandeira" : "1",
    "nomeBandeira" : "VISA"
  },
  "qtdMaxParcelas" : 12
}, {
  "ativo" : true,
  "descontoMaximoCartao" : 6.027456183070403,
  "codigoCartao" : 1,
  "taxaAdministrativaParcela" : [ {
    "parcelaInicial" : "1",
    "parcelaFinal" : "1",
    "taxaAdministrativa" : "1.23"
  } ],
  "modalidadeVenda" : "DÉBITO",
  "administradora" : {
    "codigoFornecedor" : "1",
    "nomeFornecedor" : "ADMINISTRADORA PADRÃO"
  },
  "descontoCartao" : 0.8008281904610115,
  "nomeCartao" : "CARTAO PADRAO",
  "carteiraDigital" : "PIC PAY",
  "vencimentoParcelas" : [ "30", "60", "90" ],
  "taxaAdministrativa" : 1.23,
  "gerenciadorTEF" : {
    "codigoBandeira" : "1",
    "nomeBandeira" : "VISA"
  },
  "qtdMaxParcelas" : 12
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Lista de cartões retornada com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta dos cartões.

get /integracao/cartao/obter-alterados-v1

Lista cartões alterados. (obterCartoesAlteradosV1)

Retorna os cartões cadastrados que foram alterados dentro do intervalo de datas informado.

Query parameters

dataInicial (required)

Query Parameter — Informar data em formato ISO 8601.

dataFinal (required)

Query Parameter — Informar data em formato ISO 8601.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[CartaoIntegracaoRetornoDto]

Example data

Content-Type: application/json

[ {
  "ativo" : true,
  "descontoMaximoCartao" : 6.027456183070403,
  "codigoCartao" : 1,
  "taxaAdministrativaParcela" : [ {
    "parcelaInicial" : "1",
    "parcelaFinal" : "1",
    "taxaAdministrativa" : "1.23"
  } ],
  "modalidadeVenda" : "DÉBITO",
  "administradora" : {
    "codigoFornecedor" : "1",
    "nomeFornecedor" : "ADMINISTRADORA PADRÃO"
  },
  "descontoCartao" : 0.8008281904610115,
  "nomeCartao" : "CARTAO PADRAO",
  "carteiraDigital" : "PIC PAY",
  "vencimentoParcelas" : [ "30", "60", "90" ],
  "taxaAdministrativa" : 1.23,
  "gerenciadorTEF" : {
    "codigoBandeira" : "1",
    "nomeBandeira" : "VISA"
  },
  "qtdMaxParcelas" : 12
}, {
  "ativo" : true,
  "descontoMaximoCartao" : 6.027456183070403,
  "codigoCartao" : 1,
  "taxaAdministrativaParcela" : [ {
    "parcelaInicial" : "1",
    "parcelaFinal" : "1",
    "taxaAdministrativa" : "1.23"
  } ],
  "modalidadeVenda" : "DÉBITO",
  "administradora" : {
    "codigoFornecedor" : "1",
    "nomeFornecedor" : "ADMINISTRADORA PADRÃO"
  },
  "descontoCartao" : 0.8008281904610115,
  "nomeCartao" : "CARTAO PADRAO",
  "carteiraDigital" : "PIC PAY",
  "vencimentoParcelas" : [ "30", "60", "90" ],
  "taxaAdministrativa" : 1.23,
  "gerenciadorTEF" : {
    "codigoBandeira" : "1",
    "nomeBandeira" : "VISA"
  },
  "qtdMaxParcelas" : 12
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Lista de cartões alterados retornada com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta dos cartões alterados.

get /integracao/cartao/obter-todos-v1

Lista todos os cartões. (obterTodosCartoesV1)

Retorna todos os cartões cadastrados.

Query parameters

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[CartaoIntegracaoRetornoDto]

Example data

Content-Type: application/json

[ {
  "ativo" : true,
  "descontoMaximoCartao" : 6.027456183070403,
  "codigoCartao" : 1,
  "taxaAdministrativaParcela" : [ {
    "parcelaInicial" : "1",
    "parcelaFinal" : "1",
    "taxaAdministrativa" : "1.23"
  } ],
  "modalidadeVenda" : "DÉBITO",
  "administradora" : {
    "codigoFornecedor" : "1",
    "nomeFornecedor" : "ADMINISTRADORA PADRÃO"
  },
  "descontoCartao" : 0.8008281904610115,
  "nomeCartao" : "CARTAO PADRAO",
  "carteiraDigital" : "PIC PAY",
  "vencimentoParcelas" : [ "30", "60", "90" ],
  "taxaAdministrativa" : 1.23,
  "gerenciadorTEF" : {
    "codigoBandeira" : "1",
    "nomeBandeira" : "VISA"
  },
  "qtdMaxParcelas" : 12
}, {
  "ativo" : true,
  "descontoMaximoCartao" : 6.027456183070403,
  "codigoCartao" : 1,
  "taxaAdministrativaParcela" : [ {
    "parcelaInicial" : "1",
    "parcelaFinal" : "1",
    "taxaAdministrativa" : "1.23"
  } ],
  "modalidadeVenda" : "DÉBITO",
  "administradora" : {
    "codigoFornecedor" : "1",
    "nomeFornecedor" : "ADMINISTRADORA PADRÃO"
  },
  "descontoCartao" : 0.8008281904610115,
  "nomeCartao" : "CARTAO PADRAO",
  "carteiraDigital" : "PIC PAY",
  "vencimentoParcelas" : [ "30", "60", "90" ],
  "taxaAdministrativa" : 1.23,
  "gerenciadorTEF" : {
    "codigoBandeira" : "1",
    "nomeBandeira" : "VISA"
  },
  "qtdMaxParcelas" : 12
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Lista de cartões retornada com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta dos cartões.

Categoria

get /integracao/categoria/obter-alterados-v1

Lista categorias alteradas no sistema. (obterCategoriasAlteradasV1)

Retorna uma lista com as categorias alteradas entre as datas informadas.

Query parameters

dataInicial (required)

Query Parameter — Informar data em formato ISO 8601.

dataFinal (required)

Query Parameter — Informar data em formato ISO 8601.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[CategoriaIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "codigo" : 1,
  "nome" : "SABONETES"
}, {
  "codigo" : 1,
  "nome" : "SABONETES"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Categorias alteradas retornadas com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de categorias alteradas.

get /integracao/categoria/obter-todos-v1

Lista categorias do sistema. (obterTodosCategoriasV1)

Retorna uma lista com todas as categorias.

Query parameters

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[CategoriaIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "codigo" : 1,
  "nome" : "SABONETES"
}, {
  "codigo" : 1,
  "nome" : "SABONETES"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Categorias retornadas com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de categorias.

Cliente

get /integracao/cliente/obter-alterados-v1

Lista clientes alterados em um período. (obterClientesAlteradosV1)

Retorna lista de clientes que tiveram seus cadastros alterados no período informado, respeitando a paginação.

Query parameters

dataInicial (required)

Query Parameter — Informar data em formato ISO 8601.

dataFinal (required)

Query Parameter — Informar data em formato ISO 8601.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[ClienteIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "ativo" : true,
  "codigo" : 0,
  "estado" : "RS",
  "bairro" : "CENTRO",
  "grupo" : {
    "codigo" : 1,
    "nome" : "PADRAO"
  },
  "nome" : "EDENEI JOSE CIMA",
  "codigoCidade" : "LAJEADO",
  "cep" : "95900000",
  "fone" : "(48)99999-9999",
  "numeroEndereco" : "759",
  "numeroCpfCnpj" : "145.440.400-00",
  "empresaConvenio" : {
    "codigo" : 0,
    "nome" : "nome"
  },
  "logradouro" : "RUA PARAIBA",
  "email" : "email@teste.com"
}, {
  "ativo" : true,
  "codigo" : 0,
  "estado" : "RS",
  "bairro" : "CENTRO",
  "grupo" : {
    "codigo" : 1,
    "nome" : "PADRAO"
  },
  "nome" : "EDENEI JOSE CIMA",
  "codigoCidade" : "LAJEADO",
  "cep" : "95900000",
  "fone" : "(48)99999-9999",
  "numeroEndereco" : "759",
  "numeroCpfCnpj" : "145.440.400-00",
  "empresaConvenio" : {
    "codigo" : 0,
    "nome" : "nome"
  },
  "logradouro" : "RUA PARAIBA",
  "email" : "email@teste.com"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Clientes alterados retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de clientes alterados.

get /integracao/cliente/obter-v1

Lista clientes com filtros. (obterClientesV1)

Retorna lista de clientes cadastrados conforme os filtros informados, respeitando a paginação.

Query parameters

codigo (optional)

Query Parameter — Códigos dos clientes a serem filtrados.

ativo (optional)

Query Parameter — Filtra clientes ativos ou inativos.

numeroCpfCnpj (optional)

Query Parameter — CPF ou CNPJ do cliente a ser filtrado.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[ClienteIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "ativo" : true,
  "codigo" : 0,
  "estado" : "RS",
  "bairro" : "CENTRO",
  "grupo" : {
    "codigo" : 1,
    "nome" : "PADRAO"
  },
  "nome" : "EDENEI JOSE CIMA",
  "codigoCidade" : "LAJEADO",
  "cep" : "95900000",
  "fone" : "(48)99999-9999",
  "numeroEndereco" : "759",
  "numeroCpfCnpj" : "145.440.400-00",
  "empresaConvenio" : {
    "codigo" : 0,
    "nome" : "nome"
  },
  "logradouro" : "RUA PARAIBA",
  "email" : "email@teste.com"
}, {
  "ativo" : true,
  "codigo" : 0,
  "estado" : "RS",
  "bairro" : "CENTRO",
  "grupo" : {
    "codigo" : 1,
    "nome" : "PADRAO"
  },
  "nome" : "EDENEI JOSE CIMA",
  "codigoCidade" : "LAJEADO",
  "cep" : "95900000",
  "fone" : "(48)99999-9999",
  "numeroEndereco" : "759",
  "numeroCpfCnpj" : "145.440.400-00",
  "empresaConvenio" : {
    "codigo" : 0,
    "nome" : "nome"
  },
  "logradouro" : "RUA PARAIBA",
  "email" : "email@teste.com"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Clientes retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de clientes.

get /integracao/cliente/obter-todos-v1

Lista todos os clientes. (obterTodosClientesV1)

Retorna lista com todos os clientes cadastrados, respeitando a paginação.

Query parameters

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[ClienteIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "ativo" : true,
  "codigo" : 0,
  "estado" : "RS",
  "bairro" : "CENTRO",
  "grupo" : {
    "codigo" : 1,
    "nome" : "PADRAO"
  },
  "nome" : "EDENEI JOSE CIMA",
  "codigoCidade" : "LAJEADO",
  "cep" : "95900000",
  "fone" : "(48)99999-9999",
  "numeroEndereco" : "759",
  "numeroCpfCnpj" : "145.440.400-00",
  "empresaConvenio" : {
    "codigo" : 0,
    "nome" : "nome"
  },
  "logradouro" : "RUA PARAIBA",
  "email" : "email@teste.com"
}, {
  "ativo" : true,
  "codigo" : 0,
  "estado" : "RS",
  "bairro" : "CENTRO",
  "grupo" : {
    "codigo" : 1,
    "nome" : "PADRAO"
  },
  "nome" : "EDENEI JOSE CIMA",
  "codigoCidade" : "LAJEADO",
  "cep" : "95900000",
  "fone" : "(48)99999-9999",
  "numeroEndereco" : "759",
  "numeroCpfCnpj" : "145.440.400-00",
  "empresaConvenio" : {
    "codigo" : 0,
    "nome" : "nome"
  },
  "logradouro" : "RUA PARAIBA",
  "email" : "email@teste.com"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Clientes retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de clientes.

Compra

get /integracao/compra/obter-alterados-v1

Lista compras alteradas. (obterComprasAlteradasV1)

Obtém todas as compras que foram alteradas entre as datas informadas.

Query parameters

dataInicial (required)

Query Parameter — Informar data em formato ISO 8601.

dataFinal (required)

Query Parameter — Informar data em formato ISO 8601.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[CompraIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "valorTotalProdutos" : 112.81,
  "codigoFornecedor" : 1,
  "xmlNfe" : "...",
  "itens" : [ {
    "valorCusto" : 8.86,
    "codigoProduto" : 92295,
    "fatorCompra" : 1,
    "valorUnitarioLiquido" : 8.86,
    "quantidadeProdutos" : 2,
    "valorST" : 12.75,
    "valorUnitario" : 8.86
  }, {
    "valorCusto" : 8.86,
    "codigoProduto" : 92295,
    "fatorCompra" : 1,
    "valorUnitarioLiquido" : 8.86,
    "quantidadeProdutos" : 2,
    "valorST" : 12.75,
    "valorUnitario" : 8.86
  } ],
  "chaveAcessoNfe" : "42180261940292005872550160000011331149753323",
  "numeroNotaFiscal" : 1133,
  "dataEntrada" : "2000-01-23T04:56:07.000+00:00",
  "valorTotalNota" : 115.81,
  "quantidadeItens" : 2,
  "datEmissao" : "2000-01-23T04:56:07.000+00:00"
}, {
  "valorTotalProdutos" : 112.81,
  "codigoFornecedor" : 1,
  "xmlNfe" : "...",
  "itens" : [ {
    "valorCusto" : 8.86,
    "codigoProduto" : 92295,
    "fatorCompra" : 1,
    "valorUnitarioLiquido" : 8.86,
    "quantidadeProdutos" : 2,
    "valorST" : 12.75,
    "valorUnitario" : 8.86
  }, {
    "valorCusto" : 8.86,
    "codigoProduto" : 92295,
    "fatorCompra" : 1,
    "valorUnitarioLiquido" : 8.86,
    "quantidadeProdutos" : 2,
    "valorST" : 12.75,
    "valorUnitario" : 8.86
  } ],
  "chaveAcessoNfe" : "42180261940292005872550160000011331149753323",
  "numeroNotaFiscal" : 1133,
  "dataEntrada" : "2000-01-23T04:56:07.000+00:00",
  "valorTotalNota" : 115.81,
  "quantidadeItens" : 2,
  "datEmissao" : "2000-01-23T04:56:07.000+00:00"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Compras alteradas retornadas com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de compras alteradas.

get /integracao/compra/obter-v1

Lista compras com filtros (obterComprasAvancadoV1)

Consulta a lista de compras com filtros opcionais e paginação.

Query parameters

dataEntradaInicial (optional)

Query Parameter — Data de entrada inicial em formato ISO 8601. format: date-time

dataEntradaFinal (optional)

Query Parameter — Data de entrada final em formato ISO 8601. format: date-time

chavenfe (optional)

Query Parameter — Chave de acesso da NF-e.

xmlNfe (optional)

Query Parameter — Quando true, retorna informações com referência ao XML da NF-e.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[CompraIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "valorTotalProdutos" : 112.81,
  "codigoFornecedor" : 1,
  "xmlNfe" : "...",
  "itens" : [ {
    "valorCusto" : 8.86,
    "codigoProduto" : 92295,
    "fatorCompra" : 1,
    "valorUnitarioLiquido" : 8.86,
    "quantidadeProdutos" : 2,
    "valorST" : 12.75,
    "valorUnitario" : 8.86
  }, {
    "valorCusto" : 8.86,
    "codigoProduto" : 92295,
    "fatorCompra" : 1,
    "valorUnitarioLiquido" : 8.86,
    "quantidadeProdutos" : 2,
    "valorST" : 12.75,
    "valorUnitario" : 8.86
  } ],
  "chaveAcessoNfe" : "42180261940292005872550160000011331149753323",
  "numeroNotaFiscal" : 1133,
  "dataEntrada" : "2000-01-23T04:56:07.000+00:00",
  "valorTotalNota" : 115.81,
  "quantidadeItens" : 2,
  "datEmissao" : "2000-01-23T04:56:07.000+00:00"
}, {
  "valorTotalProdutos" : 112.81,
  "codigoFornecedor" : 1,
  "xmlNfe" : "...",
  "itens" : [ {
    "valorCusto" : 8.86,
    "codigoProduto" : 92295,
    "fatorCompra" : 1,
    "valorUnitarioLiquido" : 8.86,
    "quantidadeProdutos" : 2,
    "valorST" : 12.75,
    "valorUnitario" : 8.86
  }, {
    "valorCusto" : 8.86,
    "codigoProduto" : 92295,
    "fatorCompra" : 1,
    "valorUnitarioLiquido" : 8.86,
    "quantidadeProdutos" : 2,
    "valorST" : 12.75,
    "valorUnitario" : 8.86
  } ],
  "chaveAcessoNfe" : "42180261940292005872550160000011331149753323",
  "numeroNotaFiscal" : 1133,
  "dataEntrada" : "2000-01-23T04:56:07.000+00:00",
  "valorTotalNota" : 115.81,
  "quantidadeItens" : 2,
  "datEmissao" : "2000-01-23T04:56:07.000+00:00"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Compras retornadas com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de compras.

get /integracao/compra/obter-todos-v1

Lista todas as compras. (obterTodasComprasV1)

Obtém todas as compras cadastradas.

Query parameters

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[CompraIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "valorTotalProdutos" : 112.81,
  "codigoFornecedor" : 1,
  "xmlNfe" : "...",
  "itens" : [ {
    "valorCusto" : 8.86,
    "codigoProduto" : 92295,
    "fatorCompra" : 1,
    "valorUnitarioLiquido" : 8.86,
    "quantidadeProdutos" : 2,
    "valorST" : 12.75,
    "valorUnitario" : 8.86
  }, {
    "valorCusto" : 8.86,
    "codigoProduto" : 92295,
    "fatorCompra" : 1,
    "valorUnitarioLiquido" : 8.86,
    "quantidadeProdutos" : 2,
    "valorST" : 12.75,
    "valorUnitario" : 8.86
  } ],
  "chaveAcessoNfe" : "42180261940292005872550160000011331149753323",
  "numeroNotaFiscal" : 1133,
  "dataEntrada" : "2000-01-23T04:56:07.000+00:00",
  "valorTotalNota" : 115.81,
  "quantidadeItens" : 2,
  "datEmissao" : "2000-01-23T04:56:07.000+00:00"
}, {
  "valorTotalProdutos" : 112.81,
  "codigoFornecedor" : 1,
  "xmlNfe" : "...",
  "itens" : [ {
    "valorCusto" : 8.86,
    "codigoProduto" : 92295,
    "fatorCompra" : 1,
    "valorUnitarioLiquido" : 8.86,
    "quantidadeProdutos" : 2,
    "valorST" : 12.75,
    "valorUnitario" : 8.86
  }, {
    "valorCusto" : 8.86,
    "codigoProduto" : 92295,
    "fatorCompra" : 1,
    "valorUnitarioLiquido" : 8.86,
    "quantidadeProdutos" : 2,
    "valorST" : 12.75,
    "valorUnitario" : 8.86
  } ],
  "chaveAcessoNfe" : "42180261940292005872550160000011331149753323",
  "numeroNotaFiscal" : 1133,
  "dataEntrada" : "2000-01-23T04:56:07.000+00:00",
  "valorTotalNota" : 115.81,
  "quantidadeItens" : 2,
  "datEmissao" : "2000-01-23T04:56:07.000+00:00"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Compras retornadas com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de compras.

ContaFinanceira

get /integracao/financeiro/conta/obter-alterados-v1

Lista contas que possuem alteração. (obterSaldosContasAlteradosV1)

Retorna lista de contas alteradas no período especificado.

Query parameters

dataInicial (required)

Query Parameter — Informar data em formato ISO 8601.

dataFinal (required)

Query Parameter — Informar data em formato ISO 8601.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[FinanceiroContaIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "digitoAgencia" : "1",
  "numero" : "1234",
  "dataAtualizacao" : "2000-01-23T04:56:07.000+00:00",
  "nome" : "Conta caixa",
  "saldo" : 10.85,
  "numeroAgencia" : "6442",
  "digito" : "2"
}, {
  "digitoAgencia" : "1",
  "numero" : "1234",
  "dataAtualizacao" : "2000-01-23T04:56:07.000+00:00",
  "nome" : "Conta caixa",
  "saldo" : 10.85,
  "numeroAgencia" : "6442",
  "digito" : "2"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Contas alteradas retornadas com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de contas alteradas.

get /integracao/financeiro/conta/obter-movimentados-v1

Lista contas que possuem movimentações. (obterSaldosContasMovimentadosV1)

Retorna lista de contas movimentadas no período especificado.

Query parameters

dataInicial (required)

Query Parameter — Informar data em formato ISO 8601.

dataFinal (required)

Query Parameter — Informar data em formato ISO 8601.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[FinanceiroContaIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "digitoAgencia" : "1",
  "numero" : "1234",
  "dataAtualizacao" : "2000-01-23T04:56:07.000+00:00",
  "nome" : "Conta caixa",
  "saldo" : 10.85,
  "numeroAgencia" : "6442",
  "digito" : "2"
}, {
  "digitoAgencia" : "1",
  "numero" : "1234",
  "dataAtualizacao" : "2000-01-23T04:56:07.000+00:00",
  "nome" : "Conta caixa",
  "saldo" : 10.85,
  "numeroAgencia" : "6442",
  "digito" : "2"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Contas movimentadas retornadas com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de contas movimentadas.

get /integracao/financeiro/conta/obter-todos-v1

Lista todas as contas financeiras. (obterTodosSaldosContasV1)

Consulta contas com filtros opcionais e paginação.

Query parameters

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[FinanceiroContaIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "digitoAgencia" : "1",
  "numero" : "1234",
  "dataAtualizacao" : "2000-01-23T04:56:07.000+00:00",
  "nome" : "Conta caixa",
  "saldo" : 10.85,
  "numeroAgencia" : "6442",
  "digito" : "2"
}, {
  "digitoAgencia" : "1",
  "numero" : "1234",
  "dataAtualizacao" : "2000-01-23T04:56:07.000+00:00",
  "nome" : "Conta caixa",
  "saldo" : 10.85,
  "numeroAgencia" : "6442",
  "digito" : "2"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Contas retornadas com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de contas.

DepartamentoFinanceiro

get /integracao/financeiro/departamento/obter-alterados-v2

Lista departamentos que possuem alteração. (obterDepartamentosAlteradosV2)

Retorna lista de departamentos alterados no período especificado.

Query parameters

dataInicial (required)

Query Parameter — Informar data em formato ISO 8601.

dataFinal (required)

Query Parameter — Informar data em formato ISO 8601.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[DepartamentoIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "ativo" : true,
  "codigo" : 1,
  "nome" : "Geral"
}, {
  "ativo" : true,
  "codigo" : 1,
  "nome" : "Geral"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Departamentos alterados retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de departamentos alterados.

get /integracao/financeiro/departamento/obter-movimentados-v2

Lista departamentos que possuem movimentações. (obterDepartamentosMovimentadosV1)

Retorna lista de departamentos movimentados no período especificado.

Query parameters

dataInicial (required)

Query Parameter — Informar data em formato ISO 8601.

dataFinal (required)

Query Parameter — Informar data em formato ISO 8601.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[DepartamentoIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "ativo" : true,
  "codigo" : 1,
  "nome" : "Geral"
}, {
  "ativo" : true,
  "codigo" : 1,
  "nome" : "Geral"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Departamentos movimentados retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de departamentos movimentados.

get /integracao/financeiro/departamento/obter-todos-v2

Lista todos os departamentos. (obterTodosV2)

Consulta departamentos com filtros opcionais e paginação.

Query parameters

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[DepartamentoIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "ativo" : true,
  "codigo" : 1,
  "nome" : "Geral"
}, {
  "ativo" : true,
  "codigo" : 1,
  "nome" : "Geral"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Departamentos retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de departamentos.

get /integracao/financeiro/departamento/obter-v2

Consulta departamentos com filtros avançados. (obterV2)

Consulta departamentos com filtros avançados.

Query parameters

codigoDepartamento (optional)

Query Parameter — Código do departamento.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[DepartamentoIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "ativo" : true,
  "codigo" : 1,
  "nome" : "Geral"
}, {
  "ativo" : true,
  "codigo" : 1,
  "nome" : "Geral"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Departamentos retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de departamentos.

DescontoEVigncia

get /integracao/produto/desconto/vigencia/obter-alterados-v1

Obtém descontos de produto por vigência alterados (obterProdutoVigenciaAlteradosV1)

Retorna descontos de produto por vigência alterados no período especificado.

Query parameters

dataInicial (required)

Query Parameter — Data inicial em formato ISO 8601.

dataFinal (required)

Query Parameter — Data final em formato ISO 8601.

removerRestricaoEstoque (optional)

Query Parameter — Remove a filtragem de somente produtos com estoque positivo.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[DescontoProdutoVigenciaIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "percentualDesconto" : 12.5,
  "dataFim" : "2025-02-15",
  "valorPromocao" : 79.9,
  "codigoProduto" : 7890123,
  "dataInicio" : "2025-01-10",
  "codigoFilial" : 101,
  "codigoDesconto" : 123456
}, {
  "percentualDesconto" : 12.5,
  "dataFim" : "2025-02-15",
  "valorPromocao" : 79.9,
  "codigoProduto" : 7890123,
  "dataInicio" : "2025-01-10",
  "codigoFilial" : 101,
  "codigoDesconto" : 123456
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Descontos de produto por vigência alterados retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de descontos de produto por vigência alterados.

get /integracao/produto/desconto/vigencia/obter-movimentados-v1

Obtém descontos de produto por vigência movimentados (obterProdutoVigenciaMovimentadosV1)

Retorna descontos de produto por vigência movimentados no período especificado.

Query parameters

dataInicial (required)

Query Parameter — Data inicial em formato ISO 8601.

dataFinal (required)

Query Parameter — Data final em formato ISO 8601.

removerRestricaoEstoque (optional)

Query Parameter — Remove a filtragem de somente produtos com estoque positivo.

dataInicial (required)

Query Parameter — Data inicial em formato ISO 8601. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[DescontoProdutoVigenciaIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "percentualDesconto" : 12.5,
  "dataFim" : "2025-02-15",
  "valorPromocao" : 79.9,
  "codigoProduto" : 7890123,
  "dataInicio" : "2025-01-10",
  "codigoFilial" : 101,
  "codigoDesconto" : 123456
}, {
  "percentualDesconto" : 12.5,
  "dataFim" : "2025-02-15",
  "valorPromocao" : 79.9,
  "codigoProduto" : 7890123,
  "dataInicio" : "2025-01-10",
  "codigoFilial" : 101,
  "codigoDesconto" : 123456
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Descontos de produto por vigência movimentados retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de descontos de produto por vigência movimentados.

get /integracao/produto/desconto/vigencia/obter-todos-v1

Obtém todos os descontos de produto por vigência (obterTodosProdutoVigenciaV1)

Retorna todos os descontos de produto por vigência com paginação.

Query parameters

removerRestricaoEstoque (optional)

Query Parameter — Remove a filtragem de somente produtos com estoque positivo.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[DescontoProdutoVigenciaIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "percentualDesconto" : 12.5,
  "dataFim" : "2025-02-15",
  "valorPromocao" : 79.9,
  "codigoProduto" : 7890123,
  "dataInicio" : "2025-01-10",
  "codigoFilial" : 101,
  "codigoDesconto" : 123456
}, {
  "percentualDesconto" : 12.5,
  "dataFim" : "2025-02-15",
  "valorPromocao" : 79.9,
  "codigoProduto" : 7890123,
  "dataInicio" : "2025-01-10",
  "codigoFilial" : 101,
  "codigoDesconto" : 123456
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Descontos de produto por vigência retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de descontos de produto por vigência.

DescontoEmpresaEGrupoDeProduto

get /integracao/produto/desconto/empresa-grupo-produto/obter-alterados-v1

Obtém descontos por empresa e grupo de produto alterados no período (obterDescontoEmpresaGrupoProdutoAlteradosV1)

Retorna descontos por empresa e grupo de produto que foram alterados no período informado. Caso seja utilizado o token do central, serão retornados os descontos de todas as lojas. Caso seja utilizado o token de uma filial, retorna somente os descontos da filial em questão.

Query parameters

nomeEmpresa (optional)

Query Parameter — Nome (ou parte do nome) da empresa convênio.

codigoEmpresa (optional)

Query Parameter — Código da empresa convênio.

nomeGrupoProduto (optional)

Query Parameter — Nome (ou parte do nome) do grupo de produtos.

codigoGrupoProduto (optional)

Query Parameter — Código do grupo de produtos.

dataInicial (required)

Query Parameter — Data/hora inicial da última alteração a ser considerada, em formato ISO 8601.

dataFinal (required)

Query Parameter — Data/hora final da última alteração a ser considerada, em formato ISO 8601.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[DescontoEmpresaGrupoProdutoIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "codigoEmpresa" : 10,
  "percentualDesconto" : 15.0,
  "codigoGrupoProduto" : 5,
  "nomeEmpresa" : "Empresa Exemplo Ltda",
  "dataFim" : "2000-01-23T04:56:07.000+00:00",
  "percentualDescontoMax" : 20.0,
  "condicoesPagamento" : [ {
    "codigo" : 5,
    "nome" : "À Vista"
  }, {
    "codigo" : 5,
    "nome" : "À Vista"
  } ],
  "dataInicio" : "2000-01-23T04:56:07.000+00:00",
  "codigoFilial" : 1,
  "nomeGrupoProduto" : "Medicamentos"
}, {
  "codigoEmpresa" : 10,
  "percentualDesconto" : 15.0,
  "codigoGrupoProduto" : 5,
  "nomeEmpresa" : "Empresa Exemplo Ltda",
  "dataFim" : "2000-01-23T04:56:07.000+00:00",
  "percentualDescontoMax" : 20.0,
  "condicoesPagamento" : [ {
    "codigo" : 5,
    "nome" : "À Vista"
  }, {
    "codigo" : 5,
    "nome" : "À Vista"
  } ],
  "dataInicio" : "2000-01-23T04:56:07.000+00:00",
  "codigoFilial" : 1,
  "nomeGrupoProduto" : "Medicamentos"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Descontos por empresa e grupo de produto alterados retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta dos descontos por empresa e grupo de produto alterados.

get /integracao/produto/desconto/empresa-grupo-produto/obter-v1

Obtém descontos por empresa e grupo de produto com filtros (obterDescontoEmpresaGrupoProdutoV1)

Retorna descontos cadastrados por empresa e grupo de produto, permitindo filtros por nome da empresa, nome do grupo de produtos, código do grupo de produtos e período de vigência. Caso seja utilizado o token do central, serão retornados os descontos de todas as lojas. Caso seja utilizado o token de uma filial, retorna somente os descontos da filial em questão.

Query parameters

nomeEmpresa (optional)

Query Parameter — Nome (ou parte do nome) da empresa convênio.

codigoEmpresa (optional)

Query Parameter — Código da empresa convênio.

nomeGrupoProduto (optional)

Query Parameter — Nome (ou parte do nome) do grupo de produtos.

codigoGrupoProduto (optional)

Query Parameter — Código do grupo de produtos.

dataReferencia (optional)

Query Parameter — Data de vigência em formato ISO 8601.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[DescontoEmpresaGrupoProdutoIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "codigoEmpresa" : 10,
  "percentualDesconto" : 15.0,
  "codigoGrupoProduto" : 5,
  "nomeEmpresa" : "Empresa Exemplo Ltda",
  "dataFim" : "2000-01-23T04:56:07.000+00:00",
  "percentualDescontoMax" : 20.0,
  "condicoesPagamento" : [ {
    "codigo" : 5,
    "nome" : "À Vista"
  }, {
    "codigo" : 5,
    "nome" : "À Vista"
  } ],
  "dataInicio" : "2000-01-23T04:56:07.000+00:00",
  "codigoFilial" : 1,
  "nomeGrupoProduto" : "Medicamentos"
}, {
  "codigoEmpresa" : 10,
  "percentualDesconto" : 15.0,
  "codigoGrupoProduto" : 5,
  "nomeEmpresa" : "Empresa Exemplo Ltda",
  "dataFim" : "2000-01-23T04:56:07.000+00:00",
  "percentualDescontoMax" : 20.0,
  "condicoesPagamento" : [ {
    "codigo" : 5,
    "nome" : "À Vista"
  }, {
    "codigo" : 5,
    "nome" : "À Vista"
  } ],
  "dataInicio" : "2000-01-23T04:56:07.000+00:00",
  "codigoFilial" : 1,
  "nomeGrupoProduto" : "Medicamentos"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Descontos por empresa e grupo de produto retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta dos descontos por empresa e grupo de produto.

get /integracao/produto/desconto/empresa-grupo-produto/obter-todos-v1

Obtém todos os descontos por empresa e grupo de produto (obterTodosDescontoEmpresaGrupoProdutoV1)

Retorna todos os descontos cadastrados por empresa e grupo de produto. Caso seja utilizado o token do central, serão retornados os descontos de todas as lojas. Caso seja utilizado o token de uma filial, retorna somente os descontos da filial em questão.

Query parameters

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[DescontoEmpresaGrupoProdutoIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "codigoEmpresa" : 10,
  "percentualDesconto" : 15.0,
  "codigoGrupoProduto" : 5,
  "nomeEmpresa" : "Empresa Exemplo Ltda",
  "dataFim" : "2000-01-23T04:56:07.000+00:00",
  "percentualDescontoMax" : 20.0,
  "condicoesPagamento" : [ {
    "codigo" : 5,
    "nome" : "À Vista"
  }, {
    "codigo" : 5,
    "nome" : "À Vista"
  } ],
  "dataInicio" : "2000-01-23T04:56:07.000+00:00",
  "codigoFilial" : 1,
  "nomeGrupoProduto" : "Medicamentos"
}, {
  "codigoEmpresa" : 10,
  "percentualDesconto" : 15.0,
  "codigoGrupoProduto" : 5,
  "nomeEmpresa" : "Empresa Exemplo Ltda",
  "dataFim" : "2000-01-23T04:56:07.000+00:00",
  "percentualDescontoMax" : 20.0,
  "condicoesPagamento" : [ {
    "codigo" : 5,
    "nome" : "À Vista"
  }, {
    "codigo" : 5,
    "nome" : "À Vista"
  } ],
  "dataInicio" : "2000-01-23T04:56:07.000+00:00",
  "codigoFilial" : 1,
  "nomeGrupoProduto" : "Medicamentos"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Descontos por empresa e grupo de produto retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta dos descontos por empresa e grupo de produto.

DescontoParceiroEProduto

get /integracao/produto/desconto/parceiro/obter-alterados-v1

Obtém descontos por parceiro e produto alterados no período (obterDescontoParceiroAlteradosV1)

Retorna descontos/promoções de parceiro e produto que foram alterados no período informado. Caso seja utilizado o token do central, serão retornados os descontos de todas as lojas. Caso seja utilizado o token de uma filial, retorna somente os descontos da filial em questão.

Query parameters

codigoProduto (optional)

Query Parameter — Código do produto para filtro.

codigoBarras (optional)

Query Parameter — Código de barras do produto para filtro.

nomeProduto (optional)

Query Parameter — Nome ou parte do nome do produto para filtro.

removerRestricaoEstoque (optional)

Query Parameter — Remove a filtragem de somente produtos com estoque positivo.

dataInicial (required)

Query Parameter — Data/hora inicial da última alteração em formato ISO 8601.

dataFinal (required)

Query Parameter — Data/hora final da última alteração em formato ISO 8601.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro (offset) para paginação. Inicia em 0. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros por página. format: int32

Return type

array[DescontoParceiroIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "percentualDesconto" : 15.0,
  "diasSemana" : [ "SEGUNDA", "TERÇA", "QUARTA" ],
  "dataFim" : "2000-01-23T04:56:07.000+00:00",
  "nomeParceiro" : "PEC",
  "valorPromocao" : 9.99,
  "valorVenda" : 12.5,
  "codigoParceiro" : 10,
  "codigoProduto" : 100,
  "dataInicio" : "2000-01-23T04:56:07.000+00:00",
  "codigoFilial" : 1,
  "codigoBarras" : 7898455107541,
  "nomeProduto" : "Dipirona 500mg"
}, {
  "percentualDesconto" : 15.0,
  "diasSemana" : [ "SEGUNDA", "TERÇA", "QUARTA" ],
  "dataFim" : "2000-01-23T04:56:07.000+00:00",
  "nomeParceiro" : "PEC",
  "valorPromocao" : 9.99,
  "valorVenda" : 12.5,
  "codigoParceiro" : 10,
  "codigoProduto" : 100,
  "dataInicio" : "2000-01-23T04:56:07.000+00:00",
  "codigoFilial" : 1,
  "codigoBarras" : 7898455107541,
  "nomeProduto" : "Dipirona 500mg"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Descontos por parceiro e produto alterados retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta dos descontos por parceiro e produto alterados.

get /integracao/produto/desconto/parceiro/obter-v1

Obtém descontos por parceiro e produto com filtros (obterDescontoParceiroV1)

Retorna descontos/promoções cadastrados em parceiro e produto, permitindo filtros por produto, código de barras, nome, data de vigência e somente produtos ativos. Caso seja utilizado o token do central, serão retornados os descontos de todas as lojas. Caso seja utilizado o token de uma filial, retorna somente os descontos da filial em questão.

Query parameters

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro (offset) para paginação. Inicia em 0. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros por página. format: int32

dataReferencia (optional)

Query Parameter — Data de vigência em formato ISO 8601. Se não informada, utiliza a data atual.

codigoProduto (optional)

Query Parameter — Código do produto para filtro. format: int32

codigoBarras (optional)

Query Parameter — Código de barras do produto para filtro. format: int64

nomeProduto (optional)

Query Parameter — Nome ou parte do nome do produto para filtro.

somenteAtivos (optional)

Query Parameter — Filtrar somente produtos ativos.

removerRestricaoEstoque (optional)

Query Parameter — Remove a filtragem de somente produtos com estoque positivo.

Return type

array[DescontoParceiroIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "percentualDesconto" : 15.0,
  "diasSemana" : [ "SEGUNDA", "TERÇA", "QUARTA" ],
  "dataFim" : "2000-01-23T04:56:07.000+00:00",
  "nomeParceiro" : "PEC",
  "valorPromocao" : 9.99,
  "valorVenda" : 12.5,
  "codigoParceiro" : 10,
  "codigoProduto" : 100,
  "dataInicio" : "2000-01-23T04:56:07.000+00:00",
  "codigoFilial" : 1,
  "codigoBarras" : 7898455107541,
  "nomeProduto" : "Dipirona 500mg"
}, {
  "percentualDesconto" : 15.0,
  "diasSemana" : [ "SEGUNDA", "TERÇA", "QUARTA" ],
  "dataFim" : "2000-01-23T04:56:07.000+00:00",
  "nomeParceiro" : "PEC",
  "valorPromocao" : 9.99,
  "valorVenda" : 12.5,
  "codigoParceiro" : 10,
  "codigoProduto" : 100,
  "dataInicio" : "2000-01-23T04:56:07.000+00:00",
  "codigoFilial" : 1,
  "codigoBarras" : 7898455107541,
  "nomeProduto" : "Dipirona 500mg"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Descontos por parceiro e produto retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta dos descontos por parceiro e produto.

get /integracao/produto/desconto/parceiro/obter-todos-v1

Obtém todos os descontos por parceiro e produto (obterTodosDescontoParceiroV1)

Retorna todos os descontos/promoções cadastrados em parceiro e produto. Caso seja utilizado o token do central, serão retornados os descontos de todas as lojas. Caso seja utilizado o token de uma filial, retorna somente os descontos da filial em questão.

Query parameters

removerRestricaoEstoque (optional)

Query Parameter — Remove a filtragem de somente produtos com estoque positivo.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro (offset) para paginação. Inicia em 0. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros por página. format: int32

Return type

array[DescontoParceiroIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "percentualDesconto" : 15.0,
  "diasSemana" : [ "SEGUNDA", "TERÇA", "QUARTA" ],
  "dataFim" : "2000-01-23T04:56:07.000+00:00",
  "nomeParceiro" : "PEC",
  "valorPromocao" : 9.99,
  "valorVenda" : 12.5,
  "codigoParceiro" : 10,
  "codigoProduto" : 100,
  "dataInicio" : "2000-01-23T04:56:07.000+00:00",
  "codigoFilial" : 1,
  "codigoBarras" : 7898455107541,
  "nomeProduto" : "Dipirona 500mg"
}, {
  "percentualDesconto" : 15.0,
  "diasSemana" : [ "SEGUNDA", "TERÇA", "QUARTA" ],
  "dataFim" : "2000-01-23T04:56:07.000+00:00",
  "nomeParceiro" : "PEC",
  "valorPromocao" : 9.99,
  "valorVenda" : 12.5,
  "codigoParceiro" : 10,
  "codigoProduto" : 100,
  "dataInicio" : "2000-01-23T04:56:07.000+00:00",
  "codigoFilial" : 1,
  "codigoBarras" : 7898455107541,
  "nomeProduto" : "Dipirona 500mg"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Descontos por parceiro e produto retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta dos descontos por parceiro e produto.

DescontoPorEncarte

get /integracao/produto/desconto/encarte/obter-alterados-v1

Obter descontos de encarte alterados (obterProdutoDescontoEncarteAlteradosV1)

Retorna os produtos com descontos em encartes que sofreram alterações dentro do intervalo de datas informado.

Query parameters

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

dataInicial (required)

Query Parameter — Data inicial em formato ISO 8601.

dataFinal (required)

Query Parameter — Data final em formato ISO 8601.

Return type

array[ProdutoDescontoEncarteIntegracaoRetorno]

Example data

Content-Type: application/json

[ {
  "diasSemana" : "[ DOM, SEG, TER ]",
  "codigoEncarte" : 123,
  "dataFim" : "15/05/2024",
  "nomeCampanha" : "Encarte Dia das Mães",
  "produtosEncarte" : {
    "valorPromocao" : 9.9,
    "quantidadeProduto" : 2,
    "codigoProduto" : 1,
    "nomeProduto" : "DORFLEX 36 CPR"
  },
  "dataInicio" : "01/05/2024"
}, {
  "diasSemana" : "[ DOM, SEG, TER ]",
  "codigoEncarte" : 123,
  "dataFim" : "15/05/2024",
  "nomeCampanha" : "Encarte Dia das Mães",
  "produtosEncarte" : {
    "valorPromocao" : 9.9,
    "quantidadeProduto" : 2,
    "codigoProduto" : 1,
    "nomeProduto" : "DORFLEX 36 CPR"
  },
  "dataInicio" : "01/05/2024"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Lista de descontos de encarte alterados retornada com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de descontos por grupo e condição de pagamento.

get /integracao/produto/desconto/encarte/obter-v1

Obter descontos de encarte (obterProdutoDescontoEncarteV1)

Retorna uma lista de produtos com descontos ativos em encartes, filtrando por parâmetros opcionais de consulta.

Query parameters

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

dataReferencia (optional)

Query Parameter — Data de referência para considerar os descontos (formato: ISO 8601). Se não informada, utiliza a data atual.

codigoProduto (optional)

Query Parameter — Código interno do produto format: int32

codigoBarras (optional)

Query Parameter — Código de barras do produto format: int64

nomeProduto (optional)

Query Parameter — Nome (ou parte do nome) do produto para filtro.

nomeEncarte (optional)

Query Parameter — Nome (ou parte do nome) do encarte para filtro.

Return type

array[ProdutoDescontoEncarteIntegracaoRetorno]

Example data

Content-Type: application/json

[ {
  "diasSemana" : "[ DOM, SEG, TER ]",
  "codigoEncarte" : 123,
  "dataFim" : "15/05/2024",
  "nomeCampanha" : "Encarte Dia das Mães",
  "produtosEncarte" : {
    "valorPromocao" : 9.9,
    "quantidadeProduto" : 2,
    "codigoProduto" : 1,
    "nomeProduto" : "DORFLEX 36 CPR"
  },
  "dataInicio" : "01/05/2024"
}, {
  "diasSemana" : "[ DOM, SEG, TER ]",
  "codigoEncarte" : 123,
  "dataFim" : "15/05/2024",
  "nomeCampanha" : "Encarte Dia das Mães",
  "produtosEncarte" : {
    "valorPromocao" : 9.9,
    "quantidadeProduto" : 2,
    "codigoProduto" : 1,
    "nomeProduto" : "DORFLEX 36 CPR"
  },
  "dataInicio" : "01/05/2024"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Lista de descontos de encarte retornada com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de descontos por grupo e condição de pagamento.

get /integracao/produto/desconto/encarte/obter-todos-v1

Obter todos os descontos de encarte (obterTodosProdutoDescontoEncarteV1)

Retorna todos os produtos com descontos em encartes ativos.

Query parameters

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[ProdutoDescontoEncarteIntegracaoRetorno]

Example data

Content-Type: application/json

[ {
  "diasSemana" : "[ DOM, SEG, TER ]",
  "codigoEncarte" : 123,
  "dataFim" : "15/05/2024",
  "nomeCampanha" : "Encarte Dia das Mães",
  "produtosEncarte" : {
    "valorPromocao" : 9.9,
    "quantidadeProduto" : 2,
    "codigoProduto" : 1,
    "nomeProduto" : "DORFLEX 36 CPR"
  },
  "dataInicio" : "01/05/2024"
}, {
  "diasSemana" : "[ DOM, SEG, TER ]",
  "codigoEncarte" : 123,
  "dataFim" : "15/05/2024",
  "nomeCampanha" : "Encarte Dia das Mães",
  "produtosEncarte" : {
    "valorPromocao" : 9.9,
    "quantidadeProduto" : 2,
    "codigoProduto" : 1,
    "nomeProduto" : "DORFLEX 36 CPR"
  },
  "dataInicio" : "01/05/2024"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Lista completa de descontos de encarte retornada com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de descontos por grupo e condição de pagamento.

DescontoPorGrupoECondioDePagamento

get /integracao/produto/desconto/grupo/obter-alterados-v1

Obtém descontos por grupo e condição de pagamento alterados (obterProdutoDescontoGrupoAlteradosV1)

Obtém os descontos por grupo e condição de pagamento que foram alterados entre as datas informadas.

Query parameters

grupoProduto (optional)

Query Parameter — Filtro pelo código do grupo de produto.

dataInicial (required)

Query Parameter — Data inicial em formato ISO 8601.

dataFinal (required)

Query Parameter — Data final em formato ISO 8601.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[ProdutoDescontoGrupoIntegracaoRetornoDto]

Example data

Content-Type: application/json

[ {
  "percentualDesconto" : 5.0,
  "diasSemana" : [ "SEGUNDA", "TERÇA", "QUARTA" ],
  "dataFim" : "2024-12-31",
  "percentualDescontoMax" : 15.0,
  "nomeCampanha" : "DESCONTO PADRAO",
  "condicaoPagamento" : {
    "codigo" : 5,
    "nome" : "À Vista"
  },
  "dataInicio" : "2024-01-01",
  "grupoProduto" : 10,
  "codigoFilial" : 1
}, {
  "percentualDesconto" : 5.0,
  "diasSemana" : [ "SEGUNDA", "TERÇA", "QUARTA" ],
  "dataFim" : "2024-12-31",
  "percentualDescontoMax" : 15.0,
  "nomeCampanha" : "DESCONTO PADRAO",
  "condicaoPagamento" : {
    "codigo" : 5,
    "nome" : "À Vista"
  },
  "dataInicio" : "2024-01-01",
  "grupoProduto" : 10,
  "codigoFilial" : 1
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Descontos por grupo e condição de pagamento alterados retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de descontos por grupo e condição de pagamento alterados.

get /integracao/produto/desconto/grupo/obter-v1

Obtém descontos por grupo e condição de pagamento (obterProdutoDescontoGrupoV1)

Obtém os descontos por grupo e condição de pagamento cadastrados no sistema.

Query parameters

grupoProduto (optional)

Query Parameter — Filtro pelo código do grupo de produto.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[ProdutoDescontoGrupoIntegracaoRetornoDto]

Example data

Content-Type: application/json

[ {
  "percentualDesconto" : 5.0,
  "diasSemana" : [ "SEGUNDA", "TERÇA", "QUARTA" ],
  "dataFim" : "2024-12-31",
  "percentualDescontoMax" : 15.0,
  "nomeCampanha" : "DESCONTO PADRAO",
  "condicaoPagamento" : {
    "codigo" : 5,
    "nome" : "À Vista"
  },
  "dataInicio" : "2024-01-01",
  "grupoProduto" : 10,
  "codigoFilial" : 1
}, {
  "percentualDesconto" : 5.0,
  "diasSemana" : [ "SEGUNDA", "TERÇA", "QUARTA" ],
  "dataFim" : "2024-12-31",
  "percentualDescontoMax" : 15.0,
  "nomeCampanha" : "DESCONTO PADRAO",
  "condicaoPagamento" : {
    "codigo" : 5,
    "nome" : "À Vista"
  },
  "dataInicio" : "2024-01-01",
  "grupoProduto" : 10,
  "codigoFilial" : 1
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Descontos por grupo e condição de pagamento retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de descontos por grupo e condição de pagamento.

get /integracao/produto/desconto/grupo/obter-todos-v1

Obtém todos os descontos por grupo e condição de pagamento (obterTodosProdutoDescontoGrupoV1)

Obtém todos os descontos por grupo e condição de pagamento cadastrados no sistema.

Query parameters

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[ProdutoDescontoGrupoIntegracaoRetornoDto]

Example data

Content-Type: application/json

[ {
  "percentualDesconto" : 5.0,
  "diasSemana" : [ "SEGUNDA", "TERÇA", "QUARTA" ],
  "dataFim" : "2024-12-31",
  "percentualDescontoMax" : 15.0,
  "nomeCampanha" : "DESCONTO PADRAO",
  "condicaoPagamento" : {
    "codigo" : 5,
    "nome" : "À Vista"
  },
  "dataInicio" : "2024-01-01",
  "grupoProduto" : 10,
  "codigoFilial" : 1
}, {
  "percentualDesconto" : 5.0,
  "diasSemana" : [ "SEGUNDA", "TERÇA", "QUARTA" ],
  "dataFim" : "2024-12-31",
  "percentualDescontoMax" : 15.0,
  "nomeCampanha" : "DESCONTO PADRAO",
  "condicaoPagamento" : {
    "codigo" : 5,
    "nome" : "À Vista"
  },
  "dataInicio" : "2024-01-01",
  "grupoProduto" : 10,
  "codigoFilial" : 1
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Descontos por grupo e condição de pagamento retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de descontos por grupo e condição de pagamento.

DescontoPorProdutoECondioDePagamento

get /integracao/produto/desconto/condicao-pagamento/obter-alterados-v1

Obter descontos por produto e condição de pagamento alterados no período (obterAlteradosV1)

Consulta descontos alterados por produto e condição de pagamento em um período específico, com paginação e filtros opcionais.

Query parameters

codigoProduto (optional)

Query Parameter — Código interno do produto para filtro exato.

codigoBarras (optional)

Query Parameter — Código de barras do produto para filtro exato.

nomeProduto (optional)

Query Parameter — Nome ou parte do nome do produto para filtro.

codigoCondicaoPagamento (optional)

Query Parameter — Código da condição de pagamento para filtro.

somenteAtivos (optional)

Query Parameter — Filtrar somente produtos ativos.

removerRestricaoEstoque (optional)

Query Parameter — Remove a filtragem de somente produtos com estoque positivo.

dataInicial (required)

Query Parameter — Data inicial para filtro de alteração dos descontos (formato: yyyy-MM-dd).

dataFinal (required)

Query Parameter — Data final para filtro de alteração dos descontos (formato: yyyy-MM-dd).

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro (offset) para paginação. Inicia em 0. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros por página. format: int32

Return type

array[ProdutoDescontoCondicaoPagamentoIntegracaoRetornoDto]

Example data

Content-Type: application/json

[ {
  "percentualDesconto" : 6.027456183070403,
  "diasSemana" : [ "diasSemana", "diasSemana" ],
  "produto" : {
    "codigoProduto" : 5,
    "codigoBarras" : "codigoBarras",
    "nomeProduto" : "nomeProduto"
  },
  "dataFim" : "dataFim",
  "percentualDescontoMax" : 1.4658129805029452,
  "valorPromocao" : 5.637376656633329,
  "condicoesPagamento" : [ {
    "codigo" : 5,
    "nome" : "À Vista"
  }, {
    "codigo" : 5,
    "nome" : "À Vista"
  } ],
  "nomeCampanha" : "nomeCampanha",
  "valorVenda" : 2.3021358869347655,
  "dataInicio" : "dataInicio",
  "codigoFilial" : 0
}, {
  "percentualDesconto" : 6.027456183070403,
  "diasSemana" : [ "diasSemana", "diasSemana" ],
  "produto" : {
    "codigoProduto" : 5,
    "codigoBarras" : "codigoBarras",
    "nomeProduto" : "nomeProduto"
  },
  "dataFim" : "dataFim",
  "percentualDescontoMax" : 1.4658129805029452,
  "valorPromocao" : 5.637376656633329,
  "condicoesPagamento" : [ {
    "codigo" : 5,
    "nome" : "À Vista"
  }, {
    "codigo" : 5,
    "nome" : "À Vista"
  } ],
  "nomeCampanha" : "nomeCampanha",
  "valorVenda" : 2.3021358869347655,
  "dataInicio" : "dataInicio",
  "codigoFilial" : 0
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Consulta realizada com sucesso.

400

Requisição inválida ou parâmetros de data inválidos.

401

Não autorizado.

500

Erro na consulta de descontos por produto e condição de pagamento.

get /integracao/produto/desconto/condicao-pagamento/obter-todos-v1

Obter todos os descontos por produto e condição de pagamento (obterTodosV11)

Consulta todos os descontos vigentes por produto e condição de pagamento, com paginação.

Query parameters

removerRestricaoEstoque (optional)

Query Parameter — Remove a filtragem de somente produtos com estoque positivo.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro (offset) para paginação. Inicia em 0. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros por página. format: int32

Return type

array[ProdutoDescontoCondicaoPagamentoIntegracaoRetornoDto]

Example data

Content-Type: application/json

[ {
  "percentualDesconto" : 6.027456183070403,
  "diasSemana" : [ "diasSemana", "diasSemana" ],
  "produto" : {
    "codigoProduto" : 5,
    "codigoBarras" : "codigoBarras",
    "nomeProduto" : "nomeProduto"
  },
  "dataFim" : "dataFim",
  "percentualDescontoMax" : 1.4658129805029452,
  "valorPromocao" : 5.637376656633329,
  "condicoesPagamento" : [ {
    "codigo" : 5,
    "nome" : "À Vista"
  }, {
    "codigo" : 5,
    "nome" : "À Vista"
  } ],
  "nomeCampanha" : "nomeCampanha",
  "valorVenda" : 2.3021358869347655,
  "dataInicio" : "dataInicio",
  "codigoFilial" : 0
}, {
  "percentualDesconto" : 6.027456183070403,
  "diasSemana" : [ "diasSemana", "diasSemana" ],
  "produto" : {
    "codigoProduto" : 5,
    "codigoBarras" : "codigoBarras",
    "nomeProduto" : "nomeProduto"
  },
  "dataFim" : "dataFim",
  "percentualDescontoMax" : 1.4658129805029452,
  "valorPromocao" : 5.637376656633329,
  "condicoesPagamento" : [ {
    "codigo" : 5,
    "nome" : "À Vista"
  }, {
    "codigo" : 5,
    "nome" : "À Vista"
  } ],
  "nomeCampanha" : "nomeCampanha",
  "valorVenda" : 2.3021358869347655,
  "dataInicio" : "dataInicio",
  "codigoFilial" : 0
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Consulta realizada com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de descontos por produto e condição de pagamento.

get /integracao/produto/desconto/condicao-pagamento/obter-v1

Obter descontos por produto e condição de pagamento (obterV11)

Consulta descontos vigentes por produto e condição de pagamento, com paginação e filtros opcionais.

Query parameters

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro (offset) para paginação. Inicia em 0. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros por página. format: int32

dataReferencia (optional)

Query Parameter — Data de referência para verificar a vigência dos descontos. Se não informada, utiliza a data atual.

codigoProduto (optional)

Query Parameter — Código interno do produto para filtro exato. format: int32

codigoBarras (optional)

Query Parameter — Código de barras do produto para filtro exato. format: int64

nomeProduto (optional)

Query Parameter — Nome ou parte do nome do produto para filtro.

codigoCondicaoPagamento (optional)

Query Parameter — Código da condição de pagamento para filtro. format: int32

somenteAtivos (optional)

Query Parameter — Filtrar somente produtos ativos.

removerRestricaoEstoque (optional)

Query Parameter — Remove a filtragem de somente produtos com estoque positivo.

Return type

array[ProdutoDescontoCondicaoPagamentoIntegracaoRetornoDto]

Example data

Content-Type: application/json

[ {
  "percentualDesconto" : 6.027456183070403,
  "diasSemana" : [ "diasSemana", "diasSemana" ],
  "produto" : {
    "codigoProduto" : 5,
    "codigoBarras" : "codigoBarras",
    "nomeProduto" : "nomeProduto"
  },
  "dataFim" : "dataFim",
  "percentualDescontoMax" : 1.4658129805029452,
  "valorPromocao" : 5.637376656633329,
  "condicoesPagamento" : [ {
    "codigo" : 5,
    "nome" : "À Vista"
  }, {
    "codigo" : 5,
    "nome" : "À Vista"
  } ],
  "nomeCampanha" : "nomeCampanha",
  "valorVenda" : 2.3021358869347655,
  "dataInicio" : "dataInicio",
  "codigoFilial" : 0
}, {
  "percentualDesconto" : 6.027456183070403,
  "diasSemana" : [ "diasSemana", "diasSemana" ],
  "produto" : {
    "codigoProduto" : 5,
    "codigoBarras" : "codigoBarras",
    "nomeProduto" : "nomeProduto"
  },
  "dataFim" : "dataFim",
  "percentualDescontoMax" : 1.4658129805029452,
  "valorPromocao" : 5.637376656633329,
  "condicoesPagamento" : [ {
    "codigo" : 5,
    "nome" : "À Vista"
  }, {
    "codigo" : 5,
    "nome" : "À Vista"
  } ],
  "nomeCampanha" : "nomeCampanha",
  "valorVenda" : 2.3021358869347655,
  "dataInicio" : "dataInicio",
  "codigoFilial" : 0
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Consulta realizada com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de descontos por produto e condição de pagamento.

Estoque

get /integracao/estoque/obter-alterados-v1

Lista estoques de produtos que possuem alteração. (obterEstoqueAlteradosV1)

Retorna lista de estoques de produtos alterados no período especificado.

Query parameters

integracaoEcommerce (optional)

Query Parameter — Filtra produtos disponíveis ou não disponíveis para integração com E-Commerce.

dataInicial (required)

Query Parameter — Informar data em formato ISO 8601.

dataFinal (required)

Query Parameter — Informar data em formato ISO 8601.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[EstoqueIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "dataUltimaEntrada" : "2000-01-23T04:56:07.000+00:00",
  "codigoProduto" : 12345,
  "alterCurva" : "2000-01-23T04:56:07.000+00:00",
  "quantidadeEstoque" : 2,
  "valorCustoMedio" : 36.32,
  "valorUltimaEntrada" : 35.43
}, {
  "dataUltimaEntrada" : "2000-01-23T04:56:07.000+00:00",
  "codigoProduto" : 12345,
  "alterCurva" : "2000-01-23T04:56:07.000+00:00",
  "quantidadeEstoque" : 2,
  "valorCustoMedio" : 36.32,
  "valorUltimaEntrada" : 35.43
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Estoques alterados retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de estoques alterados.

get /integracao/estoque/obter-movimentados-v1

Lista estoques de produtos que possuem movimentações. (obterEstoqueMovimentadoV1)

Retorna lista de estoques de produtos movimentados no período especificado.

Query parameters

integracaoEcommerce (optional)

Query Parameter — Filtra produtos disponíveis ou não disponíveis para integração com E-Commerce.

dataInicial (required)

Query Parameter — Informar data em formato ISO 8601.

dataFinal (required)

Query Parameter — Informar data em formato ISO 8601.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[EstoqueIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "dataUltimaEntrada" : "2000-01-23T04:56:07.000+00:00",
  "codigoProduto" : 12345,
  "alterCurva" : "2000-01-23T04:56:07.000+00:00",
  "quantidadeEstoque" : 2,
  "valorCustoMedio" : 36.32,
  "valorUltimaEntrada" : 35.43
}, {
  "dataUltimaEntrada" : "2000-01-23T04:56:07.000+00:00",
  "codigoProduto" : 12345,
  "alterCurva" : "2000-01-23T04:56:07.000+00:00",
  "quantidadeEstoque" : 2,
  "valorCustoMedio" : 36.32,
  "valorUltimaEntrada" : 35.43
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Estoques movimentados retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de estoques movimentados.

get /integracao/estoque/obter-todos-v1

Lista todos os estoques de produtos. (obterTodosV1)

Retorna o estoque de produtos com filtros opcionais e paginação.

Query parameters

integracaoEcommerce (optional)

Query Parameter — Filtra produtos disponíveis ou não disponíveis para integração com E-Commerce.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[EstoqueIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "dataUltimaEntrada" : "2000-01-23T04:56:07.000+00:00",
  "codigoProduto" : 12345,
  "alterCurva" : "2000-01-23T04:56:07.000+00:00",
  "quantidadeEstoque" : 2,
  "valorCustoMedio" : 36.32,
  "valorUltimaEntrada" : 35.43
}, {
  "dataUltimaEntrada" : "2000-01-23T04:56:07.000+00:00",
  "codigoProduto" : 12345,
  "alterCurva" : "2000-01-23T04:56:07.000+00:00",
  "quantidadeEstoque" : 2,
  "valorCustoMedio" : 36.32,
  "valorUltimaEntrada" : 35.43
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Estoques retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de estoques.

get /integracao/estoque/obter-v1

Consulta estoques de produtos com filtros avançados. (obterV1)

Consulta o estoque de produtos com filtros avançados.

Query parameters

codigoProduto (optional)

Query Parameter — Código reduzido do produto. format: int64

quantidadeEstoqueInicial (optional)

Query Parameter — Exibe os produtos com estoque maior ou igual ao valor informado. format: int64

quantidadeEstoqueFinal (optional)

Query Parameter — Filtra produtos com estoque negativo. Pode ser combinado com quantidadeEstoqueInicial para definir uma faixa. format: int64

ativo (optional)

Query Parameter — Filtra por estoque de produtos ativos ou inativos.

integracaoEcommerce (optional)

Query Parameter — Filtra produtos disponíveis ou não disponíveis para integração com E-Commerce.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[EstoqueIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "dataUltimaEntrada" : "2000-01-23T04:56:07.000+00:00",
  "codigoProduto" : 12345,
  "alterCurva" : "2000-01-23T04:56:07.000+00:00",
  "quantidadeEstoque" : 2,
  "valorCustoMedio" : 36.32,
  "valorUltimaEntrada" : 35.43
}, {
  "dataUltimaEntrada" : "2000-01-23T04:56:07.000+00:00",
  "codigoProduto" : 12345,
  "alterCurva" : "2000-01-23T04:56:07.000+00:00",
  "quantidadeEstoque" : 2,
  "valorCustoMedio" : 36.32,
  "valorUltimaEntrada" : 35.43
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Estoques retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de estoques.

Financeiro

get /integracao/financeiro/obter-classificacao-financeira-v1

Lista centros de custos (obterClassificacaoFinanceiraV1)

Retorna lista de classificações financeiras no período especificado.

Query parameters

dataInicial (required)

Query Parameter — Informar data em formato ISO 8601.

dataFinal (required)

Query Parameter — Informar data em formato ISO 8601.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[FinanceiroClassificacaoFinanceiraIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "ativo" : true,
  "tipoClassificacao" : "D",
  "centroCusto" : "12",
  "fixoVariavel" : "V",
  "nomeDescricao" : "Despesas variaveis (Credito/Ativo)",
  "creditoDebito" : "C"
}, {
  "ativo" : true,
  "tipoClassificacao" : "D",
  "centroCusto" : "12",
  "fixoVariavel" : "V",
  "nomeDescricao" : "Despesas variaveis (Credito/Ativo)",
  "creditoDebito" : "C"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Classificações financeiras retornadas com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta das classificações financeiras.

get /integracao/financeiro/obter-resultado-exercicio-v1

Lista resultados do exercício (obterResultadoExercicioV1)

Retorna lista de resultado do exercício no período especificado.

Query parameters

dataInicial (required)

Query Parameter — Informar data em formato ISO 8601.

dataFinal (required)

Query Parameter — Informar data em formato ISO 8601.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[FinanceiroResultadoExercicioIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "codigoDepartamento" : 1,
  "data" : "2012-12-30T00:00:00.000+00:00",
  "centroCusto" : "2",
  "valorBruto" : 8725.21
}, {
  "codigoDepartamento" : 1,
  "data" : "2012-12-30T00:00:00.000+00:00",
  "centroCusto" : "2",
  "valorBruto" : 8725.21
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Resultado do exercício retornado com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta do resultado do exercício.

get /integracao/financeiro/obter-resultado-financeiro-v1

Lista resultados financeiros (obterResultadoFinanceiroV1)

Retorna lista de resultado financeiro no período especificado.

Query parameters

dataInicial (required)

Query Parameter — Informar data em formato ISO 8601.

dataFinal (required)

Query Parameter — Informar data em formato ISO 8601.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[FinanceiroResultadoFinanceiroIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "codigoDepartamento" : 1,
  "data" : "2012-12-30T00:00:00.000+00:00",
  "centroCusto" : "2",
  "valorBruto" : 62.6,
  "baixadoAberto" : "A"
}, {
  "codigoDepartamento" : 1,
  "data" : "2012-12-30T00:00:00.000+00:00",
  "centroCusto" : "2",
  "valorBruto" : 62.6,
  "baixadoAberto" : "A"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Resultado financeiro retornado com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta do resultado financeiro.

Fornecedor

get /integracao/fornecedor/obter-alterados-v1

Lista fornecedores alterados (obterFornecedoresAlteradosV1)

Obtém os fornecedores que foram alterados dentro de um intervalo de datas.

Query parameters

dataInicial (required)

Query Parameter — Informar data em formato ISO 8601.

dataFinal (required)

Query Parameter — Informar data em formato ISO 8601.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

FornecedorIntegracaoDto

Example data

Content-Type: application/json

{
  "ativo" : true,
  "codigo" : 1,
  "nomeFantasia" : "SANTA CRUZ DIST.DE MEDICAMNETOS LTDA.",
  "nomeCidade" : "FLORIANOPOLIS",
  "razaoSocial" : "SANTA CRUZ DIST.DE MEDICAMNETOS LTDA.",
  "email" : "teste@teste.com.br",
  "numeroCnpj" : "61.940.292/0058-72"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Fornecedores alterados retornados com sucesso. FornecedorIntegracaoDto

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de fornecedores alterados.

get /integracao/fornecedor/obter-movimentados-v1

Lista fornecedores movimentados (obterFornecedoresMovimentadosV1)

Obtém os fornecedores que foram movimentados dentro de um intervalo de datas.

Query parameters

dataInicial (required)

Query Parameter — Informar data em formato ISO 8601.

dataFinal (required)

Query Parameter — Informar data em formato ISO 8601.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

FornecedorIntegracaoDto

Example data

Content-Type: application/json

{
  "ativo" : true,
  "codigo" : 1,
  "nomeFantasia" : "SANTA CRUZ DIST.DE MEDICAMNETOS LTDA.",
  "nomeCidade" : "FLORIANOPOLIS",
  "razaoSocial" : "SANTA CRUZ DIST.DE MEDICAMNETOS LTDA.",
  "email" : "teste@teste.com.br",
  "numeroCnpj" : "61.940.292/0058-72"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Fornecedores movimentados retornados com sucesso. FornecedorIntegracaoDto

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de fornecedores movimentados.

get /integracao/fornecedor/obter-todos-v1

Lista todos os fornecedores (obterTodosFornecedoresV1)

Obtém todos os fornecedores cadastrados no sistema.

Query parameters

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

FornecedorIntegracaoDto

Example data

Content-Type: application/json

{
  "ativo" : true,
  "codigo" : 1,
  "nomeFantasia" : "SANTA CRUZ DIST.DE MEDICAMNETOS LTDA.",
  "nomeCidade" : "FLORIANOPOLIS",
  "razaoSocial" : "SANTA CRUZ DIST.DE MEDICAMNETOS LTDA.",
  "email" : "teste@teste.com.br",
  "numeroCnpj" : "61.940.292/0058-72"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Fornecedores retornados com sucesso. FornecedorIntegracaoDto

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de fornecedores.

GrupoDeProdutos

get /integracao/produto/grupo/obter-alterados-v1

Obtém grupos de produtos alterados (obterAlteradosV11)

Retorna grupos de produtos alterados no período especificado.

Query parameters

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

dataInicial (required)

Query Parameter — Data inicial em formato ISO 8601.

dataFinal (required)

Query Parameter — Data final em formato ISO 8601.

Return type

array[GrupoProdutoIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "ativo" : true,
  "codigo" : 10,
  "nome" : "Perfumaria"
}, {
  "ativo" : true,
  "codigo" : 10,
  "nome" : "Perfumaria"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Grupos de produtos alterados retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de grupos de produtos alterados.

get /integracao/produto/grupo/obter-movimentados-v1

Obtém grupos de produtos movimentados (obterMovimentadosV1)

Retorna grupos de produtos movimentados no período especificado.

Query parameters

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

dataInicial (required)

Query Parameter — Data inicial em formato ISO 8601.

dataFinal (required)

Query Parameter — Data final em formato ISO 8601.

Return type

array[GrupoProdutoIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "ativo" : true,
  "codigo" : 10,
  "nome" : "Perfumaria"
}, {
  "ativo" : true,
  "codigo" : 10,
  "nome" : "Perfumaria"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Grupos de produtos movimentados retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de grupos de produtos movimentados.

get /integracao/produto/grupo/obter-todos-v1

Obtém todos os grupos de produtos (obterTodosV12)

Retorna grupos de produtos com paginação.

Query parameters

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[GrupoProdutoIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "ativo" : true,
  "codigo" : 10,
  "nome" : "Perfumaria"
}, {
  "ativo" : true,
  "codigo" : 10,
  "nome" : "Perfumaria"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Grupos de produtos retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de grupos de produtos.

Laboratrio

get /integracao/laboratorio/obter-alterados-v1

Obtém laboratórios alterados (obterLaboratoriosAlteradosV1)

Obtém os laboratórios que foram alterados dentro de um intervalo de datas.

Query parameters

dataInicial (required)

Query Parameter — Data inicial em formato ISO 8601.

dataFinal (required)

Query Parameter — Data final em formato ISO 8601.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[LaboratorioIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "ativo" : true,
  "codigo" : 1,
  "nome" : "LABORATORIO TESTE",
  "cnpj" : "99.999.999/0001-99"
}, {
  "ativo" : true,
  "codigo" : 1,
  "nome" : "LABORATORIO TESTE",
  "cnpj" : "99.999.999/0001-99"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Laboratórios alterados retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta dos laboratórios alterados.

get /integracao/laboratorio/obter-movimentados-v1

Obtém laboratórios movimentados (obterLaboratoriosMovimentadosV1)

Obtém os laboratórios que foram movimentados dentro de um intervalo de datas.

Query parameters

dataInicial (required)

Query Parameter — Data inicial em formato ISO 8601.

dataFinal (required)

Query Parameter — Data final em formato ISO 8601.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[LaboratorioIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "ativo" : true,
  "codigo" : 1,
  "nome" : "LABORATORIO TESTE",
  "cnpj" : "99.999.999/0001-99"
}, {
  "ativo" : true,
  "codigo" : 1,
  "nome" : "LABORATORIO TESTE",
  "cnpj" : "99.999.999/0001-99"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Laboratórios movimentados retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta dos laboratórios movimentados.

get /integracao/laboratorio/obter-todos-v1

Obtém todos os laboratórios (obterTodosLaboratoriosV1)

Obtém todos os laboratórios cadastrados no sistema.

Query parameters

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[LaboratorioIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "ativo" : true,
  "codigo" : 1,
  "nome" : "LABORATORIO TESTE",
  "cnpj" : "99.999.999/0001-99"
}, {
  "ativo" : true,
  "codigo" : 1,
  "nome" : "LABORATORIO TESTE",
  "cnpj" : "99.999.999/0001-99"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Laboratórios retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta dos laboratórios.

MelhorDesconto

get /integracao/produto/desconto/progressivo/obter-alterados-v1

Obtém descontos progressivos alterados (obterDescontoProgressivoAlteradosV1)

Obtém os descontos progressivos cadastrados no sistema que foram alterados dentro do intervalo de datas fornecido.

Query parameters

removerRestricaoEstoque (optional)

Query Parameter — Remove a filtragem de somente produtos com estoque positivo.

dataInicial (required)

Query Parameter — Data inicial em formato ISO 8601.

dataFinal (required)

Query Parameter — Data final em formato ISO 8601.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[DescontoProgressivoIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "dataFim" : "2000-01-23T04:56:07.000+00:00",
  "valorPromocao" : 80.0,
  "condicaoPagamento" : 0,
  "nomeLaboratorio" : "REFERENCIA OTC",
  "percentualDesconto" : 20.0,
  "valorVenda" : 100.0,
  "codigoProduto" : 1,
  "quantidadeItens" : 5,
  "quantidadeEstoque" : 2,
  "dataInicio" : "2000-01-23T04:56:07.000+00:00",
  "codigoBarras" : 7897316804858,
  "nomeProduto" : "REFRESH GEL 0,3% OFT 10G",
  "origemDesconto" : "origemDesconto",
  "codigoLaboratorio" : 14
}, {
  "dataFim" : "2000-01-23T04:56:07.000+00:00",
  "valorPromocao" : 80.0,
  "condicaoPagamento" : 0,
  "nomeLaboratorio" : "REFERENCIA OTC",
  "percentualDesconto" : 20.0,
  "valorVenda" : 100.0,
  "codigoProduto" : 1,
  "quantidadeItens" : 5,
  "quantidadeEstoque" : 2,
  "dataInicio" : "2000-01-23T04:56:07.000+00:00",
  "codigoBarras" : 7897316804858,
  "nomeProduto" : "REFRESH GEL 0,3% OFT 10G",
  "origemDesconto" : "origemDesconto",
  "codigoLaboratorio" : 14
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Descontos progressivos alterados retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta dos descontos progressivos alterados.

get /integracao/produto/desconto/progressivo/obter-alterados-v2

Obtém os descontos progressivos alterados (obterDescontoProgressivoAlteradosV2)

Obtém os descontos progressivos que tiveram alterações no período informado, retornando apenas os registros modificados.

Query parameters

removerRestricaoEstoque (optional)

Query Parameter — Remove a filtragem de somente produtos com estoque positivo.

dataInicial (required)

Query Parameter — Data/hora inicial da última alteração a ser considerada, em formato ISO 8601.

dataFinal (required)

Query Parameter — Data/hora final da última alteração a ser considerada, em formato ISO 8601.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[DescontoProgressivoRetornoIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "dataFim" : "2000-01-23T04:56:07.000+00:00",
  "valorPromocao" : 7.061401241503109,
  "condicoesPagamento" : "DINHEIRO, CARTÃO",
  "nomeLaboratorio" : "nomeLaboratorio",
  "percentualDesconto" : 5.962133916683182,
  "valorVenda" : 9.301444243932576,
  "codigoProduto" : 1,
  "quantidadeItens" : 2,
  "quantidadeEstoque" : 5,
  "dataInicio" : "2000-01-23T04:56:07.000+00:00",
  "codigoBarras" : 0,
  "nomeProduto" : "nomeProduto",
  "origemDesconto" : "PRODUTO",
  "codigoLaboratorio" : 6
}, {
  "dataFim" : "2000-01-23T04:56:07.000+00:00",
  "valorPromocao" : 7.061401241503109,
  "condicoesPagamento" : "DINHEIRO, CARTÃO",
  "nomeLaboratorio" : "nomeLaboratorio",
  "percentualDesconto" : 5.962133916683182,
  "valorVenda" : 9.301444243932576,
  "codigoProduto" : 1,
  "quantidadeItens" : 2,
  "quantidadeEstoque" : 5,
  "dataInicio" : "2000-01-23T04:56:07.000+00:00",
  "codigoBarras" : 0,
  "nomeProduto" : "nomeProduto",
  "origemDesconto" : "PRODUTO",
  "codigoLaboratorio" : 6
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Descontos progressivos alterados retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta dos descontos progressivos alterados.

get /integracao/produto/desconto/progressivo/obter-v1

Obtém descontos progressivos (obterDescontoProgressivoV1)

Obtém os descontos progressivos cadastrados no sistema com base nos parâmetros fornecidos.

Query parameters

codigoBarras (optional)

Query Parameter — Código de barras do produto.

codigoProduto (optional)

Query Parameter — Código do produto.

considerarTodasCondicoesPagamento (optional)

Query Parameter — Indica se todas as condições de pagamento devem ser consideradas.

removerRestricaoEstoque (optional)

Query Parameter — Remove a filtragem de somente produtos com estoque positivo.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[DescontoProgressivoIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "dataFim" : "2000-01-23T04:56:07.000+00:00",
  "valorPromocao" : 80.0,
  "condicaoPagamento" : 0,
  "nomeLaboratorio" : "REFERENCIA OTC",
  "percentualDesconto" : 20.0,
  "valorVenda" : 100.0,
  "codigoProduto" : 1,
  "quantidadeItens" : 5,
  "quantidadeEstoque" : 2,
  "dataInicio" : "2000-01-23T04:56:07.000+00:00",
  "codigoBarras" : 7897316804858,
  "nomeProduto" : "REFRESH GEL 0,3% OFT 10G",
  "origemDesconto" : "origemDesconto",
  "codigoLaboratorio" : 14
}, {
  "dataFim" : "2000-01-23T04:56:07.000+00:00",
  "valorPromocao" : 80.0,
  "condicaoPagamento" : 0,
  "nomeLaboratorio" : "REFERENCIA OTC",
  "percentualDesconto" : 20.0,
  "valorVenda" : 100.0,
  "codigoProduto" : 1,
  "quantidadeItens" : 5,
  "quantidadeEstoque" : 2,
  "dataInicio" : "2000-01-23T04:56:07.000+00:00",
  "codigoBarras" : 7897316804858,
  "nomeProduto" : "REFRESH GEL 0,3% OFT 10G",
  "origemDesconto" : "origemDesconto",
  "codigoLaboratorio" : 14
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Descontos progressivos retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta dos descontos progressivos.

get /integracao/produto/desconto/progressivo/obter-v2

Obtém os descontos progressivos (obterDescontoProgressivoV2)

Obtém os descontos progressivos cadastrados no sistema com base nos parâmetros fornecidos.

Query parameters

codigoBarras (optional)

Query Parameter — Código de barras do produto.

codigoProduto (optional)

Query Parameter — Código do produto.

considerarTodasCondicoesPagamento (optional)

Query Parameter — Indica se todas as condições de pagamento devem ser consideradas.

dataReferencia (optional)

Query Parameter — Informar data em formato ISO 8601.

removerRestricaoEstoque (optional)

Query Parameter — Remove a filtragem de somente produtos com estoque positivo.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[DescontoProgressivoRetornoIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "dataFim" : "2000-01-23T04:56:07.000+00:00",
  "valorPromocao" : 7.061401241503109,
  "condicoesPagamento" : "DINHEIRO, CARTÃO",
  "nomeLaboratorio" : "nomeLaboratorio",
  "percentualDesconto" : 5.962133916683182,
  "valorVenda" : 9.301444243932576,
  "codigoProduto" : 1,
  "quantidadeItens" : 2,
  "quantidadeEstoque" : 5,
  "dataInicio" : "2000-01-23T04:56:07.000+00:00",
  "codigoBarras" : 0,
  "nomeProduto" : "nomeProduto",
  "origemDesconto" : "PRODUTO",
  "codigoLaboratorio" : 6
}, {
  "dataFim" : "2000-01-23T04:56:07.000+00:00",
  "valorPromocao" : 7.061401241503109,
  "condicoesPagamento" : "DINHEIRO, CARTÃO",
  "nomeLaboratorio" : "nomeLaboratorio",
  "percentualDesconto" : 5.962133916683182,
  "valorVenda" : 9.301444243932576,
  "codigoProduto" : 1,
  "quantidadeItens" : 2,
  "quantidadeEstoque" : 5,
  "dataInicio" : "2000-01-23T04:56:07.000+00:00",
  "codigoBarras" : 0,
  "nomeProduto" : "nomeProduto",
  "origemDesconto" : "PRODUTO",
  "codigoLaboratorio" : 6
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Descontos progressivos retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta dos descontos progressivos.

get /integracao/produto/desconto/melhor/obter-alterados-v1

Obtém melhores descontos alterados (obterMelhorDescontoAlteradosV1)

Obtém os melhores descontos cadastrados no sistema que foram alterados dentro do intervalo de datas fornecido.

Query parameters

removerRestricaoEstoque (optional)

Query Parameter — Remove a filtragem de somente produtos com estoque positivo.

dataInicial (required)

Query Parameter — Data inicial em formato ISO 8601.

dataFinal (required)

Query Parameter — Data final em formato ISO 8601.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[DescontoMelhorIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "nomeLaboratorio" : "REFERENCIA OTC",
  "percentualDesconto" : 10.45,
  "valorPromocao" : 10.59,
  "valorVenda" : 50.78,
  "codigoCondicaoPagamento" : 3,
  "codigoProduto" : 1,
  "nomeCondicaoPagamento" : "DINHEIRO",
  "quantidadeEstoque" : 100,
  "codigoBarras" : 7897316804858,
  "nomeProduto" : "REFRESH GEL 0,3% OFT 10G",
  "codigoLaboratorio" : 14
}, {
  "nomeLaboratorio" : "REFERENCIA OTC",
  "percentualDesconto" : 10.45,
  "valorPromocao" : 10.59,
  "valorVenda" : 50.78,
  "codigoCondicaoPagamento" : 3,
  "codigoProduto" : 1,
  "nomeCondicaoPagamento" : "DINHEIRO",
  "quantidadeEstoque" : 100,
  "codigoBarras" : 7897316804858,
  "nomeProduto" : "REFRESH GEL 0,3% OFT 10G",
  "codigoLaboratorio" : 14
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Melhores descontos alterados retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta dos melhores descontos alterados.

get /integracao/produto/desconto/melhor/obter-v1

Obtém melhores descontos (obterMelhorDescontoV1)

Obtém os melhores descontos cadastrados no sistema com base nos parâmetros fornecidos.

Query parameters

codigoBarras (optional)

Query Parameter — Código de barras do produto.

codigoProduto (optional)

Query Parameter — Código do produto.

considerarTodasCondicoesPagamento (optional)

Query Parameter — Indica se todas as condições de pagamento devem ser consideradas.

removerRestricaoEstoque (optional)

Query Parameter — Remove a filtragem de somente produtos com estoque positivo.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[DescontoMelhorIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "nomeLaboratorio" : "REFERENCIA OTC",
  "percentualDesconto" : 10.45,
  "valorPromocao" : 10.59,
  "valorVenda" : 50.78,
  "codigoCondicaoPagamento" : 3,
  "codigoProduto" : 1,
  "nomeCondicaoPagamento" : "DINHEIRO",
  "quantidadeEstoque" : 100,
  "codigoBarras" : 7897316804858,
  "nomeProduto" : "REFRESH GEL 0,3% OFT 10G",
  "codigoLaboratorio" : 14
}, {
  "nomeLaboratorio" : "REFERENCIA OTC",
  "percentualDesconto" : 10.45,
  "valorPromocao" : 10.59,
  "valorVenda" : 50.78,
  "codigoCondicaoPagamento" : 3,
  "codigoProduto" : 1,
  "nomeCondicaoPagamento" : "DINHEIRO",
  "quantidadeEstoque" : 100,
  "codigoBarras" : 7897316804858,
  "nomeProduto" : "REFRESH GEL 0,3% OFT 10G",
  "codigoLaboratorio" : 14
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Melhores descontos retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta dos melhores descontos.

get /integracao/produto/desconto/progressivo/obter-todos-v1

Obtém todos os descontos progressivos (obterTodosDescontoProgressivoV1)

Obtém todos os descontos progressivos cadastrados no sistema.

Query parameters

removerRestricaoEstoque (optional)

Query Parameter — Remove a filtragem de somente produtos com estoque positivo.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[DescontoProgressivoIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "dataFim" : "2000-01-23T04:56:07.000+00:00",
  "valorPromocao" : 80.0,
  "condicaoPagamento" : 0,
  "nomeLaboratorio" : "REFERENCIA OTC",
  "percentualDesconto" : 20.0,
  "valorVenda" : 100.0,
  "codigoProduto" : 1,
  "quantidadeItens" : 5,
  "quantidadeEstoque" : 2,
  "dataInicio" : "2000-01-23T04:56:07.000+00:00",
  "codigoBarras" : 7897316804858,
  "nomeProduto" : "REFRESH GEL 0,3% OFT 10G",
  "origemDesconto" : "origemDesconto",
  "codigoLaboratorio" : 14
}, {
  "dataFim" : "2000-01-23T04:56:07.000+00:00",
  "valorPromocao" : 80.0,
  "condicaoPagamento" : 0,
  "nomeLaboratorio" : "REFERENCIA OTC",
  "percentualDesconto" : 20.0,
  "valorVenda" : 100.0,
  "codigoProduto" : 1,
  "quantidadeItens" : 5,
  "quantidadeEstoque" : 2,
  "dataInicio" : "2000-01-23T04:56:07.000+00:00",
  "codigoBarras" : 7897316804858,
  "nomeProduto" : "REFRESH GEL 0,3% OFT 10G",
  "origemDesconto" : "origemDesconto",
  "codigoLaboratorio" : 14
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Descontos progressivos retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta dos descontos progressivos.

get /integracao/produto/desconto/progressivo/obter-todos-v2

Obtém todos os descontos progressivos (obterTodosDescontosProgressivoV2)

Obtém todos os descontos progressivos cadastrados no sistema.

Query parameters

removerRestricaoEstoque (optional)

Query Parameter — Remove a filtragem de somente produtos com estoque positivo.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[DescontoProgressivoRetornoIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "dataFim" : "2000-01-23T04:56:07.000+00:00",
  "valorPromocao" : 7.061401241503109,
  "condicoesPagamento" : "DINHEIRO, CARTÃO",
  "nomeLaboratorio" : "nomeLaboratorio",
  "percentualDesconto" : 5.962133916683182,
  "valorVenda" : 9.301444243932576,
  "codigoProduto" : 1,
  "quantidadeItens" : 2,
  "quantidadeEstoque" : 5,
  "dataInicio" : "2000-01-23T04:56:07.000+00:00",
  "codigoBarras" : 0,
  "nomeProduto" : "nomeProduto",
  "origemDesconto" : "PRODUTO",
  "codigoLaboratorio" : 6
}, {
  "dataFim" : "2000-01-23T04:56:07.000+00:00",
  "valorPromocao" : 7.061401241503109,
  "condicoesPagamento" : "DINHEIRO, CARTÃO",
  "nomeLaboratorio" : "nomeLaboratorio",
  "percentualDesconto" : 5.962133916683182,
  "valorVenda" : 9.301444243932576,
  "codigoProduto" : 1,
  "quantidadeItens" : 2,
  "quantidadeEstoque" : 5,
  "dataInicio" : "2000-01-23T04:56:07.000+00:00",
  "codigoBarras" : 0,
  "nomeProduto" : "nomeProduto",
  "origemDesconto" : "PRODUTO",
  "codigoLaboratorio" : 6
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Descontos progressivos retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta dos descontos progressivos.

get /integracao/produto/desconto/melhor/obter-todos-v1

Obtém todos os melhores descontos (obterTodosMelhorDescontoV1)

Obtém todos os melhores descontos cadastrados no sistema.

Query parameters

removerRestricaoEstoque (optional)

Query Parameter — Remove a filtragem de somente produtos com estoque positivo.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[DescontoMelhorIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "nomeLaboratorio" : "REFERENCIA OTC",
  "percentualDesconto" : 10.45,
  "valorPromocao" : 10.59,
  "valorVenda" : 50.78,
  "codigoCondicaoPagamento" : 3,
  "codigoProduto" : 1,
  "nomeCondicaoPagamento" : "DINHEIRO",
  "quantidadeEstoque" : 100,
  "codigoBarras" : 7897316804858,
  "nomeProduto" : "REFRESH GEL 0,3% OFT 10G",
  "codigoLaboratorio" : 14
}, {
  "nomeLaboratorio" : "REFERENCIA OTC",
  "percentualDesconto" : 10.45,
  "valorPromocao" : 10.59,
  "valorVenda" : 50.78,
  "codigoCondicaoPagamento" : 3,
  "codigoProduto" : 1,
  "nomeCondicaoPagamento" : "DINHEIRO",
  "quantidadeEstoque" : 100,
  "codigoBarras" : 7897316804858,
  "nomeProduto" : "REFRESH GEL 0,3% OFT 10G",
  "codigoLaboratorio" : 14
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Melhores descontos retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta dos melhores descontos.

ParcelasCarto

get /integracao/parcelas-cartao/obter-alterados-v1

Obtém parcelas de cartão alteradas (obterParcelasCartaoAlteradasV1)

Obtém as parcelas de cartão cadastradas no sistema que foram alteradas em um determinado período.

Query parameters

dataInicial (required)

Query Parameter — Data inicial em formato ISO 8601.

dataFinal (required)

Query Parameter — Data final em formato ISO 8601.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

ParcelaCartaoIntegracaoDto

Example data

Content-Type: application/json

{
  "transacoes" : [ {
    "totalParcelas" : 2.0,
    "dataPagamento" : "2000-01-23T04:56:07.000+00:00",
    "idTransacaoPIX" : "1321097743",
    "formaCaptura" : "TEF",
    "idParcela" : 1,
    "valorTaxas" : 2.0,
    "administradoraCartao" : "CONVCARD ADMIN. DE CARTOES",
    "codigoCartao" : 5,
    "dataEmissao" : "2000-01-23T04:56:07.000+00:00",
    "codigoBandeira" : "999",
    "codigoEstabelecimentoAdquirente" : 1234567890,
    "codigoAutorizacao" : "789321",
    "valorParcela" : 48.0,
    "prazoVenda" : "A VISTA",
    "modalidadeVenda" : "CREDITO",
    "idTransacao" : "VE:352698",
    "nomeCartao" : "CONVCARD",
    "dataVencimento" : "2000-01-23T04:56:07.000+00:00",
    "nsuAdministradora" : "123456",
    "nsuOrigem" : 1,
    "valorTotal" : 100.0,
    "documentoFiscal" : 789651,
    "numeroParcela" : 1,
    "nomeAdquirente" : "FACISC"
  }, {
    "totalParcelas" : 2.0,
    "dataPagamento" : "2000-01-23T04:56:07.000+00:00",
    "idTransacaoPIX" : "1321097743",
    "formaCaptura" : "TEF",
    "idParcela" : 1,
    "valorTaxas" : 2.0,
    "administradoraCartao" : "CONVCARD ADMIN. DE CARTOES",
    "codigoCartao" : 5,
    "dataEmissao" : "2000-01-23T04:56:07.000+00:00",
    "codigoBandeira" : "999",
    "codigoEstabelecimentoAdquirente" : 1234567890,
    "codigoAutorizacao" : "789321",
    "valorParcela" : 48.0,
    "prazoVenda" : "A VISTA",
    "modalidadeVenda" : "CREDITO",
    "idTransacao" : "VE:352698",
    "nomeCartao" : "CONVCARD",
    "dataVencimento" : "2000-01-23T04:56:07.000+00:00",
    "nsuAdministradora" : "123456",
    "nsuOrigem" : 1,
    "valorTotal" : 100.0,
    "documentoFiscal" : 789651,
    "numeroParcela" : 1,
    "nomeAdquirente" : "FACISC"
  } ],
  "inscricaoEstadualLoja" : "ISENTO",
  "cnpjLoja" : "99.999.999/0001-99",
  "codigoLoja" : 1,
  "razaoSocial" : "FARMACIA E DROGARIA LTDA"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Parcelas de cartão alteradas retornadas com sucesso. ParcelaCartaoIntegracaoDto

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta das parcelas de cartão alteradas.

get /integracao/parcelas-cartao/estorno-v1

Obtém parcelas de cartão de estorno (obterParcelasCartaoEstornoV1)

Obtém as parcelas de cartão de estorno cadastradas no sistema, com filtros de data de emissão.

Query parameters

dataEmissaoInicial (optional)

Query Parameter — Data inicial de emissão em formato ISO 8601.

dataEmissaoFinal (optional)

Query Parameter — Data final de emissão em formato ISO 8601.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

ParcelaCartaoEstornoIntegracaoDto

Example data

Content-Type: application/json

{
  "inscricaoEstadualLoja" : "ISENTO",
  "cnpjLoja" : "99.999.999/0001-99",
  "codigoLoja" : 1,
  "razaoSocial" : "FARMACIA E DROGARIA LTDA",
  "estornos" : [ {
    "dataEmissaoOrigem" : "2000-01-23T04:56:07.000+00:00",
    "totalNotaDevolucao" : 24.5,
    "numeroNotaOrigem" : 98765,
    "totalNotaOrigem" : 24.5,
    "dataEmissaoDevolucao" : "2000-01-23T04:56:07.000+00:00",
    "numeroNotaDevolucao" : 98766
  }, {
    "dataEmissaoOrigem" : "2000-01-23T04:56:07.000+00:00",
    "totalNotaDevolucao" : 24.5,
    "numeroNotaOrigem" : 98765,
    "totalNotaOrigem" : 24.5,
    "dataEmissaoDevolucao" : "2000-01-23T04:56:07.000+00:00",
    "numeroNotaDevolucao" : 98766
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Parcelas de cartão de estorno retornadas com sucesso. ParcelaCartaoEstornoIntegracaoDto

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta das parcelas de cartão de estorno.

get /integracao/parcelas-cartao/obter-v1

Obtém parcelas de cartão (obterParcelasCartaoV1)

Obtém as parcelas de cartão cadastradas no sistema, com filtros de data de emissão.

Query parameters

dataEmissaoInicial (optional)

Query Parameter — Data inicial de emissão em formato ISO 8601.

dataEmissaoFinal (optional)

Query Parameter — Data final de emissão em formato ISO 8601.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

ParcelaCartaoIntegracaoDto

Example data

Content-Type: application/json

{
  "transacoes" : [ {
    "totalParcelas" : 2.0,
    "dataPagamento" : "2000-01-23T04:56:07.000+00:00",
    "idTransacaoPIX" : "1321097743",
    "formaCaptura" : "TEF",
    "idParcela" : 1,
    "valorTaxas" : 2.0,
    "administradoraCartao" : "CONVCARD ADMIN. DE CARTOES",
    "codigoCartao" : 5,
    "dataEmissao" : "2000-01-23T04:56:07.000+00:00",
    "codigoBandeira" : "999",
    "codigoEstabelecimentoAdquirente" : 1234567890,
    "codigoAutorizacao" : "789321",
    "valorParcela" : 48.0,
    "prazoVenda" : "A VISTA",
    "modalidadeVenda" : "CREDITO",
    "idTransacao" : "VE:352698",
    "nomeCartao" : "CONVCARD",
    "dataVencimento" : "2000-01-23T04:56:07.000+00:00",
    "nsuAdministradora" : "123456",
    "nsuOrigem" : 1,
    "valorTotal" : 100.0,
    "documentoFiscal" : 789651,
    "numeroParcela" : 1,
    "nomeAdquirente" : "FACISC"
  }, {
    "totalParcelas" : 2.0,
    "dataPagamento" : "2000-01-23T04:56:07.000+00:00",
    "idTransacaoPIX" : "1321097743",
    "formaCaptura" : "TEF",
    "idParcela" : 1,
    "valorTaxas" : 2.0,
    "administradoraCartao" : "CONVCARD ADMIN. DE CARTOES",
    "codigoCartao" : 5,
    "dataEmissao" : "2000-01-23T04:56:07.000+00:00",
    "codigoBandeira" : "999",
    "codigoEstabelecimentoAdquirente" : 1234567890,
    "codigoAutorizacao" : "789321",
    "valorParcela" : 48.0,
    "prazoVenda" : "A VISTA",
    "modalidadeVenda" : "CREDITO",
    "idTransacao" : "VE:352698",
    "nomeCartao" : "CONVCARD",
    "dataVencimento" : "2000-01-23T04:56:07.000+00:00",
    "nsuAdministradora" : "123456",
    "nsuOrigem" : 1,
    "valorTotal" : 100.0,
    "documentoFiscal" : 789651,
    "numeroParcela" : 1,
    "nomeAdquirente" : "FACISC"
  } ],
  "inscricaoEstadualLoja" : "ISENTO",
  "cnpjLoja" : "99.999.999/0001-99",
  "codigoLoja" : 1,
  "razaoSocial" : "FARMACIA E DROGARIA LTDA"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Parcelas de cartão retornadas com sucesso. ParcelaCartaoIntegracaoDto

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta das parcelas de cartão.

get /integracao/parcelas-cartao/obter-todos-v1

Obtém todas as parcelas de cartão (obterTodasParcelasCartaoV1)

Obtém todas as parcelas de cartão cadastradas no sistema.

Query parameters

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

ParcelaCartaoIntegracaoDto

Example data

Content-Type: application/json

{
  "transacoes" : [ {
    "totalParcelas" : 2.0,
    "dataPagamento" : "2000-01-23T04:56:07.000+00:00",
    "idTransacaoPIX" : "1321097743",
    "formaCaptura" : "TEF",
    "idParcela" : 1,
    "valorTaxas" : 2.0,
    "administradoraCartao" : "CONVCARD ADMIN. DE CARTOES",
    "codigoCartao" : 5,
    "dataEmissao" : "2000-01-23T04:56:07.000+00:00",
    "codigoBandeira" : "999",
    "codigoEstabelecimentoAdquirente" : 1234567890,
    "codigoAutorizacao" : "789321",
    "valorParcela" : 48.0,
    "prazoVenda" : "A VISTA",
    "modalidadeVenda" : "CREDITO",
    "idTransacao" : "VE:352698",
    "nomeCartao" : "CONVCARD",
    "dataVencimento" : "2000-01-23T04:56:07.000+00:00",
    "nsuAdministradora" : "123456",
    "nsuOrigem" : 1,
    "valorTotal" : 100.0,
    "documentoFiscal" : 789651,
    "numeroParcela" : 1,
    "nomeAdquirente" : "FACISC"
  }, {
    "totalParcelas" : 2.0,
    "dataPagamento" : "2000-01-23T04:56:07.000+00:00",
    "idTransacaoPIX" : "1321097743",
    "formaCaptura" : "TEF",
    "idParcela" : 1,
    "valorTaxas" : 2.0,
    "administradoraCartao" : "CONVCARD ADMIN. DE CARTOES",
    "codigoCartao" : 5,
    "dataEmissao" : "2000-01-23T04:56:07.000+00:00",
    "codigoBandeira" : "999",
    "codigoEstabelecimentoAdquirente" : 1234567890,
    "codigoAutorizacao" : "789321",
    "valorParcela" : 48.0,
    "prazoVenda" : "A VISTA",
    "modalidadeVenda" : "CREDITO",
    "idTransacao" : "VE:352698",
    "nomeCartao" : "CONVCARD",
    "dataVencimento" : "2000-01-23T04:56:07.000+00:00",
    "nsuAdministradora" : "123456",
    "nsuOrigem" : 1,
    "valorTotal" : 100.0,
    "documentoFiscal" : 789651,
    "numeroParcela" : 1,
    "nomeAdquirente" : "FACISC"
  } ],
  "inscricaoEstadualLoja" : "ISENTO",
  "cnpjLoja" : "99.999.999/0001-99",
  "codigoLoja" : 1,
  "razaoSocial" : "FARMACIA E DROGARIA LTDA"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Parcelas de cartão retornadas com sucesso. ParcelaCartaoIntegracaoDto

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta das parcelas de cartão.

Pedido

get /integracao/pedido/itens/resumido/obter-alterados-v1

Obtém itens de pedidos resumidos alterados (obterItensPedidosResumidoAlteradosV1)

Obtém itens de pedidos resumidos cadastrados no sistema que foram alterados dentro do intervalo de datas fornecido.

Query parameters

dataInicial (required)

Query Parameter — Data inicial em formato ISO 8601.

dataFinal (required)

Query Parameter — Data final em formato ISO 8601.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[ItemPedidoResumidoIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "codigoComprador" : 30,
  "codigoFornecedor" : 14,
  "nomeComprador" : "JOÃO DA SILVA",
  "fatorCompraUltimaCompra" : 1,
  "transmitido" : true,
  "cnpjFornecedorUltimaCompra" : "99.999.999/0001-99",
  "dataEmissao" : "2000-01-23T04:56:07.000+00:00",
  "quantidadeProdutos" : 20,
  "codigoFornecedorUltimaCompra" : 14,
  "horaEmissao" : "2000-01-23T04:56:07.000+00:00",
  "valorUnitarioUltimaCompra" : 9.8,
  "valorUnitario" : 10.5,
  "nomeFornecedorUltimaCompra" : "FORNECEDOR XYZ",
  "nomeFornecedor" : "FORNECEDOR XYZ",
  "numeroSequencialItem" : 4,
  "codigoProduto" : 1,
  "fatorCompra" : 1,
  "numeroPedido" : 1,
  "quantidadeEstoque" : 100,
  "codigoBarras" : 7891234567890,
  "nomeProduto" : "PRODUTO ABC"
}, {
  "codigoComprador" : 30,
  "codigoFornecedor" : 14,
  "nomeComprador" : "JOÃO DA SILVA",
  "fatorCompraUltimaCompra" : 1,
  "transmitido" : true,
  "cnpjFornecedorUltimaCompra" : "99.999.999/0001-99",
  "dataEmissao" : "2000-01-23T04:56:07.000+00:00",
  "quantidadeProdutos" : 20,
  "codigoFornecedorUltimaCompra" : 14,
  "horaEmissao" : "2000-01-23T04:56:07.000+00:00",
  "valorUnitarioUltimaCompra" : 9.8,
  "valorUnitario" : 10.5,
  "nomeFornecedorUltimaCompra" : "FORNECEDOR XYZ",
  "nomeFornecedor" : "FORNECEDOR XYZ",
  "numeroSequencialItem" : 4,
  "codigoProduto" : 1,
  "fatorCompra" : 1,
  "numeroPedido" : 1,
  "quantidadeEstoque" : 100,
  "codigoBarras" : 7891234567890,
  "nomeProduto" : "PRODUTO ABC"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Itens de pedidos resumidos alterados retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta dos itens de pedidos resumidos alterados.

get /integracao/pedido/itens/resumido/obter-v1

Obtém itens de pedidos resumidos (obterItensPedidosResumidoV1)

Obtém itens de pedidos resumidos cadastrados no sistema com base em filtros opcionais.

Query parameters

dataEmissaoInicial (optional)

Query Parameter — Data de emissão inicial para filtro dos pedidos.

dataEmissaoFinal (optional)

Query Parameter — Data de emissão final para filtro dos pedidos.

numeroPedido (optional)

Query Parameter — Número do pedido para filtro.

codigoComprador (optional)

Query Parameter — Código do comprador para filtro.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[ItemPedidoResumidoIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "codigoComprador" : 30,
  "codigoFornecedor" : 14,
  "nomeComprador" : "JOÃO DA SILVA",
  "fatorCompraUltimaCompra" : 1,
  "transmitido" : true,
  "cnpjFornecedorUltimaCompra" : "99.999.999/0001-99",
  "dataEmissao" : "2000-01-23T04:56:07.000+00:00",
  "quantidadeProdutos" : 20,
  "codigoFornecedorUltimaCompra" : 14,
  "horaEmissao" : "2000-01-23T04:56:07.000+00:00",
  "valorUnitarioUltimaCompra" : 9.8,
  "valorUnitario" : 10.5,
  "nomeFornecedorUltimaCompra" : "FORNECEDOR XYZ",
  "nomeFornecedor" : "FORNECEDOR XYZ",
  "numeroSequencialItem" : 4,
  "codigoProduto" : 1,
  "fatorCompra" : 1,
  "numeroPedido" : 1,
  "quantidadeEstoque" : 100,
  "codigoBarras" : 7891234567890,
  "nomeProduto" : "PRODUTO ABC"
}, {
  "codigoComprador" : 30,
  "codigoFornecedor" : 14,
  "nomeComprador" : "JOÃO DA SILVA",
  "fatorCompraUltimaCompra" : 1,
  "transmitido" : true,
  "cnpjFornecedorUltimaCompra" : "99.999.999/0001-99",
  "dataEmissao" : "2000-01-23T04:56:07.000+00:00",
  "quantidadeProdutos" : 20,
  "codigoFornecedorUltimaCompra" : 14,
  "horaEmissao" : "2000-01-23T04:56:07.000+00:00",
  "valorUnitarioUltimaCompra" : 9.8,
  "valorUnitario" : 10.5,
  "nomeFornecedorUltimaCompra" : "FORNECEDOR XYZ",
  "nomeFornecedor" : "FORNECEDOR XYZ",
  "numeroSequencialItem" : 4,
  "codigoProduto" : 1,
  "fatorCompra" : 1,
  "numeroPedido" : 1,
  "quantidadeEstoque" : 100,
  "codigoBarras" : 7891234567890,
  "nomeProduto" : "PRODUTO ABC"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Itens de pedidos resumidos retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta dos itens de pedidos resumidos.

get /integracao/pedido/resumido/obter-alterados-v1

Obtém pedidos resumidos alterados (obterPedidosResumidoAlteradosV1)

Obtém pedidos resumidos cadastrados no sistema que foram alterados dentro do intervalo de datas fornecido.

Query parameters

dataInicial (required)

Query Parameter — Data inicial em formato ISO 8601.

dataFinal (required)

Query Parameter — Data final em formato ISO 8601.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[PedidoResumidoIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "codigoComprador" : 30,
  "nomeComprador" : "JOÃO DA SILVA",
  "numeroPedido" : 1,
  "dataEmissao" : "2000-01-23T04:56:07.000+00:00",
  "horaEmissao" : "2000-01-23T04:56:07.000+00:00"
}, {
  "codigoComprador" : 30,
  "nomeComprador" : "JOÃO DA SILVA",
  "numeroPedido" : 1,
  "dataEmissao" : "2000-01-23T04:56:07.000+00:00",
  "horaEmissao" : "2000-01-23T04:56:07.000+00:00"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Pedidos resumidos alterados retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta dos pedidos resumidos alterados.

get /integracao/pedido/resumido/obter-v1

Obtém pedidos resumidos (obterPedidosResumidoV1)

Obtém pedidos resumidos cadastrados no sistema com base em filtros opcionais.

Query parameters

dataEmissaoInicial (optional)

Query Parameter — Data de emissão inicial para filtro dos pedidos.

dataEmissaoFinal (optional)

Query Parameter — Data de emissão final para filtro dos pedidos.

numeroPedido (optional)

Query Parameter — Número do pedido para filtro.

codigoComprador (optional)

Query Parameter — Código do comprador para filtro.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[PedidoResumidoIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "codigoComprador" : 30,
  "nomeComprador" : "JOÃO DA SILVA",
  "numeroPedido" : 1,
  "dataEmissao" : "2000-01-23T04:56:07.000+00:00",
  "horaEmissao" : "2000-01-23T04:56:07.000+00:00"
}, {
  "codigoComprador" : 30,
  "nomeComprador" : "JOÃO DA SILVA",
  "numeroPedido" : 1,
  "dataEmissao" : "2000-01-23T04:56:07.000+00:00",
  "horaEmissao" : "2000-01-23T04:56:07.000+00:00"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Pedidos resumidos retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta dos pedidos resumidos.

get /integracao/pedido/itens/resumido/obter-todos-v1

Obtém todos os itens de pedidos resumidos (obterTodosItensPedidosResumidoV1)

Obtém todos os itens de pedidos resumidos cadastrados no sistema.

Query parameters

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[ItemPedidoResumidoIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "codigoComprador" : 30,
  "codigoFornecedor" : 14,
  "nomeComprador" : "JOÃO DA SILVA",
  "fatorCompraUltimaCompra" : 1,
  "transmitido" : true,
  "cnpjFornecedorUltimaCompra" : "99.999.999/0001-99",
  "dataEmissao" : "2000-01-23T04:56:07.000+00:00",
  "quantidadeProdutos" : 20,
  "codigoFornecedorUltimaCompra" : 14,
  "horaEmissao" : "2000-01-23T04:56:07.000+00:00",
  "valorUnitarioUltimaCompra" : 9.8,
  "valorUnitario" : 10.5,
  "nomeFornecedorUltimaCompra" : "FORNECEDOR XYZ",
  "nomeFornecedor" : "FORNECEDOR XYZ",
  "numeroSequencialItem" : 4,
  "codigoProduto" : 1,
  "fatorCompra" : 1,
  "numeroPedido" : 1,
  "quantidadeEstoque" : 100,
  "codigoBarras" : 7891234567890,
  "nomeProduto" : "PRODUTO ABC"
}, {
  "codigoComprador" : 30,
  "codigoFornecedor" : 14,
  "nomeComprador" : "JOÃO DA SILVA",
  "fatorCompraUltimaCompra" : 1,
  "transmitido" : true,
  "cnpjFornecedorUltimaCompra" : "99.999.999/0001-99",
  "dataEmissao" : "2000-01-23T04:56:07.000+00:00",
  "quantidadeProdutos" : 20,
  "codigoFornecedorUltimaCompra" : 14,
  "horaEmissao" : "2000-01-23T04:56:07.000+00:00",
  "valorUnitarioUltimaCompra" : 9.8,
  "valorUnitario" : 10.5,
  "nomeFornecedorUltimaCompra" : "FORNECEDOR XYZ",
  "nomeFornecedor" : "FORNECEDOR XYZ",
  "numeroSequencialItem" : 4,
  "codigoProduto" : 1,
  "fatorCompra" : 1,
  "numeroPedido" : 1,
  "quantidadeEstoque" : 100,
  "codigoBarras" : 7891234567890,
  "nomeProduto" : "PRODUTO ABC"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Itens de pedidos resumidos retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta dos itens de pedidos resumidos.

get /integracao/pedido/resumido/obter-todos-v1

Obtém todos os pedidos resumidos (obterTodosPedidosResumidoV1)

Obtém todos os pedidos resumidos cadastrados no sistema.

Query parameters

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[PedidoResumidoIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "codigoComprador" : 30,
  "nomeComprador" : "JOÃO DA SILVA",
  "numeroPedido" : 1,
  "dataEmissao" : "2000-01-23T04:56:07.000+00:00",
  "horaEmissao" : "2000-01-23T04:56:07.000+00:00"
}, {
  "codigoComprador" : 30,
  "nomeComprador" : "JOÃO DA SILVA",
  "numeroPedido" : 1,
  "dataEmissao" : "2000-01-23T04:56:07.000+00:00",
  "horaEmissao" : "2000-01-23T04:56:07.000+00:00"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Pedidos resumidos retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta dos pedidos resumidos.

Precificao

get /integracao/produto/precificacao/obter-alterados-v1

Lista descontos por precificação alterados (obterDescontoPrecificacaoAlteradosV1)

Retorna descontos por precificação alterados no período especificado.

Query parameters

dataInicial (required)

Query Parameter — Data inicial em formato ISO 8601.

dataFinal (required)

Query Parameter — Data final em formato ISO 8601.

removerRestricaoEstoque (optional)

Query Parameter — Remove a filtragem de somente produtos com estoque positivo.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[DescontoPrecificacaoIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "valorVenda" : 99.9,
  "codigoProduto" : 12345,
  "codigoFilial" : 1
}, {
  "valorVenda" : 99.9,
  "codigoProduto" : 12345,
  "codigoFilial" : 1
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Descontos alterados retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de descontos por precificação alterados.

get /integracao/produto/precificacao/obter-movimentados-v1

Lista descontos por precificação movimentados (obterDescontoPrecificacaoMovimentadosV1)

Retorna descontos por precificação movimentados no período especificado.

Query parameters

dataInicial (required)

Query Parameter — Data inicial em formato ISO 8601.

dataFinal (required)

Query Parameter — Data final em formato ISO 8601.

removerRestricaoEstoque (optional)

Query Parameter — Remove a filtragem de somente produtos com estoque positivo.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[DescontoPrecificacaoIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "valorVenda" : 99.9,
  "codigoProduto" : 12345,
  "codigoFilial" : 1
}, {
  "valorVenda" : 99.9,
  "codigoProduto" : 12345,
  "codigoFilial" : 1
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Descontos movimentados retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de descontos por precificação movimentados.

get /integracao/produto/precificacao/obter-todos-v1

Lista todos os descontos por precificação (obterTodosDescontoPrecificacaoV1)

Retorna todos os descontos por precificação com paginação.

Query parameters

removerRestricaoEstoque (optional)

Query Parameter — Remove a filtragem de somente produtos com estoque positivo.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[DescontoPrecificacaoIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "valorVenda" : 99.9,
  "codigoProduto" : 12345,
  "codigoFilial" : 1
}, {
  "valorVenda" : 99.9,
  "codigoProduto" : 12345,
  "codigoFilial" : 1
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Descontos retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de descontos por precificação.

Produto

get /integracao/produto/obter-alterados-v1

Lista produtos alterados (obterAlteradosV12)

Retorna produtos alterados no período especificado com filtros opcionais e paginação.

Query parameters

integracaoEcommerce (optional)

Query Parameter — Filtra por integração e-commerce.

processaCustoMedio (optional)

Query Parameter — Processa custo médio.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

dataInicial (required)

Query Parameter — Informar data em formato ISO 8601. format: date-time

dataFinal (required)

Query Parameter — Informar data em formato ISO 8601. format: date-time

Return type

array[ProdutoIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "corEcommerce" : {
    "codigo" : 10,
    "nome" : "Azul"
  },
  "valorVendaEcommerce" : 21.9,
  "ativo" : true,
  "tipo" : {
    "codigo" : 1,
    "nome" : "Medicamento"
  },
  "nomeDepartamento" : "Medicamentos",
  "codigoPrincipioAtivo" : "PARA",
  "codDepto" : 20,
  "unidade" : "UN",
  "nomeClassificacao" : "Tarja Amarela",
  "tipoLista" : "PADRAO",
  "nomeEcommerce" : "Paracetamol 750mg - 20 comprimidos",
  "nomeLaboratorio" : "Laboratorio Exemplo",
  "valorCusto" : 12.5,
  "idProduto" : "SKU-000123",
  "codTipo" : 1,
  "nomeGrupo" : "Analgesicos",
  "qtdLimiteCarrinhoEcommerce" : 5,
  "codigoGrupo" : 30,
  "profundidadeEcommerce" : 20,
  "valorCustoMedio" : 13.1,
  "alturaEcommerce" : 120,
  "codigoBarras" : 7891234567890,
  "nomDepto" : "Medicamentos",
  "codigoLaboratorio" : 101,
  "nomTipo" : "Medicamento",
  "observacaoVenda" : "Produto nao fracionavel.",
  "produtoManipulado" : "N",
  "codigo" : 12345,
  "codigoDepartamento" : 20,
  "tamanhoEcommerce" : {
    "codigo" : 5,
    "nome" : "M"
  },
  "quantidadeEstoqueEcommerce" : 50,
  "codigoCategoria" : 40,
  "descricaoEcommerce" : "Analgesico indicado para dores e febre.",
  "larguraEcommerce" : 40,
  "pesoEcommerce" : 150,
  "nome" : "Paracetamol 750mg",
  "codigoClassificacao" : 50,
  "integracaoEcommerce" : true,
  "nomeCategoria" : "Uso Adulto",
  "tags" : [ "tags", "tags" ],
  "percentualDesconto" : 10.0,
  "nomePrincipioAtivo" : "Paracetamol",
  "percentualDescontoMax" : 15.0,
  "valorVenda" : 19.9,
  "quantidadeEstoque" : 100,
  "codClaFiscal" : "1234.56.78"
}, {
  "corEcommerce" : {
    "codigo" : 10,
    "nome" : "Azul"
  },
  "valorVendaEcommerce" : 21.9,
  "ativo" : true,
  "tipo" : {
    "codigo" : 1,
    "nome" : "Medicamento"
  },
  "nomeDepartamento" : "Medicamentos",
  "codigoPrincipioAtivo" : "PARA",
  "codDepto" : 20,
  "unidade" : "UN",
  "nomeClassificacao" : "Tarja Amarela",
  "tipoLista" : "PADRAO",
  "nomeEcommerce" : "Paracetamol 750mg - 20 comprimidos",
  "nomeLaboratorio" : "Laboratorio Exemplo",
  "valorCusto" : 12.5,
  "idProduto" : "SKU-000123",
  "codTipo" : 1,
  "nomeGrupo" : "Analgesicos",
  "qtdLimiteCarrinhoEcommerce" : 5,
  "codigoGrupo" : 30,
  "profundidadeEcommerce" : 20,
  "valorCustoMedio" : 13.1,
  "alturaEcommerce" : 120,
  "codigoBarras" : 7891234567890,
  "nomDepto" : "Medicamentos",
  "codigoLaboratorio" : 101,
  "nomTipo" : "Medicamento",
  "observacaoVenda" : "Produto nao fracionavel.",
  "produtoManipulado" : "N",
  "codigo" : 12345,
  "codigoDepartamento" : 20,
  "tamanhoEcommerce" : {
    "codigo" : 5,
    "nome" : "M"
  },
  "quantidadeEstoqueEcommerce" : 50,
  "codigoCategoria" : 40,
  "descricaoEcommerce" : "Analgesico indicado para dores e febre.",
  "larguraEcommerce" : 40,
  "pesoEcommerce" : 150,
  "nome" : "Paracetamol 750mg",
  "codigoClassificacao" : 50,
  "integracaoEcommerce" : true,
  "nomeCategoria" : "Uso Adulto",
  "tags" : [ "tags", "tags" ],
  "percentualDesconto" : 10.0,
  "nomePrincipioAtivo" : "Paracetamol",
  "percentualDescontoMax" : 15.0,
  "valorVenda" : 19.9,
  "quantidadeEstoque" : 100,
  "codClaFiscal" : "1234.56.78"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Produtos alterados retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de produtos alterados.

get /integracao/produto/obter-v1

Lista produtos (obterAvancadoV1)

Consulta a lista de produtos com filtros opcionais e paginação.

Query parameters

codigo (optional)

Query Parameter — Código reduzido do produto. Aceita múltiplos valores. format: int64

tipo.codigo (optional)

Query Parameter — Código do tipo do produto. Aceita múltiplos valores. format: int64

codigoBarras (optional)

Query Parameter — Código de barras. Aceita múltiplos valores. format: int64

tipoLista (optional)

Query Parameter — Tipo de lista.

observacaoVenda (optional)

Query Parameter — Observação de venda.

ativo (optional)

Query Parameter — Filtra por ativo.

integracaoEcommerce (optional)

Query Parameter — Filtra por integração e-commerce.

processaCustoMedio (optional)

Query Parameter — Processa custo médio.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[ProdutoIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "corEcommerce" : {
    "codigo" : 10,
    "nome" : "Azul"
  },
  "valorVendaEcommerce" : 21.9,
  "ativo" : true,
  "tipo" : {
    "codigo" : 1,
    "nome" : "Medicamento"
  },
  "nomeDepartamento" : "Medicamentos",
  "codigoPrincipioAtivo" : "PARA",
  "codDepto" : 20,
  "unidade" : "UN",
  "nomeClassificacao" : "Tarja Amarela",
  "tipoLista" : "PADRAO",
  "nomeEcommerce" : "Paracetamol 750mg - 20 comprimidos",
  "nomeLaboratorio" : "Laboratorio Exemplo",
  "valorCusto" : 12.5,
  "idProduto" : "SKU-000123",
  "codTipo" : 1,
  "nomeGrupo" : "Analgesicos",
  "qtdLimiteCarrinhoEcommerce" : 5,
  "codigoGrupo" : 30,
  "profundidadeEcommerce" : 20,
  "valorCustoMedio" : 13.1,
  "alturaEcommerce" : 120,
  "codigoBarras" : 7891234567890,
  "nomDepto" : "Medicamentos",
  "codigoLaboratorio" : 101,
  "nomTipo" : "Medicamento",
  "observacaoVenda" : "Produto nao fracionavel.",
  "produtoManipulado" : "N",
  "codigo" : 12345,
  "codigoDepartamento" : 20,
  "tamanhoEcommerce" : {
    "codigo" : 5,
    "nome" : "M"
  },
  "quantidadeEstoqueEcommerce" : 50,
  "codigoCategoria" : 40,
  "descricaoEcommerce" : "Analgesico indicado para dores e febre.",
  "larguraEcommerce" : 40,
  "pesoEcommerce" : 150,
  "nome" : "Paracetamol 750mg",
  "codigoClassificacao" : 50,
  "integracaoEcommerce" : true,
  "nomeCategoria" : "Uso Adulto",
  "tags" : [ "tags", "tags" ],
  "percentualDesconto" : 10.0,
  "nomePrincipioAtivo" : "Paracetamol",
  "percentualDescontoMax" : 15.0,
  "valorVenda" : 19.9,
  "quantidadeEstoque" : 100,
  "codClaFiscal" : "1234.56.78"
}, {
  "corEcommerce" : {
    "codigo" : 10,
    "nome" : "Azul"
  },
  "valorVendaEcommerce" : 21.9,
  "ativo" : true,
  "tipo" : {
    "codigo" : 1,
    "nome" : "Medicamento"
  },
  "nomeDepartamento" : "Medicamentos",
  "codigoPrincipioAtivo" : "PARA",
  "codDepto" : 20,
  "unidade" : "UN",
  "nomeClassificacao" : "Tarja Amarela",
  "tipoLista" : "PADRAO",
  "nomeEcommerce" : "Paracetamol 750mg - 20 comprimidos",
  "nomeLaboratorio" : "Laboratorio Exemplo",
  "valorCusto" : 12.5,
  "idProduto" : "SKU-000123",
  "codTipo" : 1,
  "nomeGrupo" : "Analgesicos",
  "qtdLimiteCarrinhoEcommerce" : 5,
  "codigoGrupo" : 30,
  "profundidadeEcommerce" : 20,
  "valorCustoMedio" : 13.1,
  "alturaEcommerce" : 120,
  "codigoBarras" : 7891234567890,
  "nomDepto" : "Medicamentos",
  "codigoLaboratorio" : 101,
  "nomTipo" : "Medicamento",
  "observacaoVenda" : "Produto nao fracionavel.",
  "produtoManipulado" : "N",
  "codigo" : 12345,
  "codigoDepartamento" : 20,
  "tamanhoEcommerce" : {
    "codigo" : 5,
    "nome" : "M"
  },
  "quantidadeEstoqueEcommerce" : 50,
  "codigoCategoria" : 40,
  "descricaoEcommerce" : "Analgesico indicado para dores e febre.",
  "larguraEcommerce" : 40,
  "pesoEcommerce" : 150,
  "nome" : "Paracetamol 750mg",
  "codigoClassificacao" : 50,
  "integracaoEcommerce" : true,
  "nomeCategoria" : "Uso Adulto",
  "tags" : [ "tags", "tags" ],
  "percentualDesconto" : 10.0,
  "nomePrincipioAtivo" : "Paracetamol",
  "percentualDescontoMax" : 15.0,
  "valorVenda" : 19.9,
  "quantidadeEstoque" : 100,
  "codClaFiscal" : "1234.56.78"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Produtos retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de produtos.

get /integracao/produto/identificador/obter-alterados-v1

Lista identificadores de produtos alterados (obterIdentificadoresProdutosAlteradosV1)

Retorna identificadores de produtos alterados no período especificado.

Query parameters

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

dataInicial (required)

Query Parameter — Informar data em formato ISO 8601. format: date-time

dataFinal (required)

Query Parameter — Informar data em formato ISO 8601. format: date-time

Return type

array[IdentificadorProdutoIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "principal" : true,
  "ativo" : true,
  "codigo" : 12345,
  "identificador" : 7891234567890
}, {
  "principal" : true,
  "ativo" : true,
  "codigo" : 12345,
  "identificador" : 7891234567890
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Identificadores de produtos alterados retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de identificadores de produtos alterados.

get /integracao/produto/identificador/obter-movimentados-v1

Lista identificadores de produtos movimentados (obterIdentificadoresProdutosMovimentadosV1)

Retorna identificadores de produtos movimentados no período especificado.

Query parameters

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

dataInicial (required)

Query Parameter — Informar data em formato ISO 8601. format: date-time

dataFinal (required)

Query Parameter — Informar data em formato ISO 8601. format: date-time

Return type

array[IdentificadorProdutoIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "principal" : true,
  "ativo" : true,
  "codigo" : 12345,
  "identificador" : 7891234567890
}, {
  "principal" : true,
  "ativo" : true,
  "codigo" : 12345,
  "identificador" : 7891234567890
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Identificadores de produtos movimentados retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de identificadores de produtos movimentados.

get /integracao/produto/obter-movimentados-v1

Lista produtos movimentados (obterMovimentadosV11)

Retorna produtos movimentados no período especificado e com paginação.

Query parameters

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

dataInicial (required)

Query Parameter — Informar data em formato ISO 8601. format: date-time

dataFinal (required)

Query Parameter — Informar data em formato ISO 8601. format: date-time

Return type

array[ProdutoIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "corEcommerce" : {
    "codigo" : 10,
    "nome" : "Azul"
  },
  "valorVendaEcommerce" : 21.9,
  "ativo" : true,
  "tipo" : {
    "codigo" : 1,
    "nome" : "Medicamento"
  },
  "nomeDepartamento" : "Medicamentos",
  "codigoPrincipioAtivo" : "PARA",
  "codDepto" : 20,
  "unidade" : "UN",
  "nomeClassificacao" : "Tarja Amarela",
  "tipoLista" : "PADRAO",
  "nomeEcommerce" : "Paracetamol 750mg - 20 comprimidos",
  "nomeLaboratorio" : "Laboratorio Exemplo",
  "valorCusto" : 12.5,
  "idProduto" : "SKU-000123",
  "codTipo" : 1,
  "nomeGrupo" : "Analgesicos",
  "qtdLimiteCarrinhoEcommerce" : 5,
  "codigoGrupo" : 30,
  "profundidadeEcommerce" : 20,
  "valorCustoMedio" : 13.1,
  "alturaEcommerce" : 120,
  "codigoBarras" : 7891234567890,
  "nomDepto" : "Medicamentos",
  "codigoLaboratorio" : 101,
  "nomTipo" : "Medicamento",
  "observacaoVenda" : "Produto nao fracionavel.",
  "produtoManipulado" : "N",
  "codigo" : 12345,
  "codigoDepartamento" : 20,
  "tamanhoEcommerce" : {
    "codigo" : 5,
    "nome" : "M"
  },
  "quantidadeEstoqueEcommerce" : 50,
  "codigoCategoria" : 40,
  "descricaoEcommerce" : "Analgesico indicado para dores e febre.",
  "larguraEcommerce" : 40,
  "pesoEcommerce" : 150,
  "nome" : "Paracetamol 750mg",
  "codigoClassificacao" : 50,
  "integracaoEcommerce" : true,
  "nomeCategoria" : "Uso Adulto",
  "tags" : [ "tags", "tags" ],
  "percentualDesconto" : 10.0,
  "nomePrincipioAtivo" : "Paracetamol",
  "percentualDescontoMax" : 15.0,
  "valorVenda" : 19.9,
  "quantidadeEstoque" : 100,
  "codClaFiscal" : "1234.56.78"
}, {
  "corEcommerce" : {
    "codigo" : 10,
    "nome" : "Azul"
  },
  "valorVendaEcommerce" : 21.9,
  "ativo" : true,
  "tipo" : {
    "codigo" : 1,
    "nome" : "Medicamento"
  },
  "nomeDepartamento" : "Medicamentos",
  "codigoPrincipioAtivo" : "PARA",
  "codDepto" : 20,
  "unidade" : "UN",
  "nomeClassificacao" : "Tarja Amarela",
  "tipoLista" : "PADRAO",
  "nomeEcommerce" : "Paracetamol 750mg - 20 comprimidos",
  "nomeLaboratorio" : "Laboratorio Exemplo",
  "valorCusto" : 12.5,
  "idProduto" : "SKU-000123",
  "codTipo" : 1,
  "nomeGrupo" : "Analgesicos",
  "qtdLimiteCarrinhoEcommerce" : 5,
  "codigoGrupo" : 30,
  "profundidadeEcommerce" : 20,
  "valorCustoMedio" : 13.1,
  "alturaEcommerce" : 120,
  "codigoBarras" : 7891234567890,
  "nomDepto" : "Medicamentos",
  "codigoLaboratorio" : 101,
  "nomTipo" : "Medicamento",
  "observacaoVenda" : "Produto nao fracionavel.",
  "produtoManipulado" : "N",
  "codigo" : 12345,
  "codigoDepartamento" : 20,
  "tamanhoEcommerce" : {
    "codigo" : 5,
    "nome" : "M"
  },
  "quantidadeEstoqueEcommerce" : 50,
  "codigoCategoria" : 40,
  "descricaoEcommerce" : "Analgesico indicado para dores e febre.",
  "larguraEcommerce" : 40,
  "pesoEcommerce" : 150,
  "nome" : "Paracetamol 750mg",
  "codigoClassificacao" : 50,
  "integracaoEcommerce" : true,
  "nomeCategoria" : "Uso Adulto",
  "tags" : [ "tags", "tags" ],
  "percentualDesconto" : 10.0,
  "nomePrincipioAtivo" : "Paracetamol",
  "percentualDescontoMax" : 15.0,
  "valorVenda" : 19.9,
  "quantidadeEstoque" : 100,
  "codClaFiscal" : "1234.56.78"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Produtos movimentados retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de produtos movimentados.

get /integracao/produto/principio-ativo/obter-alterados-v1

Lista princípios ativos de produtos alterados (obterTiposProdutosAlteradosV1)

Retorna princípios ativos de produtos alterados no período especificado.

Query parameters

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

dataInicial (required)

Query Parameter — Informar data em formato ISO 8601. format: date-time

dataFinal (required)

Query Parameter — Informar data em formato ISO 8601. format: date-time

Return type

array[PrincipioAtivoProdutoIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "ativo" : true,
  "codigo" : "06827",
  "nome" : "Paracetamol"
}, {
  "ativo" : true,
  "codigo" : "06827",
  "nome" : "Paracetamol"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Princípios ativos de produtos alterados retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de princípios ativos de produtos alterados.

get /integracao/produto/principio-ativo/obter-movimentados-v1

Lista princípios ativos de produtos movimentados (obterTiposProdutosMovimentadosV1)

Retorna princípios ativos de produtos movimentados no período especificado.

Query parameters

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

dataInicial (required)

Query Parameter — Informar data em formato ISO 8601. format: date-time

dataFinal (required)

Query Parameter — Informar data em formato ISO 8601. format: date-time

Return type

array[PrincipioAtivoProdutoIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "ativo" : true,
  "codigo" : "06827",
  "nome" : "Paracetamol"
}, {
  "ativo" : true,
  "codigo" : "06827",
  "nome" : "Paracetamol"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Princípios ativos de produtos movimentados retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de princípios ativos de produtos movimentados.

get /integracao/produto/identificador/obter-todos-v1

Lista identificadores de produtos (obterTodosIdentificadoresProdutosV1)

Retorna identificadores de produtos com paginação.

Query parameters

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[IdentificadorProdutoIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "principal" : true,
  "ativo" : true,
  "codigo" : 12345,
  "identificador" : 7891234567890
}, {
  "principal" : true,
  "ativo" : true,
  "codigo" : 12345,
  "identificador" : 7891234567890
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Identificadores de produtos retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de identificadores de produtos.

get /integracao/produto/principio-ativo/obter-todos-v1

Lista princípios ativos de produtos (obterTodosTiposProdutosV1)

Retorna princípios ativos de produtos com paginação.

Query parameters

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[PrincipioAtivoProdutoIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "ativo" : true,
  "codigo" : "06827",
  "nome" : "Paracetamol"
}, {
  "ativo" : true,
  "codigo" : "06827",
  "nome" : "Paracetamol"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Princípios ativos de produtos retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de princípios ativos de produtos.

get /integracao/produto/obter-todos-v1

Lista todos os produtos (obterTodosV13)

Retorna produtos com paginação.

Query parameters

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[ProdutoIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "corEcommerce" : {
    "codigo" : 10,
    "nome" : "Azul"
  },
  "valorVendaEcommerce" : 21.9,
  "ativo" : true,
  "tipo" : {
    "codigo" : 1,
    "nome" : "Medicamento"
  },
  "nomeDepartamento" : "Medicamentos",
  "codigoPrincipioAtivo" : "PARA",
  "codDepto" : 20,
  "unidade" : "UN",
  "nomeClassificacao" : "Tarja Amarela",
  "tipoLista" : "PADRAO",
  "nomeEcommerce" : "Paracetamol 750mg - 20 comprimidos",
  "nomeLaboratorio" : "Laboratorio Exemplo",
  "valorCusto" : 12.5,
  "idProduto" : "SKU-000123",
  "codTipo" : 1,
  "nomeGrupo" : "Analgesicos",
  "qtdLimiteCarrinhoEcommerce" : 5,
  "codigoGrupo" : 30,
  "profundidadeEcommerce" : 20,
  "valorCustoMedio" : 13.1,
  "alturaEcommerce" : 120,
  "codigoBarras" : 7891234567890,
  "nomDepto" : "Medicamentos",
  "codigoLaboratorio" : 101,
  "nomTipo" : "Medicamento",
  "observacaoVenda" : "Produto nao fracionavel.",
  "produtoManipulado" : "N",
  "codigo" : 12345,
  "codigoDepartamento" : 20,
  "tamanhoEcommerce" : {
    "codigo" : 5,
    "nome" : "M"
  },
  "quantidadeEstoqueEcommerce" : 50,
  "codigoCategoria" : 40,
  "descricaoEcommerce" : "Analgesico indicado para dores e febre.",
  "larguraEcommerce" : 40,
  "pesoEcommerce" : 150,
  "nome" : "Paracetamol 750mg",
  "codigoClassificacao" : 50,
  "integracaoEcommerce" : true,
  "nomeCategoria" : "Uso Adulto",
  "tags" : [ "tags", "tags" ],
  "percentualDesconto" : 10.0,
  "nomePrincipioAtivo" : "Paracetamol",
  "percentualDescontoMax" : 15.0,
  "valorVenda" : 19.9,
  "quantidadeEstoque" : 100,
  "codClaFiscal" : "1234.56.78"
}, {
  "corEcommerce" : {
    "codigo" : 10,
    "nome" : "Azul"
  },
  "valorVendaEcommerce" : 21.9,
  "ativo" : true,
  "tipo" : {
    "codigo" : 1,
    "nome" : "Medicamento"
  },
  "nomeDepartamento" : "Medicamentos",
  "codigoPrincipioAtivo" : "PARA",
  "codDepto" : 20,
  "unidade" : "UN",
  "nomeClassificacao" : "Tarja Amarela",
  "tipoLista" : "PADRAO",
  "nomeEcommerce" : "Paracetamol 750mg - 20 comprimidos",
  "nomeLaboratorio" : "Laboratorio Exemplo",
  "valorCusto" : 12.5,
  "idProduto" : "SKU-000123",
  "codTipo" : 1,
  "nomeGrupo" : "Analgesicos",
  "qtdLimiteCarrinhoEcommerce" : 5,
  "codigoGrupo" : 30,
  "profundidadeEcommerce" : 20,
  "valorCustoMedio" : 13.1,
  "alturaEcommerce" : 120,
  "codigoBarras" : 7891234567890,
  "nomDepto" : "Medicamentos",
  "codigoLaboratorio" : 101,
  "nomTipo" : "Medicamento",
  "observacaoVenda" : "Produto nao fracionavel.",
  "produtoManipulado" : "N",
  "codigo" : 12345,
  "codigoDepartamento" : 20,
  "tamanhoEcommerce" : {
    "codigo" : 5,
    "nome" : "M"
  },
  "quantidadeEstoqueEcommerce" : 50,
  "codigoCategoria" : 40,
  "descricaoEcommerce" : "Analgesico indicado para dores e febre.",
  "larguraEcommerce" : 40,
  "pesoEcommerce" : 150,
  "nome" : "Paracetamol 750mg",
  "codigoClassificacao" : 50,
  "integracaoEcommerce" : true,
  "nomeCategoria" : "Uso Adulto",
  "tags" : [ "tags", "tags" ],
  "percentualDesconto" : 10.0,
  "nomePrincipioAtivo" : "Paracetamol",
  "percentualDescontoMax" : 15.0,
  "valorVenda" : 19.9,
  "quantidadeEstoque" : 100,
  "codClaFiscal" : "1234.56.78"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Produtos retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de produtos.

Smartped

get /integracao/smartped/obter-todos-v1

Lista todas as movimentações do Smartped (obterMovimentacaoSmartpedTodosV1)

Retorna a lista de movimentações do Smartped com paginação.

Query parameters

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[RetornoConsultaSmartpedDTO]

Example data

Content-Type: application/json

[ {
  "datCotacao" : "2000-01-23T04:56:07.000+00:00",
  "cnpjLoja" : "12345678000199",
  "tipCotacao" : "SMARTPED",
  "codigoLoja" : 1,
  "razaoSocial" : "LOJA EXEMPLO LTDA"
}, {
  "datCotacao" : "2000-01-23T04:56:07.000+00:00",
  "cnpjLoja" : "12345678000199",
  "tipCotacao" : "SMARTPED",
  "codigoLoja" : 1,
  "razaoSocial" : "LOJA EXEMPLO LTDA"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Movimentações retornadas com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de movimentações do Smartped.

get /integracao/smartped/obter-v1

Obtém movimentações do Smartped (obterMovimentacaoSmartpedV1)

Consulta movimentações do Smartped com filtros opcionais e paginação.

Query parameters

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[RetornoConsultaSmartpedDTO]

Example data

Content-Type: application/json

[ {
  "datCotacao" : "2000-01-23T04:56:07.000+00:00",
  "cnpjLoja" : "12345678000199",
  "tipCotacao" : "SMARTPED",
  "codigoLoja" : 1,
  "razaoSocial" : "LOJA EXEMPLO LTDA"
}, {
  "datCotacao" : "2000-01-23T04:56:07.000+00:00",
  "cnpjLoja" : "12345678000199",
  "tipCotacao" : "SMARTPED",
  "codigoLoja" : 1,
  "razaoSocial" : "LOJA EXEMPLO LTDA"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Movimentações retornadas com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de movimentações do Smartped.

Venda

get /integracao/venda/cancelamento/obter-alterados-v1

Lista cancelamentos de venda alterados (obterCancelamentosAlteradosV1)

Retorna lista de cancelamentos de venda alterados no período especificado.

Query parameters

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

dataInicial (required)

Query Parameter — Data inicial em formato ISO 8601. format: date-time

dataFinal (required)

Query Parameter — Data final em formato ISO 8601. format: date-time

Return type

array[VendaIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "numeroNotaOrigem" : 123000,
  "xmlNfe" : "...",
  "itens" : [ {
    "vlrCustoProduto" : 75.12,
    "tabelaDesconto" : "PROMO_VERAO",
    "prcDescontoMax" : 15.0,
    "vendaComDesconto" : 189.5678,
    "vlrCustoAquisicao" : 75.1234,
    "parceiro" : false,
    "codigoMedico" : 321,
    "quantidadeProdutos" : 2,
    "prcComissao" : 5.0,
    "vlrDesconto" : 10.0,
    "prcDesconto" : 10.0,
    "valorTotalLiquido" : 189.9,
    "valorTotalCusto" : 150.0,
    "numSequencial" : 1,
    "codigoProduto" : 12345,
    "vlrUnitario" : 99.95,
    "codBarras" : 7894900011517,
    "valorTotalBruto" : 199.9,
    "codigoVendedor" : 789,
    "idVenda" : "9f6d5c0b2a3e4d1f8c7b6a5e4d3c2b1a"
  }, {
    "vlrCustoProduto" : 75.12,
    "tabelaDesconto" : "PROMO_VERAO",
    "prcDescontoMax" : 15.0,
    "vendaComDesconto" : 189.5678,
    "vlrCustoAquisicao" : 75.1234,
    "parceiro" : false,
    "codigoMedico" : 321,
    "quantidadeProdutos" : 2,
    "prcComissao" : 5.0,
    "vlrDesconto" : 10.0,
    "prcDesconto" : 10.0,
    "valorTotalLiquido" : 189.9,
    "valorTotalCusto" : 150.0,
    "numSequencial" : 1,
    "codigoProduto" : 12345,
    "vlrUnitario" : 99.95,
    "codBarras" : 7894900011517,
    "valorTotalBruto" : 199.9,
    "codigoVendedor" : 789,
    "idVenda" : "9f6d5c0b2a3e4d1f8c7b6a5e4d3c2b1a"
  } ],
  "dadosEntrega" : {
    "fone" : "fone",
    "uf" : "uf",
    "cidade" : "cidade",
    "complemento" : "complemento",
    "endereco" : "endereco",
    "numero" : "numero",
    "identificacao" : "identificacao",
    "bairro" : "bairro",
    "nome" : "nome",
    "itinerario" : "itinerario",
    "cep" : "cep"
  },
  "pagamentoNaEntrega" : true,
  "serNotaFiscal" : "1",
  "vlrTroco" : 5.5,
  "condicaoPagamento" : {
    "codigo" : 30,
    "nome" : "30 dias"
  },
  "dataEmissao" : "2000-01-23T04:56:07.000+00:00",
  "horaEmissao" : "2000-01-23T04:56:07.000+00:00",
  "vendaIfood" : false,
  "codParceiro" : 1001,
  "vendaEcommerce" : "S",
  "numeroCupomFiscal" : 987654,
  "numeroNotaFiscal" : 7654321,
  "codFilial" : 1,
  "modeloVenda" : "55",
  "tipoCancelamento" : "D",
  "codigoCliente" : 456,
  "entrega" : true,
  "codEcommerce" : 5555,
  "numeroNota" : 123456,
  "codigoVendedor" : 789
}, {
  "numeroNotaOrigem" : 123000,
  "xmlNfe" : "...",
  "itens" : [ {
    "vlrCustoProduto" : 75.12,
    "tabelaDesconto" : "PROMO_VERAO",
    "prcDescontoMax" : 15.0,
    "vendaComDesconto" : 189.5678,
    "vlrCustoAquisicao" : 75.1234,
    "parceiro" : false,
    "codigoMedico" : 321,
    "quantidadeProdutos" : 2,
    "prcComissao" : 5.0,
    "vlrDesconto" : 10.0,
    "prcDesconto" : 10.0,
    "valorTotalLiquido" : 189.9,
    "valorTotalCusto" : 150.0,
    "numSequencial" : 1,
    "codigoProduto" : 12345,
    "vlrUnitario" : 99.95,
    "codBarras" : 7894900011517,
    "valorTotalBruto" : 199.9,
    "codigoVendedor" : 789,
    "idVenda" : "9f6d5c0b2a3e4d1f8c7b6a5e4d3c2b1a"
  }, {
    "vlrCustoProduto" : 75.12,
    "tabelaDesconto" : "PROMO_VERAO",
    "prcDescontoMax" : 15.0,
    "vendaComDesconto" : 189.5678,
    "vlrCustoAquisicao" : 75.1234,
    "parceiro" : false,
    "codigoMedico" : 321,
    "quantidadeProdutos" : 2,
    "prcComissao" : 5.0,
    "vlrDesconto" : 10.0,
    "prcDesconto" : 10.0,
    "valorTotalLiquido" : 189.9,
    "valorTotalCusto" : 150.0,
    "numSequencial" : 1,
    "codigoProduto" : 12345,
    "vlrUnitario" : 99.95,
    "codBarras" : 7894900011517,
    "valorTotalBruto" : 199.9,
    "codigoVendedor" : 789,
    "idVenda" : "9f6d5c0b2a3e4d1f8c7b6a5e4d3c2b1a"
  } ],
  "dadosEntrega" : {
    "fone" : "fone",
    "uf" : "uf",
    "cidade" : "cidade",
    "complemento" : "complemento",
    "endereco" : "endereco",
    "numero" : "numero",
    "identificacao" : "identificacao",
    "bairro" : "bairro",
    "nome" : "nome",
    "itinerario" : "itinerario",
    "cep" : "cep"
  },
  "pagamentoNaEntrega" : true,
  "serNotaFiscal" : "1",
  "vlrTroco" : 5.5,
  "condicaoPagamento" : {
    "codigo" : 30,
    "nome" : "30 dias"
  },
  "dataEmissao" : "2000-01-23T04:56:07.000+00:00",
  "horaEmissao" : "2000-01-23T04:56:07.000+00:00",
  "vendaIfood" : false,
  "codParceiro" : 1001,
  "vendaEcommerce" : "S",
  "numeroCupomFiscal" : 987654,
  "numeroNotaFiscal" : 7654321,
  "codFilial" : 1,
  "modeloVenda" : "55",
  "tipoCancelamento" : "D",
  "codigoCliente" : 456,
  "entrega" : true,
  "codEcommerce" : 5555,
  "numeroNota" : 123456,
  "codigoVendedor" : 789
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Cancelamentos de venda alterados retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de cancelamentos de venda alterados.

get /integracao/venda/cancelamento/obter-v1

Lista cancelamentos de venda com filtros (obterCancelamentosAvancadoV1)

Consulta a lista de cancelamentos de venda com filtros opcionais e paginação.

Query parameters

numeroNota (optional)

Query Parameter — Número da nota fiscal. Aceita múltiplos valores. format: int64

codigoCliente (optional)

Query Parameter — Código do cliente. Aceita múltiplos valores. format: int64

dataEmissaoInicial (optional)

Query Parameter — Data de emissão inicial em formato ISO 8601. format: date-time

dataEmissaoFinal (optional)

Query Parameter — Data de emissão final em formato ISO 8601. format: date-time

xmlNfe (optional)

Query Parameter — Quando true, retorna informações com referência ao XML da NF-e.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[VendaIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "numeroNotaOrigem" : 123000,
  "xmlNfe" : "...",
  "itens" : [ {
    "vlrCustoProduto" : 75.12,
    "tabelaDesconto" : "PROMO_VERAO",
    "prcDescontoMax" : 15.0,
    "vendaComDesconto" : 189.5678,
    "vlrCustoAquisicao" : 75.1234,
    "parceiro" : false,
    "codigoMedico" : 321,
    "quantidadeProdutos" : 2,
    "prcComissao" : 5.0,
    "vlrDesconto" : 10.0,
    "prcDesconto" : 10.0,
    "valorTotalLiquido" : 189.9,
    "valorTotalCusto" : 150.0,
    "numSequencial" : 1,
    "codigoProduto" : 12345,
    "vlrUnitario" : 99.95,
    "codBarras" : 7894900011517,
    "valorTotalBruto" : 199.9,
    "codigoVendedor" : 789,
    "idVenda" : "9f6d5c0b2a3e4d1f8c7b6a5e4d3c2b1a"
  }, {
    "vlrCustoProduto" : 75.12,
    "tabelaDesconto" : "PROMO_VERAO",
    "prcDescontoMax" : 15.0,
    "vendaComDesconto" : 189.5678,
    "vlrCustoAquisicao" : 75.1234,
    "parceiro" : false,
    "codigoMedico" : 321,
    "quantidadeProdutos" : 2,
    "prcComissao" : 5.0,
    "vlrDesconto" : 10.0,
    "prcDesconto" : 10.0,
    "valorTotalLiquido" : 189.9,
    "valorTotalCusto" : 150.0,
    "numSequencial" : 1,
    "codigoProduto" : 12345,
    "vlrUnitario" : 99.95,
    "codBarras" : 7894900011517,
    "valorTotalBruto" : 199.9,
    "codigoVendedor" : 789,
    "idVenda" : "9f6d5c0b2a3e4d1f8c7b6a5e4d3c2b1a"
  } ],
  "dadosEntrega" : {
    "fone" : "fone",
    "uf" : "uf",
    "cidade" : "cidade",
    "complemento" : "complemento",
    "endereco" : "endereco",
    "numero" : "numero",
    "identificacao" : "identificacao",
    "bairro" : "bairro",
    "nome" : "nome",
    "itinerario" : "itinerario",
    "cep" : "cep"
  },
  "pagamentoNaEntrega" : true,
  "serNotaFiscal" : "1",
  "vlrTroco" : 5.5,
  "condicaoPagamento" : {
    "codigo" : 30,
    "nome" : "30 dias"
  },
  "dataEmissao" : "2000-01-23T04:56:07.000+00:00",
  "horaEmissao" : "2000-01-23T04:56:07.000+00:00",
  "vendaIfood" : false,
  "codParceiro" : 1001,
  "vendaEcommerce" : "S",
  "numeroCupomFiscal" : 987654,
  "numeroNotaFiscal" : 7654321,
  "codFilial" : 1,
  "modeloVenda" : "55",
  "tipoCancelamento" : "D",
  "codigoCliente" : 456,
  "entrega" : true,
  "codEcommerce" : 5555,
  "numeroNota" : 123456,
  "codigoVendedor" : 789
}, {
  "numeroNotaOrigem" : 123000,
  "xmlNfe" : "...",
  "itens" : [ {
    "vlrCustoProduto" : 75.12,
    "tabelaDesconto" : "PROMO_VERAO",
    "prcDescontoMax" : 15.0,
    "vendaComDesconto" : 189.5678,
    "vlrCustoAquisicao" : 75.1234,
    "parceiro" : false,
    "codigoMedico" : 321,
    "quantidadeProdutos" : 2,
    "prcComissao" : 5.0,
    "vlrDesconto" : 10.0,
    "prcDesconto" : 10.0,
    "valorTotalLiquido" : 189.9,
    "valorTotalCusto" : 150.0,
    "numSequencial" : 1,
    "codigoProduto" : 12345,
    "vlrUnitario" : 99.95,
    "codBarras" : 7894900011517,
    "valorTotalBruto" : 199.9,
    "codigoVendedor" : 789,
    "idVenda" : "9f6d5c0b2a3e4d1f8c7b6a5e4d3c2b1a"
  }, {
    "vlrCustoProduto" : 75.12,
    "tabelaDesconto" : "PROMO_VERAO",
    "prcDescontoMax" : 15.0,
    "vendaComDesconto" : 189.5678,
    "vlrCustoAquisicao" : 75.1234,
    "parceiro" : false,
    "codigoMedico" : 321,
    "quantidadeProdutos" : 2,
    "prcComissao" : 5.0,
    "vlrDesconto" : 10.0,
    "prcDesconto" : 10.0,
    "valorTotalLiquido" : 189.9,
    "valorTotalCusto" : 150.0,
    "numSequencial" : 1,
    "codigoProduto" : 12345,
    "vlrUnitario" : 99.95,
    "codBarras" : 7894900011517,
    "valorTotalBruto" : 199.9,
    "codigoVendedor" : 789,
    "idVenda" : "9f6d5c0b2a3e4d1f8c7b6a5e4d3c2b1a"
  } ],
  "dadosEntrega" : {
    "fone" : "fone",
    "uf" : "uf",
    "cidade" : "cidade",
    "complemento" : "complemento",
    "endereco" : "endereco",
    "numero" : "numero",
    "identificacao" : "identificacao",
    "bairro" : "bairro",
    "nome" : "nome",
    "itinerario" : "itinerario",
    "cep" : "cep"
  },
  "pagamentoNaEntrega" : true,
  "serNotaFiscal" : "1",
  "vlrTroco" : 5.5,
  "condicaoPagamento" : {
    "codigo" : 30,
    "nome" : "30 dias"
  },
  "dataEmissao" : "2000-01-23T04:56:07.000+00:00",
  "horaEmissao" : "2000-01-23T04:56:07.000+00:00",
  "vendaIfood" : false,
  "codParceiro" : 1001,
  "vendaEcommerce" : "S",
  "numeroCupomFiscal" : 987654,
  "numeroNotaFiscal" : 7654321,
  "codFilial" : 1,
  "modeloVenda" : "55",
  "tipoCancelamento" : "D",
  "codigoCliente" : 456,
  "entrega" : true,
  "codEcommerce" : 5555,
  "numeroNota" : 123456,
  "codigoVendedor" : 789
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Cancelamentos de venda retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de cancelamentos de venda.

get /integracao/venda/cancelamento/obter-todos-v1

Lista todos os cancelamentos de venda (obterCancelamentosSimplesV1)

Retorna a lista de cancelamentos de venda com paginação.

Query parameters

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[VendaIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "numeroNotaOrigem" : 123000,
  "xmlNfe" : "...",
  "itens" : [ {
    "vlrCustoProduto" : 75.12,
    "tabelaDesconto" : "PROMO_VERAO",
    "prcDescontoMax" : 15.0,
    "vendaComDesconto" : 189.5678,
    "vlrCustoAquisicao" : 75.1234,
    "parceiro" : false,
    "codigoMedico" : 321,
    "quantidadeProdutos" : 2,
    "prcComissao" : 5.0,
    "vlrDesconto" : 10.0,
    "prcDesconto" : 10.0,
    "valorTotalLiquido" : 189.9,
    "valorTotalCusto" : 150.0,
    "numSequencial" : 1,
    "codigoProduto" : 12345,
    "vlrUnitario" : 99.95,
    "codBarras" : 7894900011517,
    "valorTotalBruto" : 199.9,
    "codigoVendedor" : 789,
    "idVenda" : "9f6d5c0b2a3e4d1f8c7b6a5e4d3c2b1a"
  }, {
    "vlrCustoProduto" : 75.12,
    "tabelaDesconto" : "PROMO_VERAO",
    "prcDescontoMax" : 15.0,
    "vendaComDesconto" : 189.5678,
    "vlrCustoAquisicao" : 75.1234,
    "parceiro" : false,
    "codigoMedico" : 321,
    "quantidadeProdutos" : 2,
    "prcComissao" : 5.0,
    "vlrDesconto" : 10.0,
    "prcDesconto" : 10.0,
    "valorTotalLiquido" : 189.9,
    "valorTotalCusto" : 150.0,
    "numSequencial" : 1,
    "codigoProduto" : 12345,
    "vlrUnitario" : 99.95,
    "codBarras" : 7894900011517,
    "valorTotalBruto" : 199.9,
    "codigoVendedor" : 789,
    "idVenda" : "9f6d5c0b2a3e4d1f8c7b6a5e4d3c2b1a"
  } ],
  "dadosEntrega" : {
    "fone" : "fone",
    "uf" : "uf",
    "cidade" : "cidade",
    "complemento" : "complemento",
    "endereco" : "endereco",
    "numero" : "numero",
    "identificacao" : "identificacao",
    "bairro" : "bairro",
    "nome" : "nome",
    "itinerario" : "itinerario",
    "cep" : "cep"
  },
  "pagamentoNaEntrega" : true,
  "serNotaFiscal" : "1",
  "vlrTroco" : 5.5,
  "condicaoPagamento" : {
    "codigo" : 30,
    "nome" : "30 dias"
  },
  "dataEmissao" : "2000-01-23T04:56:07.000+00:00",
  "horaEmissao" : "2000-01-23T04:56:07.000+00:00",
  "vendaIfood" : false,
  "codParceiro" : 1001,
  "vendaEcommerce" : "S",
  "numeroCupomFiscal" : 987654,
  "numeroNotaFiscal" : 7654321,
  "codFilial" : 1,
  "modeloVenda" : "55",
  "tipoCancelamento" : "D",
  "codigoCliente" : 456,
  "entrega" : true,
  "codEcommerce" : 5555,
  "numeroNota" : 123456,
  "codigoVendedor" : 789
}, {
  "numeroNotaOrigem" : 123000,
  "xmlNfe" : "...",
  "itens" : [ {
    "vlrCustoProduto" : 75.12,
    "tabelaDesconto" : "PROMO_VERAO",
    "prcDescontoMax" : 15.0,
    "vendaComDesconto" : 189.5678,
    "vlrCustoAquisicao" : 75.1234,
    "parceiro" : false,
    "codigoMedico" : 321,
    "quantidadeProdutos" : 2,
    "prcComissao" : 5.0,
    "vlrDesconto" : 10.0,
    "prcDesconto" : 10.0,
    "valorTotalLiquido" : 189.9,
    "valorTotalCusto" : 150.0,
    "numSequencial" : 1,
    "codigoProduto" : 12345,
    "vlrUnitario" : 99.95,
    "codBarras" : 7894900011517,
    "valorTotalBruto" : 199.9,
    "codigoVendedor" : 789,
    "idVenda" : "9f6d5c0b2a3e4d1f8c7b6a5e4d3c2b1a"
  }, {
    "vlrCustoProduto" : 75.12,
    "tabelaDesconto" : "PROMO_VERAO",
    "prcDescontoMax" : 15.0,
    "vendaComDesconto" : 189.5678,
    "vlrCustoAquisicao" : 75.1234,
    "parceiro" : false,
    "codigoMedico" : 321,
    "quantidadeProdutos" : 2,
    "prcComissao" : 5.0,
    "vlrDesconto" : 10.0,
    "prcDesconto" : 10.0,
    "valorTotalLiquido" : 189.9,
    "valorTotalCusto" : 150.0,
    "numSequencial" : 1,
    "codigoProduto" : 12345,
    "vlrUnitario" : 99.95,
    "codBarras" : 7894900011517,
    "valorTotalBruto" : 199.9,
    "codigoVendedor" : 789,
    "idVenda" : "9f6d5c0b2a3e4d1f8c7b6a5e4d3c2b1a"
  } ],
  "dadosEntrega" : {
    "fone" : "fone",
    "uf" : "uf",
    "cidade" : "cidade",
    "complemento" : "complemento",
    "endereco" : "endereco",
    "numero" : "numero",
    "identificacao" : "identificacao",
    "bairro" : "bairro",
    "nome" : "nome",
    "itinerario" : "itinerario",
    "cep" : "cep"
  },
  "pagamentoNaEntrega" : true,
  "serNotaFiscal" : "1",
  "vlrTroco" : 5.5,
  "condicaoPagamento" : {
    "codigo" : 30,
    "nome" : "30 dias"
  },
  "dataEmissao" : "2000-01-23T04:56:07.000+00:00",
  "horaEmissao" : "2000-01-23T04:56:07.000+00:00",
  "vendaIfood" : false,
  "codParceiro" : 1001,
  "vendaEcommerce" : "S",
  "numeroCupomFiscal" : 987654,
  "numeroNotaFiscal" : 7654321,
  "codFilial" : 1,
  "modeloVenda" : "55",
  "tipoCancelamento" : "D",
  "codigoCliente" : 456,
  "entrega" : true,
  "codEcommerce" : 5555,
  "numeroNota" : 123456,
  "codigoVendedor" : 789
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Cancelamentos de venda retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de cancelamentos de venda.

get /integracao/venda/obter-alterados-v1

Lista vendas alteradas (obterVendasAlteradasV1)

Retorna lista de vendas alteradas no período especificado.

Query parameters

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

dataInicial (required)

Query Parameter — Data inicial em formato ISO 8601. format: date-time

dataFinal (required)

Query Parameter — Data final em formato ISO 8601. format: date-time

Return type

array[VendaIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "numeroNotaOrigem" : 123000,
  "xmlNfe" : "...",
  "itens" : [ {
    "vlrCustoProduto" : 75.12,
    "tabelaDesconto" : "PROMO_VERAO",
    "prcDescontoMax" : 15.0,
    "vendaComDesconto" : 189.5678,
    "vlrCustoAquisicao" : 75.1234,
    "parceiro" : false,
    "codigoMedico" : 321,
    "quantidadeProdutos" : 2,
    "prcComissao" : 5.0,
    "vlrDesconto" : 10.0,
    "prcDesconto" : 10.0,
    "valorTotalLiquido" : 189.9,
    "valorTotalCusto" : 150.0,
    "numSequencial" : 1,
    "codigoProduto" : 12345,
    "vlrUnitario" : 99.95,
    "codBarras" : 7894900011517,
    "valorTotalBruto" : 199.9,
    "codigoVendedor" : 789,
    "idVenda" : "9f6d5c0b2a3e4d1f8c7b6a5e4d3c2b1a"
  }, {
    "vlrCustoProduto" : 75.12,
    "tabelaDesconto" : "PROMO_VERAO",
    "prcDescontoMax" : 15.0,
    "vendaComDesconto" : 189.5678,
    "vlrCustoAquisicao" : 75.1234,
    "parceiro" : false,
    "codigoMedico" : 321,
    "quantidadeProdutos" : 2,
    "prcComissao" : 5.0,
    "vlrDesconto" : 10.0,
    "prcDesconto" : 10.0,
    "valorTotalLiquido" : 189.9,
    "valorTotalCusto" : 150.0,
    "numSequencial" : 1,
    "codigoProduto" : 12345,
    "vlrUnitario" : 99.95,
    "codBarras" : 7894900011517,
    "valorTotalBruto" : 199.9,
    "codigoVendedor" : 789,
    "idVenda" : "9f6d5c0b2a3e4d1f8c7b6a5e4d3c2b1a"
  } ],
  "dadosEntrega" : {
    "fone" : "fone",
    "uf" : "uf",
    "cidade" : "cidade",
    "complemento" : "complemento",
    "endereco" : "endereco",
    "numero" : "numero",
    "identificacao" : "identificacao",
    "bairro" : "bairro",
    "nome" : "nome",
    "itinerario" : "itinerario",
    "cep" : "cep"
  },
  "pagamentoNaEntrega" : true,
  "serNotaFiscal" : "1",
  "vlrTroco" : 5.5,
  "condicaoPagamento" : {
    "codigo" : 30,
    "nome" : "30 dias"
  },
  "dataEmissao" : "2000-01-23T04:56:07.000+00:00",
  "horaEmissao" : "2000-01-23T04:56:07.000+00:00",
  "vendaIfood" : false,
  "codParceiro" : 1001,
  "vendaEcommerce" : "S",
  "numeroCupomFiscal" : 987654,
  "numeroNotaFiscal" : 7654321,
  "codFilial" : 1,
  "modeloVenda" : "55",
  "tipoCancelamento" : "D",
  "codigoCliente" : 456,
  "entrega" : true,
  "codEcommerce" : 5555,
  "numeroNota" : 123456,
  "codigoVendedor" : 789
}, {
  "numeroNotaOrigem" : 123000,
  "xmlNfe" : "...",
  "itens" : [ {
    "vlrCustoProduto" : 75.12,
    "tabelaDesconto" : "PROMO_VERAO",
    "prcDescontoMax" : 15.0,
    "vendaComDesconto" : 189.5678,
    "vlrCustoAquisicao" : 75.1234,
    "parceiro" : false,
    "codigoMedico" : 321,
    "quantidadeProdutos" : 2,
    "prcComissao" : 5.0,
    "vlrDesconto" : 10.0,
    "prcDesconto" : 10.0,
    "valorTotalLiquido" : 189.9,
    "valorTotalCusto" : 150.0,
    "numSequencial" : 1,
    "codigoProduto" : 12345,
    "vlrUnitario" : 99.95,
    "codBarras" : 7894900011517,
    "valorTotalBruto" : 199.9,
    "codigoVendedor" : 789,
    "idVenda" : "9f6d5c0b2a3e4d1f8c7b6a5e4d3c2b1a"
  }, {
    "vlrCustoProduto" : 75.12,
    "tabelaDesconto" : "PROMO_VERAO",
    "prcDescontoMax" : 15.0,
    "vendaComDesconto" : 189.5678,
    "vlrCustoAquisicao" : 75.1234,
    "parceiro" : false,
    "codigoMedico" : 321,
    "quantidadeProdutos" : 2,
    "prcComissao" : 5.0,
    "vlrDesconto" : 10.0,
    "prcDesconto" : 10.0,
    "valorTotalLiquido" : 189.9,
    "valorTotalCusto" : 150.0,
    "numSequencial" : 1,
    "codigoProduto" : 12345,
    "vlrUnitario" : 99.95,
    "codBarras" : 7894900011517,
    "valorTotalBruto" : 199.9,
    "codigoVendedor" : 789,
    "idVenda" : "9f6d5c0b2a3e4d1f8c7b6a5e4d3c2b1a"
  } ],
  "dadosEntrega" : {
    "fone" : "fone",
    "uf" : "uf",
    "cidade" : "cidade",
    "complemento" : "complemento",
    "endereco" : "endereco",
    "numero" : "numero",
    "identificacao" : "identificacao",
    "bairro" : "bairro",
    "nome" : "nome",
    "itinerario" : "itinerario",
    "cep" : "cep"
  },
  "pagamentoNaEntrega" : true,
  "serNotaFiscal" : "1",
  "vlrTroco" : 5.5,
  "condicaoPagamento" : {
    "codigo" : 30,
    "nome" : "30 dias"
  },
  "dataEmissao" : "2000-01-23T04:56:07.000+00:00",
  "horaEmissao" : "2000-01-23T04:56:07.000+00:00",
  "vendaIfood" : false,
  "codParceiro" : 1001,
  "vendaEcommerce" : "S",
  "numeroCupomFiscal" : 987654,
  "numeroNotaFiscal" : 7654321,
  "codFilial" : 1,
  "modeloVenda" : "55",
  "tipoCancelamento" : "D",
  "codigoCliente" : 456,
  "entrega" : true,
  "codEcommerce" : 5555,
  "numeroNota" : 123456,
  "codigoVendedor" : 789
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Vendas alteradas retornadas com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de vendas alteradas.

get /integracao/venda/obter-v1

Lista vendas com filtros (obterVendasAvancadoV1)

Consulta a lista de vendas com filtros opcionais e paginação.

Query parameters

numeroNota (optional)

Query Parameter — Número da nota fiscal. Aceita múltiplos valores. format: int64

codigoCliente (optional)

Query Parameter — Código do cliente. Aceita múltiplos valores. format: int64

dataEmissaoInicial (optional)

Query Parameter — Data de emissão inicial em formato ISO 8601. format: date-time

dataEmissaoFinal (optional)

Query Parameter — Data de emissão final em formato ISO 8601. format: date-time

xmlNfe (optional)

Query Parameter — Quando true, retorna informações com referência ao XML da NF-e.

entrega (optional)

Query Parameter — Quando true, filtra vendas de tele entrega.

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[VendaIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "numeroNotaOrigem" : 123000,
  "xmlNfe" : "...",
  "itens" : [ {
    "vlrCustoProduto" : 75.12,
    "tabelaDesconto" : "PROMO_VERAO",
    "prcDescontoMax" : 15.0,
    "vendaComDesconto" : 189.5678,
    "vlrCustoAquisicao" : 75.1234,
    "parceiro" : false,
    "codigoMedico" : 321,
    "quantidadeProdutos" : 2,
    "prcComissao" : 5.0,
    "vlrDesconto" : 10.0,
    "prcDesconto" : 10.0,
    "valorTotalLiquido" : 189.9,
    "valorTotalCusto" : 150.0,
    "numSequencial" : 1,
    "codigoProduto" : 12345,
    "vlrUnitario" : 99.95,
    "codBarras" : 7894900011517,
    "valorTotalBruto" : 199.9,
    "codigoVendedor" : 789,
    "idVenda" : "9f6d5c0b2a3e4d1f8c7b6a5e4d3c2b1a"
  }, {
    "vlrCustoProduto" : 75.12,
    "tabelaDesconto" : "PROMO_VERAO",
    "prcDescontoMax" : 15.0,
    "vendaComDesconto" : 189.5678,
    "vlrCustoAquisicao" : 75.1234,
    "parceiro" : false,
    "codigoMedico" : 321,
    "quantidadeProdutos" : 2,
    "prcComissao" : 5.0,
    "vlrDesconto" : 10.0,
    "prcDesconto" : 10.0,
    "valorTotalLiquido" : 189.9,
    "valorTotalCusto" : 150.0,
    "numSequencial" : 1,
    "codigoProduto" : 12345,
    "vlrUnitario" : 99.95,
    "codBarras" : 7894900011517,
    "valorTotalBruto" : 199.9,
    "codigoVendedor" : 789,
    "idVenda" : "9f6d5c0b2a3e4d1f8c7b6a5e4d3c2b1a"
  } ],
  "dadosEntrega" : {
    "fone" : "fone",
    "uf" : "uf",
    "cidade" : "cidade",
    "complemento" : "complemento",
    "endereco" : "endereco",
    "numero" : "numero",
    "identificacao" : "identificacao",
    "bairro" : "bairro",
    "nome" : "nome",
    "itinerario" : "itinerario",
    "cep" : "cep"
  },
  "pagamentoNaEntrega" : true,
  "serNotaFiscal" : "1",
  "vlrTroco" : 5.5,
  "condicaoPagamento" : {
    "codigo" : 30,
    "nome" : "30 dias"
  },
  "dataEmissao" : "2000-01-23T04:56:07.000+00:00",
  "horaEmissao" : "2000-01-23T04:56:07.000+00:00",
  "vendaIfood" : false,
  "codParceiro" : 1001,
  "vendaEcommerce" : "S",
  "numeroCupomFiscal" : 987654,
  "numeroNotaFiscal" : 7654321,
  "codFilial" : 1,
  "modeloVenda" : "55",
  "tipoCancelamento" : "D",
  "codigoCliente" : 456,
  "entrega" : true,
  "codEcommerce" : 5555,
  "numeroNota" : 123456,
  "codigoVendedor" : 789
}, {
  "numeroNotaOrigem" : 123000,
  "xmlNfe" : "...",
  "itens" : [ {
    "vlrCustoProduto" : 75.12,
    "tabelaDesconto" : "PROMO_VERAO",
    "prcDescontoMax" : 15.0,
    "vendaComDesconto" : 189.5678,
    "vlrCustoAquisicao" : 75.1234,
    "parceiro" : false,
    "codigoMedico" : 321,
    "quantidadeProdutos" : 2,
    "prcComissao" : 5.0,
    "vlrDesconto" : 10.0,
    "prcDesconto" : 10.0,
    "valorTotalLiquido" : 189.9,
    "valorTotalCusto" : 150.0,
    "numSequencial" : 1,
    "codigoProduto" : 12345,
    "vlrUnitario" : 99.95,
    "codBarras" : 7894900011517,
    "valorTotalBruto" : 199.9,
    "codigoVendedor" : 789,
    "idVenda" : "9f6d5c0b2a3e4d1f8c7b6a5e4d3c2b1a"
  }, {
    "vlrCustoProduto" : 75.12,
    "tabelaDesconto" : "PROMO_VERAO",
    "prcDescontoMax" : 15.0,
    "vendaComDesconto" : 189.5678,
    "vlrCustoAquisicao" : 75.1234,
    "parceiro" : false,
    "codigoMedico" : 321,
    "quantidadeProdutos" : 2,
    "prcComissao" : 5.0,
    "vlrDesconto" : 10.0,
    "prcDesconto" : 10.0,
    "valorTotalLiquido" : 189.9,
    "valorTotalCusto" : 150.0,
    "numSequencial" : 1,
    "codigoProduto" : 12345,
    "vlrUnitario" : 99.95,
    "codBarras" : 7894900011517,
    "valorTotalBruto" : 199.9,
    "codigoVendedor" : 789,
    "idVenda" : "9f6d5c0b2a3e4d1f8c7b6a5e4d3c2b1a"
  } ],
  "dadosEntrega" : {
    "fone" : "fone",
    "uf" : "uf",
    "cidade" : "cidade",
    "complemento" : "complemento",
    "endereco" : "endereco",
    "numero" : "numero",
    "identificacao" : "identificacao",
    "bairro" : "bairro",
    "nome" : "nome",
    "itinerario" : "itinerario",
    "cep" : "cep"
  },
  "pagamentoNaEntrega" : true,
  "serNotaFiscal" : "1",
  "vlrTroco" : 5.5,
  "condicaoPagamento" : {
    "codigo" : 30,
    "nome" : "30 dias"
  },
  "dataEmissao" : "2000-01-23T04:56:07.000+00:00",
  "horaEmissao" : "2000-01-23T04:56:07.000+00:00",
  "vendaIfood" : false,
  "codParceiro" : 1001,
  "vendaEcommerce" : "S",
  "numeroCupomFiscal" : 987654,
  "numeroNotaFiscal" : 7654321,
  "codFilial" : 1,
  "modeloVenda" : "55",
  "tipoCancelamento" : "D",
  "codigoCliente" : 456,
  "entrega" : true,
  "codEcommerce" : 5555,
  "numeroNota" : 123456,
  "codigoVendedor" : 789
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Vendas retornadas com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de vendas.

get /integracao/venda/obter-todos-v1

Lista todas as vendas (obterVendasSimplesV1)

Retorna a lista de vendas com paginação.

Query parameters

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[VendaIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "numeroNotaOrigem" : 123000,
  "xmlNfe" : "...",
  "itens" : [ {
    "vlrCustoProduto" : 75.12,
    "tabelaDesconto" : "PROMO_VERAO",
    "prcDescontoMax" : 15.0,
    "vendaComDesconto" : 189.5678,
    "vlrCustoAquisicao" : 75.1234,
    "parceiro" : false,
    "codigoMedico" : 321,
    "quantidadeProdutos" : 2,
    "prcComissao" : 5.0,
    "vlrDesconto" : 10.0,
    "prcDesconto" : 10.0,
    "valorTotalLiquido" : 189.9,
    "valorTotalCusto" : 150.0,
    "numSequencial" : 1,
    "codigoProduto" : 12345,
    "vlrUnitario" : 99.95,
    "codBarras" : 7894900011517,
    "valorTotalBruto" : 199.9,
    "codigoVendedor" : 789,
    "idVenda" : "9f6d5c0b2a3e4d1f8c7b6a5e4d3c2b1a"
  }, {
    "vlrCustoProduto" : 75.12,
    "tabelaDesconto" : "PROMO_VERAO",
    "prcDescontoMax" : 15.0,
    "vendaComDesconto" : 189.5678,
    "vlrCustoAquisicao" : 75.1234,
    "parceiro" : false,
    "codigoMedico" : 321,
    "quantidadeProdutos" : 2,
    "prcComissao" : 5.0,
    "vlrDesconto" : 10.0,
    "prcDesconto" : 10.0,
    "valorTotalLiquido" : 189.9,
    "valorTotalCusto" : 150.0,
    "numSequencial" : 1,
    "codigoProduto" : 12345,
    "vlrUnitario" : 99.95,
    "codBarras" : 7894900011517,
    "valorTotalBruto" : 199.9,
    "codigoVendedor" : 789,
    "idVenda" : "9f6d5c0b2a3e4d1f8c7b6a5e4d3c2b1a"
  } ],
  "dadosEntrega" : {
    "fone" : "fone",
    "uf" : "uf",
    "cidade" : "cidade",
    "complemento" : "complemento",
    "endereco" : "endereco",
    "numero" : "numero",
    "identificacao" : "identificacao",
    "bairro" : "bairro",
    "nome" : "nome",
    "itinerario" : "itinerario",
    "cep" : "cep"
  },
  "pagamentoNaEntrega" : true,
  "serNotaFiscal" : "1",
  "vlrTroco" : 5.5,
  "condicaoPagamento" : {
    "codigo" : 30,
    "nome" : "30 dias"
  },
  "dataEmissao" : "2000-01-23T04:56:07.000+00:00",
  "horaEmissao" : "2000-01-23T04:56:07.000+00:00",
  "vendaIfood" : false,
  "codParceiro" : 1001,
  "vendaEcommerce" : "S",
  "numeroCupomFiscal" : 987654,
  "numeroNotaFiscal" : 7654321,
  "codFilial" : 1,
  "modeloVenda" : "55",
  "tipoCancelamento" : "D",
  "codigoCliente" : 456,
  "entrega" : true,
  "codEcommerce" : 5555,
  "numeroNota" : 123456,
  "codigoVendedor" : 789
}, {
  "numeroNotaOrigem" : 123000,
  "xmlNfe" : "...",
  "itens" : [ {
    "vlrCustoProduto" : 75.12,
    "tabelaDesconto" : "PROMO_VERAO",
    "prcDescontoMax" : 15.0,
    "vendaComDesconto" : 189.5678,
    "vlrCustoAquisicao" : 75.1234,
    "parceiro" : false,
    "codigoMedico" : 321,
    "quantidadeProdutos" : 2,
    "prcComissao" : 5.0,
    "vlrDesconto" : 10.0,
    "prcDesconto" : 10.0,
    "valorTotalLiquido" : 189.9,
    "valorTotalCusto" : 150.0,
    "numSequencial" : 1,
    "codigoProduto" : 12345,
    "vlrUnitario" : 99.95,
    "codBarras" : 7894900011517,
    "valorTotalBruto" : 199.9,
    "codigoVendedor" : 789,
    "idVenda" : "9f6d5c0b2a3e4d1f8c7b6a5e4d3c2b1a"
  }, {
    "vlrCustoProduto" : 75.12,
    "tabelaDesconto" : "PROMO_VERAO",
    "prcDescontoMax" : 15.0,
    "vendaComDesconto" : 189.5678,
    "vlrCustoAquisicao" : 75.1234,
    "parceiro" : false,
    "codigoMedico" : 321,
    "quantidadeProdutos" : 2,
    "prcComissao" : 5.0,
    "vlrDesconto" : 10.0,
    "prcDesconto" : 10.0,
    "valorTotalLiquido" : 189.9,
    "valorTotalCusto" : 150.0,
    "numSequencial" : 1,
    "codigoProduto" : 12345,
    "vlrUnitario" : 99.95,
    "codBarras" : 7894900011517,
    "valorTotalBruto" : 199.9,
    "codigoVendedor" : 789,
    "idVenda" : "9f6d5c0b2a3e4d1f8c7b6a5e4d3c2b1a"
  } ],
  "dadosEntrega" : {
    "fone" : "fone",
    "uf" : "uf",
    "cidade" : "cidade",
    "complemento" : "complemento",
    "endereco" : "endereco",
    "numero" : "numero",
    "identificacao" : "identificacao",
    "bairro" : "bairro",
    "nome" : "nome",
    "itinerario" : "itinerario",
    "cep" : "cep"
  },
  "pagamentoNaEntrega" : true,
  "serNotaFiscal" : "1",
  "vlrTroco" : 5.5,
  "condicaoPagamento" : {
    "codigo" : 30,
    "nome" : "30 dias"
  },
  "dataEmissao" : "2000-01-23T04:56:07.000+00:00",
  "horaEmissao" : "2000-01-23T04:56:07.000+00:00",
  "vendaIfood" : false,
  "codParceiro" : 1001,
  "vendaEcommerce" : "S",
  "numeroCupomFiscal" : 987654,
  "numeroNotaFiscal" : 7654321,
  "codFilial" : 1,
  "modeloVenda" : "55",
  "tipoCancelamento" : "D",
  "codigoCliente" : 456,
  "entrega" : true,
  "codEcommerce" : 5555,
  "numeroNota" : 123456,
  "codigoVendedor" : 789
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Vendas retornadas com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de vendas.

get /integracao/venda/obter-atendimentos-diario-vendedor-v1

Lista atendimentos diários por vendedor (obterVendasVendedorV1)

Retorna a lista de atendimentos diários por vendedor no período especificado.

Query parameters

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

dataInicial (required)

Query Parameter — Data inicial em formato ISO 8601. format: date-time

dataFinal (required)

Query Parameter — Data final em formato ISO 8601. format: date-time

Return type

array[VendasVendedorIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "quantidadeAtendimentos" : 10,
  "quantidadeItens" : 50,
  "dataEmissao" : "2000-01-23T04:56:07.000+00:00",
  "codigoVendedor" : 789
}, {
  "quantidadeAtendimentos" : 10,
  "quantidadeItens" : 50,
  "dataEmissao" : "2000-01-23T04:56:07.000+00:00",
  "codigoVendedor" : 789
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Atendimentos retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de atendimentos por vendedor.

VendaECommerce

post /integracao/venda/ecommerce/atualizar-status-v1

Atualizar status da venda e-commerce (atualizarStatusPedidoV1)

Atualiza o status de uma venda e-commerce.

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body AtualizaStatusPedidoEcommerceDto (required)

Body Parameter —

Return type

VendaEcommerceIntegracaoRetDto

Example data

Content-Type: application/json

{
  "numeroPedido" : "PED-20240001",
  "statusPedido" : {
    "codigo" : "1",
    "descricao" : "APROVADO"
  },
  "numeroNota" : 12345
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Status atualizado com sucesso. VendaEcommerceIntegracaoRetDto

400

Requisição inválida.

401

Não autorizado.

500

Erro na atualização do status da venda.

get /integracao/venda/ecommerce/consultar-venda-v1

Consultar venda e-commerce (consultarVendaV1)

Consulta vendas do e-commerce por parâmetros.

Query parameters

numeroNota (optional)

Query Parameter — Número da venda gerada no PDV.

numeroPedido (optional)

Query Parameter — Número do pedido no e-commerce vinculado à venda.

numerosPedidos (optional)

Query Parameter — Números dos pedidos no e-commerce vinculado à venda.

limiteMensal (optional)

Query Parameter — Se true, limita a consulta às vendas dos últimos 30 dias.

Return type

StatusVendaEcommerceIntegracaoRetDto

Example data

Content-Type: application/json

{
  "xmlNfe" : "...",
  "numeroCupomFiscal" : 123456,
  "numeroNotaFiscal" : 654321,
  "dataPedido" : "2000-01-23T04:56:07.000+00:00",
  "numeroPedido" : "PED-20240001",
  "statusPedido" : "APROVADO",
  "numeroNota" : 12345
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Consulta realizada com sucesso. StatusVendaEcommerceIntegracaoRetDto

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de vendas.

post /integracao/venda/ecommerce/efetuar-venda-v1

Efetuar venda e-commerce (efetuarVendaV1)

Efetua uma venda no e-commerce.

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body VendaEcommerceIntegracaoDto (required)

Body Parameter —

Return type

VendaEcommerceIntegracaoRetDto

Example data

Content-Type: application/json

{
  "numeroPedido" : "PED-20240001",
  "statusPedido" : {
    "codigo" : "1",
    "descricao" : "APROVADO"
  },
  "numeroNota" : 12345
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Venda efetuada com sucesso. VendaEcommerceIntegracaoRetDto

400

Requisição inválida.

401

Não autorizado.

500

Erro na geração da venda.

Vendedor

get /integracao/vendedor/obter-v1

Lista vendedores com filtros (obterTodosVendedoresAvancadoV1)

Consulta a lista de vendedores com filtros opcionais e paginação.

Query parameters

codigo (optional)

Query Parameter — Código do vendedor. Aceita múltiplos valores. format: int64

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[VendedorIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "ativo" : true,
  "codigo" : 123,
  "numeroCpf" : "12345678901",
  "nome" : "Maria Silva",
  "email" : "maria.silva@exemplo.com",
  "cep" : "88000000"
}, {
  "ativo" : true,
  "codigo" : 123,
  "numeroCpf" : "12345678901",
  "nome" : "Maria Silva",
  "email" : "maria.silva@exemplo.com",
  "cep" : "88000000"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Vendedores retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de vendedores.

get /integracao/vendedor/obter-todos-v1

Lista todos os vendedores (obterTodosVendedoresSimplesV1)

Retorna a lista de vendedores com paginação.

Query parameters

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

Return type

array[VendedorIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "ativo" : true,
  "codigo" : 123,
  "numeroCpf" : "12345678901",
  "nome" : "Maria Silva",
  "email" : "maria.silva@exemplo.com",
  "cep" : "88000000"
}, {
  "ativo" : true,
  "codigo" : 123,
  "numeroCpf" : "12345678901",
  "nome" : "Maria Silva",
  "email" : "maria.silva@exemplo.com",
  "cep" : "88000000"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Vendedores retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de vendedores.

get /integracao/vendedor/obter-alterados-v1

Lista vendedores alterados (obterVendedoresAlteradosV1)

Retorna lista de vendedores alterados no período especificado.

Query parameters

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

dataInicial (required)

Query Parameter — Data inicial em formato ISO 8601. format: date-time

dataFinal (required)

Query Parameter — Data final em formato ISO 8601. format: date-time

Return type

array[VendedorIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "ativo" : true,
  "codigo" : 123,
  "numeroCpf" : "12345678901",
  "nome" : "Maria Silva",
  "email" : "maria.silva@exemplo.com",
  "cep" : "88000000"
}, {
  "ativo" : true,
  "codigo" : 123,
  "numeroCpf" : "12345678901",
  "nome" : "Maria Silva",
  "email" : "maria.silva@exemplo.com",
  "cep" : "88000000"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Vendedores alterados retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de vendedores alterados.

get /integracao/vendedor/obter-movimentados-v1

Lista vendedores movimentados (obterVendedoresMovimentadosV1)

Retorna lista de vendedores movimentados no período especificado.

Query parameters

primeiroRegistro (required)

Query Parameter — Índice do primeiro registro a ser retornado. format: int32

quantidadeRegistros (required)

Query Parameter — Quantidade máxima de registros a serem retornados. format: int32

dataInicial (required)

Query Parameter — Data inicial em formato ISO 8601. format: date-time

dataFinal (required)

Query Parameter — Data final em formato ISO 8601. format: date-time

Return type

array[VendedorIntegracaoDto]

Example data

Content-Type: application/json

[ {
  "ativo" : true,
  "codigo" : 123,
  "numeroCpf" : "12345678901",
  "nome" : "Maria Silva",
  "email" : "maria.silva@exemplo.com",
  "cep" : "88000000"
}, {
  "ativo" : true,
  "codigo" : 123,
  "numeroCpf" : "12345678901",
  "nome" : "Maria Silva",
  "email" : "maria.silva@exemplo.com",
  "cep" : "88000000"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Vendedores movimentados retornados com sucesso.

400

Requisição inválida.

401

Não autorizado.

500

Erro na consulta de vendedores movimentados.

Models

[ Jump to Methods ]

AtualizaStatusPedidoEcommerceDto
BandeiraDto
CartaoIntegracaoRetornoDto
CartaoVendaIntegracaoDTO
CategoriaIntegracaoDto
ClienteEcommerceIntegracaoDto
ClienteIntegracaoDto
CompraIntegracaoDto
ComprasItemIntegracaoDto
CondicaoPagamento
CondicaoPagamentoDto
CorEcommerce
DadosEntregaDto
DepartamentoIntegracaoDto
DescontoEmpresaGrupoProdutoIntegracaoDto
DescontoMelhorIntegracaoDto
DescontoParceiroIntegracaoDto
DescontoPrecificacaoIntegracaoDto
DescontoProdutoVigenciaIntegracaoDto
DescontoProgressivoIntegracaoDto
DescontoProgressivoRetornoIntegracaoDto
DinheiroIntegracaoDTO
EmpresaConvenio
EnderecoEntregaIntegracaoDto
EstoqueIntegracaoDto
FinanceiroClassificacaoFinanceiraIntegracaoDto
FinanceiroContaIntegracaoDto
FinanceiroResultadoExercicioIntegracaoDto
FinanceiroResultadoFinanceiroIntegracaoDto
FornecedorDto
FornecedorIntegracaoDto
Grupo
GrupoProdutoIntegracaoDto
IdentificadorProdutoIntegracaoDto
ItemPedidoResumidoIntegracaoDto
LaboratorioIntegracaoDto
ListaTaxaParcelaIntegracaoDto
PagamentoIntegracaoDto
PagamentoMultiploIntegracaoDto
ParcelaCartaoEstornoIntegracaoDto
ParcelaCartaoEstornoTransacaoIntegracaoDto
ParcelaCartaoIntegracaoDto
ParcelaCartaoTransacaoIntegracaoDto
PedidoResumidoIntegracaoDto
PixIntegracaoDTO
PrincipioAtivoProdutoIntegracaoDto
ProdutoCondicaoPagamentoDto
ProdutoDescontoCondicaoPagamentoIntegracaoRetornoDto
ProdutoDescontoEncarteIntegracaoRetorno
ProdutoDescontoGrupoIntegracaoRetornoDto
ProdutoEncarteDto
ProdutoIntegracaoDto
RetornoConsultaSmartpedDTO
StatusPedido
StatusVendaEcommerceIntegracaoRetDto
TamanhoEcommerce
Tipo
VendaEcommerceIntegracaoDto
VendaEcommerceIntegracaoRetDto
VendaIntegracaoDto
VendaItemEcommerceIntegracaoDto
VendaItemIntegracaoDto
VendasVendedorIntegracaoDto
VendedorEcommerceIntegracaoDto
VendedorIntegracaoDto
WebhookDto

`AtualizaStatusPedidoEcommerceDto` Up

Objeto utilizado para atualizar o status de uma venda e-commerce no PDV.

numeroNota (optional)

Integer Número da venda gerada no PDV. format: int32

example: 12345

numeroPedido (optional)

String Número do pedido no e-commerce vinculado à venda.

example: PED-20240001

status

String Status do pedido no e-commerce.

Enum:

4 - CANCELADO

example: 4

`BandeiraDto` Up

Objeto que representa a bandeira do cartão.

codigoBandeira (optional)

Integer Código da bandeira. format: int32

example: 1

nomeBandeira (optional)

String Nome da bandeira.

example: VISA

`CartaoIntegracaoRetornoDto` Up

Objeto que retorna as informações do cartão cadastrado.

administradora (optional)

FornecedorDto

ativo (optional)

Boolean Define se o cartão está ativo ou inativo.

example: true

carteiraDigital (optional)

String Carteira digital do cartão.

example: PIC PAY

codigoCartao (optional)

Integer Código do cartão. format: int32

example: 1

descontoCartao (optional)

Double format: double

descontoMaximoCartao (optional)

Double format: double

gerenciadorTEF (optional)

BandeiraDto

modalidadeVenda (optional)

String Modalidade de venda do cartão.

example: DÉBITO

nomeCartao (optional)

String Nome do cartão.

example: CARTAO PADRAO

qtdMaxParcelas (optional)

Integer Quantidade máxima de parcelas permitidas. format: int32

example: 12

taxaAdministrativa (optional)

Double Taxa administrativa do cartão. format: double

example: 1.23

taxaAdministrativaParcela (optional)

array[ListaTaxaParcelaIntegracaoDto] Lista de taxas administrativas por parcela.

example: [{"parcelaInicial":"1","parcelaFinal":"1","taxaAdministrativa":"1.23"}]

vencimentoParcelas (optional)

array[String] Dias de vencimento por parcela.

example: ["30","60","90"]

`CartaoVendaIntegracaoDTO` Up

Objeto utilizado para informar a forma de pagamento CARTÃO em uma venda e-commerce no PDV.

codigo

Integer Código do cartão (Trier). format: int32

example: 1

numeroAutorizacao (optional)

Integer Número de autorização da transação no cartão. format: int32

example: 1234567890

pagamentoRealizado

Boolean Indica se o pagamento foi realizado.

example: true

qtdParcela (optional)

Integer Número de parcelas no cartão. format: int32

example: 3

valor

Double Valor pago no cartão. format: double

example: 100.0

`CategoriaIntegracaoDto` Up

Objeto que representa uma categoria.

codigo (optional)

Integer Código da categoria. format: int32

example: 1

nome (optional)

String Nome da categoria.

example: SABONETES

`ClienteEcommerceIntegracaoDto` Up

Objeto utilizado para informar o cliente de uma venda e-commerce no PDV.

ativo (optional)

Boolean Indica se o cliente está ativo.

example: true

bairro (optional)

String Bairro do cliente.

example: CENTRO

celular (optional)

String Número de celular do cliente. format: (##)#####-####

example: (48)90000-0000

cep (optional)

String CEP do cliente.

example: 95900000

codigo (optional)

Integer Código do cliente, se não informado, será gerado automaticamente pelo PDV. format: int32

example: 0

codigoCidade (optional)

String Código da cidade do cliente.

example: LAJEADO

dataNascimento (optional)

Date Data de nascimento do cliente. format: date-time

email (optional)

String E-mail do cliente.

example: email@teste.com

empresaConvenio (optional)

EmpresaConvenio

estado (optional)

String Estado do cliente.

example: RS

fone (optional)

String Número de telefone do cliente.

example: (48)99999-9999

grupo (optional)

Grupo

logradouro (optional)

String Logradouro do cliente.

example: RUA PARAIBA

nome

String Nome do cliente.

example: EDENEI JOSE CIMA

numeroCpfCnpj

String Número do CPF ou CNPJ do cliente.

example: 145.440.400-00

numeroEndereco (optional)

String Número do endereço do cliente.

example: 759

numeroRGIE (optional)

String Número do RG ou IE do cliente.

example: 1234567890

sexo (optional)

String Sexo do cliente.

Enum:

M,F

example: M

`ClienteIntegracaoDto` Up

Objeto utilizado para representar o cliente em integrações com o PDV.

ativo (optional)

Boolean Indica se o cliente está ativo.

example: true

bairro (optional)

String Bairro do cliente.

example: CENTRO

cep (optional)

String CEP do cliente.

example: 95900000

codigo (optional)

Integer Código do cliente, se não informado, será gerado automaticamente pelo PDV. format: int32

example: 0

codigoCidade (optional)

String Código da cidade do cliente.

example: LAJEADO

email (optional)

String E-mail do cliente.

example: email@teste.com

empresaConvenio (optional)

EmpresaConvenio

estado (optional)

String Estado do cliente.

example: RS

fone (optional)

String Número de telefone do cliente.

example: (48)99999-9999

grupo (optional)

Grupo

logradouro (optional)

String Logradouro do cliente.

example: RUA PARAIBA

nome

String Nome do cliente.

example: EDENEI JOSE CIMA

numeroCpfCnpj

String Número do CPF ou CNPJ do cliente.

example: 145.440.400-00

numeroEndereco (optional)

String Número do endereço do cliente.

example: 759

`CompraIntegracaoDto` Up

Objeto que representa a compra para integração.

chaveAcessoNfe (optional)

String Chave de acesso NFE.

example: 42180261940292005872550160000011331149753323

codigoFornecedor (optional)

Integer Código do fornecedor. format: int32

example: 1

datEmissao (optional)

Date format: date-time

dataEntrada (optional)

Date Data de entrada. format: date-time

itens (optional)

array[ComprasItemIntegracaoDto] Itens da compra.

numeroNotaFiscal (optional)

Integer Número da nota fiscal. format: int32

example: 1133

quantidadeItens (optional)

Integer Quantidade de itens da nota. format: int32

example: 2

valorTotalNota (optional)

Double Valor total da nota. format: double

example: 115.81

valorTotalProdutos (optional)

Double Valor total dos produtos. format: double

example: 112.81

xmlNfe (optional)

String Conteúdo do XML da NF-e (quando disponível).

example: <?xml version="1.0" encoding="UTF-8"?><nfeProc>...</nfeProc>

`ComprasItemIntegracaoDto` Up

Itens da compra.

codigoProduto (optional)

Integer Código do produto. format: int32

example: 92295

fatorCompra (optional)

Integer Fator de compra do produto. format: int32

example: 1

quantidadeProdutos (optional)

Integer Quantidade do produto. format: int32

example: 2

valorCusto (optional)

Double Valor de custo do produto. format: double

example: 8.86

valorST (optional)

Double Valor ST do produto. format: double

example: 12.75

valorUnitario (optional)

Double Valor unitário do produto. format: double

example: 8.86

valorUnitarioLiquido (optional)

Double Valor unitário líquido do produto (valor unitário - desconto). format: double

example: 8.86

`CondicaoPagamento` Up

Condição de pagamento da venda.

codigo (optional)

Integer Código da condição de pagamento. format: int32

example: 30

nome (optional)

String Nome da condição de pagamento.

example: 30 dias

`CondicaoPagamentoDto` Up

DTO de condição de pagamento na integração.

codigo (optional)

Integer Código da condição de pagamento. format: int32

example: 5

nome (optional)

String Nome da condição de pagamento.

example: À Vista

`CorEcommerce` Up

Cor para e-commerce.

codigo (optional)

Integer Código da cor. format: int32

example: 10

nome (optional)

String Nome da cor.

example: Azul

`DadosEntregaDto` Up

bairro (optional)

String

cep (optional)

String

cidade (optional)

String

complemento (optional)

String

endereco (optional)

String

fone (optional)

String

identificacao (optional)

String

itinerario (optional)

String

nome (optional)

String

numero (optional)

String

uf (optional)

String

`DepartamentoIntegracaoDto` Up

Objeto que retorna o departamento.

ativo (optional)

Boolean Define se o departamento está ativo ou inativo.

example: true

codigo (optional)

Integer Código do departamento. format: int32

example: 1

nome (optional)

String Nome do departamento.

example: Geral

`DescontoEmpresaGrupoProdutoIntegracaoDto` Up

DTO de retorno de desconto por empresa e grupo de produto na integração

codigoEmpresa (optional)

Integer Código da empresa (convênio) format: int32

example: 10

codigoFilial (optional)

Integer Código da filial format: int32

example: 1

codigoGrupoProduto (optional)

Integer Código do grupo de produtos format: int32

example: 5

condicoesPagamento (optional)

array[CondicaoPagamentoDto] Lista de condições de pagamento vinculadas ao desconto

dataFim (optional)

Date Data final de vigência da promoção format: date-time

dataInicio (optional)

Date Data inicial de vigência da promoção format: date-time

nomeEmpresa (optional)

String Nome da empresa (convênio)

example: Empresa Exemplo Ltda

nomeGrupoProduto (optional)

String Nome do grupo de produtos

example: Medicamentos

percentualDesconto (optional)

Double Percentual de desconto cadastrado para o grupo de produto format: double

example: 15.0

percentualDescontoMax (optional)

Double Percentual de desconto máximo para o grupo de produto format: double

example: 20.0

`DescontoMelhorIntegracaoDto` Up

DTO de desconto melhor integração.

codigoBarras (optional)

Long Código de barras do produto. format: int64

example: 7897316804858

codigoCondicaoPagamento (optional)

Integer Código da condição de pagamento que oferece o melhor desconto. format: int32

example: 3

codigoLaboratorio (optional)

Integer Código do laboratório. format: int32

example: 14

codigoProduto (optional)

Integer Código do produto. format: int32

example: 1

nomeCondicaoPagamento (optional)

String Nome da condição de pagamento que oferece o melhor desconto.

example: DINHEIRO

nomeLaboratorio (optional)

String Nome do laboratório.

example: REFERENCIA OTC

nomeProduto (optional)

String Nome do produto.

example: REFRESH GEL 0,3% OFT 10G

percentualDesconto (optional)

Double Melhor percentual de desconto encontrado para o produto. format: double

example: 10.45

quantidadeEstoque (optional)

Integer Quantidade em estoque. format: int32

example: 100

valorPromocao (optional)

Double Valor de promoção com base no melhor percentual de desconto encontrado para o produto. format: double

example: 10.59

valorVenda (optional)

Double Valor de venda cadastrado no produto. format: double

example: 50.78

`DescontoParceiroIntegracaoDto` Up

DTO de retorno de desconto por parceiro e produto na integração

codigoBarras (optional)

Long Código de barras do produto format: int64

example: 7898455107541

codigoFilial (optional)

Integer Código da filial format: int32

example: 1

codigoParceiro (optional)

Integer Código do parceiro format: int32

example: 10

codigoProduto (optional)

Integer Código do produto format: int32

example: 100

dataFim (optional)

Date Data final de vigência da promoção format: date-time

dataInicio (optional)

Date Data inicial de vigência da promoção format: date-time

diasSemana (optional)

array[String] Lista de dias da semana em que o desconto é vigente. Caso vazia, todos os dias são vigentes.

example: ["SEGUNDA","TERÇA","QUARTA"]

nomeParceiro (optional)

String Nome do parceiro

example: PEC

nomeProduto (optional)

String Nome do produto

example: Dipirona 500mg

percentualDesconto (optional)

Double Percentual de desconto cadastrado format: double

example: 15.0

valorPromocao (optional)

Double Valor de promoção cadastrado format: double

example: 9.99

valorVenda (optional)

Double Valor de venda do produto format: double

example: 12.5

`DescontoPrecificacaoIntegracaoDto` Up

Dados de integração de desconto por precificação.

codigoFilial (optional)

Integer Código da filial. format: int32

example: 1

codigoProduto (optional)

Integer Código do produto. format: int32

example: 12345

valorVenda (optional)

Double Valor de venda do produto. format: double

example: 99.9

`DescontoProdutoVigenciaIntegracaoDto` Up

DTO de retorno de desconto vigência de produto na integração.

codigoDesconto (optional)

Long Código interno do desconto. format: int64

example: 123456

codigoFilial (optional)

Integer Código da filial. format: int32

example: 101

codigoProduto (optional)

Integer Código do produto (SKU). format: int32

example: 7890123

dataFim (optional)

String Data de término da vigência.

example: 2025-02-15

dataInicio (optional)

String Data de início da vigência.

example: 2025-01-10

percentualDesconto (optional)

Double Percentual de desconto aplicado (0 a 100). format: double

example: 12.5

valorPromocao (optional)

Double Valor promocional final do produto. format: double

example: 79.9

`DescontoProgressivoIntegracaoDto` Up

DTO de desconto progressivo integração.

codigoBarras (optional)

Long Código de barras do produto. format: int64

example: 7897316804858

codigoLaboratorio (optional)

Integer Código do laboratório. format: int32

example: 14

codigoProduto (optional)

Integer Código do produto. format: int32

example: 1

condicaoPagamento (optional)

Integer format: int32

dataFim (optional)

Date Data final da campanha. format: date-time

dataInicio (optional)

Date Data de início da campanha. format: date-time

nomeLaboratorio (optional)

String Nome do laboratório.

example: REFERENCIA OTC

nomeProduto (optional)

String Nome do produto.

example: REFRESH GEL 0,3% OFT 10G

origemDesconto (optional)

String

percentualDesconto (optional)

Double Percentual de desconto para quantidades vendidas maior ou igual a quantidadeItens. format: double

example: 20.0

quantidadeEstoque (optional)

Integer Quantidade em estoque. format: int32

example: 2

quantidadeItens (optional)

Integer Quantidade de itens para obter o desconto progressivo. format: int32

example: 5

valorPromocao (optional)

Double Preço de venda para quantidades vendidas maior ou igual a quantidadeItens. format: double

example: 80.0

valorVenda (optional)

Double Preço de venda cadastrado no produto. format: double

example: 100.0

`DescontoProgressivoRetornoIntegracaoDto` Up

DTO de retorno de desconto progressivo de produto na integração

codigoBarras (optional)

Long format: int64

codigoLaboratorio (optional)

Integer format: int32

codigoProduto (optional)

Integer format: int32

condicoesPagamento (optional)

array[String] Lista de condições de pagamento aplicadas no desconto

example: DINHEIRO, CARTÃO

dataFim (optional)

Date format: date-time

dataInicio (optional)

Date format: date-time

nomeLaboratorio (optional)

String

nomeProduto (optional)

String

origemDesconto (optional)

String Origem do desconto aplicado

example: PRODUTO

percentualDesconto (optional)

Double format: double

quantidadeEstoque (optional)

Integer format: int32

quantidadeItens (optional)

Integer format: int32

valorPromocao (optional)

Double format: double

valorVenda (optional)

Double format: double

`DinheiroIntegracaoDTO` Up

Objeto utilizado para informar a forma de pagamento DINHEIRO em uma venda e-commerce no PDV.

pagamentoRealizado

Boolean Indica se o pagamento foi realizado.

example: true

valor

Double Valor pago. format: double

example: 100.0

valorTroco (optional)

Double Valor do troco. format: double

example: 10.0

`EmpresaConvenio` Up

Empresa convênio vinculada ao cliente

codigo (optional)

Integer format: int32

nome (optional)

String

`EnderecoEntregaIntegracaoDto` Up

Objeto utilizado para informar o endereço de entrega de uma venda e-commerce no PDV.

bairro

String Bairro.

example: Centro

cep (optional)

String CEP.

example: 12345678

cidade

String Cidade.

example: São Paulo

complemento (optional)

String Complemento.

example: Apto 101

estado (optional)

String Estado.

example: SP

itinerario1 (optional)

String Itinerário 01.

example: Em frente à residência de número 245, próxima à Praça Central.

itinerario2 (optional)

String Itinerário 02.

example: Ao lado do Supermercado Bom Preço, entrada pela Rua das Flores.

itinerario3 (optional)

String Itinerário 03.

example: Nos fundos do prédio comercial Alfa Center, portão azul.

itinerario4 (optional)

String Itinerário 04.

example: Próximo ao condomínio Vale Verde, após a rotatória principal.

logradouro

String Logradouro.

example: Rua das Flores

numero (optional)

String Número.

example: 123

referencia (optional)

String Referência.

example: Ao lado do mercado público

`EstoqueIntegracaoDto` Up

Objeto que retorna o estoque de um produto.

alterCurva (optional)

Date format: date-time

codigoProduto (optional)

Integer Código reduzido de um produto. format: int32

example: 12345

dataUltimaEntrada (optional)

Date Data da última entrada do produto. format: date-time

quantidadeEstoque (optional)

Integer Quantidade em estoque. format: int32

example: 2

valorCustoMedio (optional)

BigDecimal Custo médio do produto.

example: 36.32

valorUltimaEntrada (optional)

Double Valor da última entrada do produto. format: double

example: 35.43

`FinanceiroClassificacaoFinanceiraIntegracaoDto` Up

Objeto que retorna classificação financeira.

ativo (optional)

Boolean Ativo ou inativo.

example: true

centroCusto (optional)

String Código do centro de custo que pertence.

example: 12

creditoDebito (optional)

String D = Débito / C = Crédito.

example: C

fixoVariavel (optional)

String F = Fixo / V = Variável.

example: V

nomeDescricao (optional)

String Nome do centro de custo que pertence.

example: Despesas variaveis (Credito/Ativo)

tipoClassificacao (optional)

String D = Despesa / R = Receita.

example: D

`FinanceiroContaIntegracaoDto` Up

Objeto que representa uma conta financeira.

dataAtualizacao (optional)

Date Data de atualização. format: date-time

digito (optional)

String Dígito da conta.

example: 2

digitoAgencia (optional)

String Dígito da agência.

example: 1

nome (optional)

String Nome da conta.

example: Conta caixa

numero (optional)

String Número da conta.

example: 1234

numeroAgencia (optional)

String Número da agência.

example: 6442

saldo (optional)

BigDecimal Saldo da conta.

example: 10.85

`FinanceiroResultadoExercicioIntegracaoDto` Up

Objeto que retorna resultado do exercício financeiro.

centroCusto (optional)

String Centro de custo que ele pertence.

example: 2

codigoDepartamento (optional)

Integer Código departamento. format: int32

example: 1

data (optional)

date Data de lançamento do movimento. format: date

example: Sun Dec 30 00:00:00 UTC 2012

valorBruto (optional)

BigDecimal Valor bruto.

example: 8725.21

`FinanceiroResultadoFinanceiroIntegracaoDto` Up

Objeto que retorna resultado de movimentação financeira.

baixadoAberto (optional)

String Movimento baixado ou aberto.

example: A

centroCusto (optional)

String Centro de custo que pertence.

example: 2

codigoDepartamento (optional)

Integer Código do departamento. format: int32

example: 1

data (optional)

date Data de baixa do movimento. format: date

example: Sun Dec 30 00:00:00 UTC 2012

valorBruto (optional)

BigDecimal Valor bruto do movimento.

example: 62.6

`FornecedorDto` Up

Objeto que representa o fornecedor do cartão.

codigoFornecedor (optional)

Integer Código do fornecedor. format: int32

example: 1

nomeFornecedor (optional)

String Nome do fornecedor.

example: FORNECEDOR PADRÃO

`FornecedorIntegracaoDto` Up

DTO de integração de fornecedor.

ativo (optional)

Boolean Ativo ou inativo.

example: true

codigo (optional)

Integer Código do fornecedor. format: int32

example: 1

email (optional)

String E-mail do fornecedor.

example: teste@teste.com.br

nomeCidade (optional)

String Cidade do fornecedor.

example: FLORIANOPOLIS

nomeFantasia (optional)

String Nome fantasia do fornecedor.

example: SANTA CRUZ DIST.DE MEDICAMNETOS LTDA.

numeroCnpj (optional)

String CNPJ do fornecedor.

example: 61.940.292/0058-72

razaoSocial (optional)

String Razão social do fornecedor.

example: SANTA CRUZ DIST.DE MEDICAMNETOS LTDA.

`Grupo` Up

Objeto que retorna o grupo.

codigo (optional)

Integer Código do grupo. format: int32

example: 1

nome (optional)

String Nome do grupo.

example: PADRAO

`GrupoProdutoIntegracaoDto` Up

Dados de integração do grupo de produtos.

ativo (optional)

Boolean Indica se o grupo está ativo.

example: true

codigo (optional)

Integer Código do grupo de produtos. format: int32

example: 10

nome (optional)

String Nome do grupo de produtos.

example: Perfumaria

`IdentificadorProdutoIntegracaoDto` Up

Identificador de produto para integracao.

ativo (optional)

Boolean Indica se o identificador esta ativo.

example: true

codigo (optional)

Integer Codigo reduzido do produto. format: int32

example: 12345

identificador (optional)

Long Identificador do produto (codigo de barras ou codigo reduzido). format: int64

example: 7891234567890

principal (optional)

Boolean Indica se o identificador e principal.

example: true

`ItemPedidoResumidoIntegracaoDto` Up

Representa um resumo das informações principais de um item de pedido para integração.

cnpjFornecedorUltimaCompra (optional)

String CNPJ do fornecedor da última compra do produto.

example: 99.999.999/0001-99

codigoBarras (optional)

Long Código de barras do produto. format: int64

example: 7891234567890

codigoComprador (optional)

Integer Código do usuário que efetuou o pedido no sistema. format: int32

example: 30

codigoFornecedor (optional)

Integer Código do fornecedor do pedido. format: int32

example: 14

codigoFornecedorUltimaCompra (optional)

Integer Código do fornecedor da última compra do produto. format: int32

example: 14

codigoProduto (optional)

Integer Código do produto. format: int32

example: 1

dataEmissao (optional)

Date Data de emissão do pedido no formato ISO 8601. format: date-time

fatorCompra (optional)

Integer Fator de compra do produto. format: int32

example: 1

fatorCompraUltimaCompra (optional)

Integer Fator de compra da última compra do produto. format: int32

example: 1

horaEmissao (optional)

Date Hora de emissão do pedido no formato ISO 8601. format: date-time

nomeComprador (optional)

String Nome do comprador.

example: JOÃO DA SILVA

nomeFornecedor (optional)

String Nome do fornecedor do pedido.

example: FORNECEDOR XYZ

nomeFornecedorUltimaCompra (optional)

String Nome do fornecedor da última compra do produto.

example: FORNECEDOR XYZ

nomeProduto (optional)

String Nome do produto.

example: PRODUTO ABC

numeroPedido (optional)

Integer Número do pedido. format: int32

example: 1

numeroSequencialItem (optional)

Integer Número sequencial do item no pedido. format: int32

example: 4

quantidadeEstoque (optional)

Integer Quantidade do produto em estoque. format: int32

example: 100

quantidadeProdutos (optional)

Integer Quantidade de produtos no item do pedido. format: int32

example: 20

transmitido (optional)

Boolean Indica se o pedido foi transmitido.

example: true

valorUnitario (optional)

Double Valor unitário do produto no item do pedido. format: double

example: 10.5

valorUnitarioUltimaCompra (optional)

Double Valor unitário da última compra do produto. format: double

example: 9.8

`LaboratorioIntegracaoDto` Up

Objeto que retorna as informações de um laboratório.

ativo (optional)

Boolean Define se o laboratório está ativo ou inativo.

example: true

cnpj (optional)

String CNPJ do laboratório.

example: 99.999.999/0001-99

codigo (optional)

Integer Código do laboratório. format: int32

example: 1

nome (optional)

String Nome do laboratório.

example: LABORATORIO TESTE

`ListaTaxaParcelaIntegracaoDto` Up

Objeto que representa a taxa administrativa por parcela.

parcelaFinal (optional)

String Parcela final.

example: 1

parcelaInicial (optional)

String Parcela inicial.

example: 1

taxaAdministrativa (optional)

String Taxa administrativa da parcela.

example: 1.23

`PagamentoIntegracaoDto` Up

Objeto utilizado para informar a forma de pagamento de uma venda e-commerce no PDV.

dataVencimento (optional)

Date Data de vencimento do pagamento. format: date-time

numeroAutorizacao (optional)

String Número de autorização da transação.

example: 123456789012

pagamentoRealizado

Boolean Indica se o pagamento foi realizado.

example: true

valorDinheiro (optional)

Double Valor em dinheiro. format: double

example: 50.0

valorParcela

Double Valor da parcela. format: double

example: 100.0

valorTroco (optional)

Double Valor do troco. format: double

example: 10.0

`PagamentoMultiploIntegracaoDto` Up

Objeto utilizado para informar as formas de pagamento de uma venda e-commerce no PDV.

cartao (optional)

array[CartaoVendaIntegracaoDTO] Lista de pagamentos em cartão.

dinheiro (optional)

DinheiroIntegracaoDTO

pix (optional)

PixIntegracaoDTO

`ParcelaCartaoEstornoIntegracaoDto` Up

Objeto que retorna as informações de estorno de parcelas de cartão.

cnpjLoja (optional)

String Número do CNPJ da filial.

example: 99.999.999/0001-99

codigoLoja (optional)

Integer Código da filial. format: int32

example: 1

estornos (optional)

array[ParcelaCartaoEstornoTransacaoIntegracaoDto] Lista de estornos de parcelas de cartão.

inscricaoEstadualLoja (optional)

String Inscrição estadual da filial.

example: ISENTO

razaoSocial (optional)

String Razão social da filial.

example: FARMACIA E DROGARIA LTDA

`ParcelaCartaoEstornoTransacaoIntegracaoDto` Up

Objeto que retorna as informações de estorno de parcelas de cartão.

dataEmissaoDevolucao (optional)

Date Data de emissão da nota de devolução. format: date-time

dataEmissaoOrigem (optional)

Date Data de emissão da nota original da venda. format: date-time

numeroNotaDevolucao (optional)

Integer Número da nota de devolução. format: int32

example: 98766

numeroNotaOrigem (optional)

Integer Número da nota original da venda. format: int32

example: 98765

totalNotaDevolucao (optional)

Double Total da nota de devolução (apenas considerado total do cartão). format: double

example: 24.5

totalNotaOrigem (optional)

Double Total da nota original da venda (apenas considerado total do cartão). format: double

example: 24.5

`ParcelaCartaoIntegracaoDto` Up

Objeto que retorna as informações de parcelas de cartão.

cnpjLoja (optional)

String Número do CNPJ da filial.

example: 99.999.999/0001-99

codigoLoja (optional)

Integer Código da filial. format: int32

example: 1

inscricaoEstadualLoja (optional)

String Inscrição estadual da filial.

example: ISENTO

razaoSocial (optional)

String Razão social da filial.

example: FARMACIA E DROGARIA LTDA

transacoes (optional)

array[ParcelaCartaoTransacaoIntegracaoDto] Lista de parcelas de cartão.

`ParcelaCartaoTransacaoIntegracaoDto` Up

Objeto que retorna as informações de parcelas de cartão.

administradoraCartao (optional)

String Administradora do cartão.

example: CONVCARD ADMIN. DE CARTOES

codigoAutorizacao (optional)

String Código de autorização.

example: 789321

codigoBandeira (optional)

String Código nacional da bandeira (opcional).

example: 999

codigoCartao (optional)

Integer Código do cartão. format: int32

example: 5

codigoEstabelecimentoAdquirente (optional)

Integer Código do estabelecimento na adquirente (opcional).

example: 1234567890

dataEmissao (optional)

Date Data de emissão. format: date-time

dataPagamento (optional)

Date Data do pagamento. format: date-time

dataVencimento (optional)

Date Data do vencimento. format: date-time

documentoFiscal (optional)

Integer Número do documento fiscal. format: int32

example: 789651

formaCaptura (optional)

String Forma de captura (TEF / POS).

example: TEF

idParcela (optional)

Integer Identificação da parcela. format: int32

example: 1

idTransacao (optional)

String Identificação da transação (Venda + ID / Recebimento + ID).

example: VE:352698

idTransacaoPIX (optional)

String Identificação da transação Pix (Skytef).

example: 1321097743

modalidadeVenda (optional)

String Modalidade da venda (CREDITO / DEBITO).

example: CREDITO

nomeAdquirente (optional)

String Nome da adquirente (opcional).

example: FACISC

nomeCartao (optional)

String Nome do cartão.

example: CONVCARD

nsuAdministradora (optional)

String NSU da administradora.

example: 123456

nsuOrigem (optional)

Integer NSU de origem. format: int32

example: 1

numeroParcela (optional)

Integer Número da parcela. format: int32

example: 1

prazoVenda (optional)

String Prazo da venda (A VISTA / PARCELADO).

example: A VISTA

totalParcelas (optional)

Double Quantidade total de parcelas. format: double

example: 2.0

valorParcela (optional)

Double Valor líquido a receber da parcela. format: double

example: 48.0

valorTaxas (optional)

Double Valor total das taxas da transação. format: double

example: 2.0

valorTotal (optional)

Double Valor total pago em cartão. format: double

example: 100.0

`PedidoResumidoIntegracaoDto` Up

Representa um resumo das informações principais de um pedido para integração.

codigoComprador (optional)

Integer Código do usuário que efetuou o pedido no sistema. format: int32

example: 30

dataEmissao (optional)

Date Data de emissão do pedido no formato ISO 8601. format: date-time

horaEmissao (optional)

Date Hora de emissão do pedido no formato ISO 8601. format: date-time

nomeComprador (optional)

String Nome do comprador.

example: JOÃO DA SILVA

numeroPedido (optional)

Integer Número do pedido. format: int32

example: 1

`PixIntegracaoDTO` Up

Objeto utilizado para informar a forma de pagamento PIX em uma venda e-commerce no PDV.

codigo

Integer Código do tipo de pagamento PIX (Cartão). format: int32

example: 5

idTransacaoPIX (optional)

String ID da transação PIX.

example: 1234567890

numeroAutorizacao (optional)

Integer Número da autorização. format: int32

example: 1234567890

pagamentoRealizado

Boolean Indica se o pagamento foi realizado.

example: true

valor

Double Valor pago no PIX. format: double

example: 100.0

`PrincipioAtivoProdutoIntegracaoDto` Up

Dados de integracao do principio ativo do produto.

ativo (optional)

Boolean Indica se o principio ativo esta ativo.

example: true

codigo (optional)

String Codigo do principio ativo.

example: 06827

nome (optional)

String Nome do principio ativo.

example: Paracetamol

`ProdutoCondicaoPagamentoDto` Up

codigoBarras (optional)

String

codigoProduto (optional)

Integer format: int32

nomeProduto (optional)

String

`ProdutoDescontoCondicaoPagamentoIntegracaoRetornoDto` Up

codigoFilial (optional)

Integer format: int32

condicoesPagamento (optional)

array[CondicaoPagamentoDto]

dataFim (optional)

String

dataInicio (optional)

String

diasSemana (optional)

array[String]

nomeCampanha (optional)

String

percentualDesconto (optional)

Double format: double

percentualDescontoMax (optional)

Double format: double

produto (optional)

ProdutoCondicaoPagamentoDto

valorPromocao (optional)

Double format: double

valorVenda (optional)

Double format: double

`ProdutoDescontoEncarteIntegracaoRetorno` Up

Informações de encarte e seus produtos com desconto.

codigoEncarte (optional)

Integer Código identificador do encarte. format: int32

example: 123

dataFim (optional)

String Data de término da vigência do encarte.

example: 15/05/2024

dataInicio (optional)

String Data de início da vigência do encarte.

example: 01/05/2024

diasSemana (optional)

array[String] Dias da semana em que o encarte é válido.

example: [ DOM, SEG, TER ]

nomeCampanha (optional)

String Nome da campanha/encarte.

example: Encarte Dia das Mães

produtosEncarte (optional)

ProdutoEncarteDto

`ProdutoDescontoGrupoIntegracaoRetornoDto` Up

DTO de retorno de desconto por grupo de produto na integração.

codigoFilial (optional)

Integer Código da filial. format: int32

example: 1

condicaoPagamento (optional)

CondicaoPagamentoDto

dataFim (optional)

String Data de fim da campanha.

example: 2024-12-31

dataInicio (optional)

String Data de início da campanha.

example: 2024-01-01

diasSemana (optional)

array[String] Dias da semana em que o desconto é aplicável. Caso não possua nenhum dia específico, deverá ser retornado todos os dias da semana, de DOMINGO a SÁBADO.

example: ["SEGUNDA","TERÇA","QUARTA"]

grupoProduto (optional)

Integer Código do grupo de produto. format: int32

example: 10

nomeCampanha (optional)

String Nome da campanha de desconto.

example: DESCONTO PADRAO

percentualDesconto (optional)

Double Percentual de desconto. format: double

example: 5.0

percentualDescontoMax (optional)

Double Percentual máximo de desconto. format: double

example: 15.0

`ProdutoEncarteDto` Up

Informações de produto em encarte promocional

codigoProduto (optional)

Integer Código interno do produto format: int32

example: 1

nomeProduto (optional)

String Nome do produto

example: DORFLEX 36 CPR

quantidadeProduto (optional)

Integer Quantidade de unidades do produto necessária para que o desconto seja aplicado format: int32

example: 2

valorPromocao (optional)

BigDecimal Valor promocional aplicado ao produto

example: 9.9

`ProdutoIntegracaoDto` Up

Dados de integração do produto.

alturaEcommerce (optional)

Integer Altura em milimetros para e-commerce. format: int32

example: 120

ativo (optional)

Boolean Indica se o produto esta ativo.

example: true

codClaFiscal (optional)

String Codigo da classificacao fiscal.

example: 1234.56.78

codDepto (optional)

Integer Codigo do departamento. format: int32

example: 20

codTipo (optional)

Integer Codigo do tipo. format: int32

example: 1

codigo (optional)

Integer Codigo do produto. format: int32

example: 12345

codigoBarras (optional)

Long Codigo de barras. format: int64

example: 7891234567890

codigoCategoria (optional)

Integer Codigo da categoria. format: int32

example: 40

codigoClassificacao (optional)

Integer Codigo da classificacao. format: int32

example: 50

codigoDepartamento (optional)

Integer Codigo do departamento. format: int32

example: 20

codigoGrupo (optional)

Integer Codigo do grupo. format: int32

example: 30

codigoLaboratorio (optional)

Integer Codigo do laboratorio. format: int32

example: 101

codigoPrincipioAtivo (optional)

String Codigo do principio ativo.

example: PARA

corEcommerce (optional)

CorEcommerce

descricaoEcommerce (optional)

String Descricao do produto para e-commerce.

example: Analgesico indicado para dores e febre.

idProduto (optional)

String Identificador externo do produto.

example: SKU-000123

integracaoEcommerce (optional)

Boolean Indica integracao com e-commerce.

example: true

larguraEcommerce (optional)

Integer Largura em milimetros para e-commerce. format: int32

example: 40

nomDepto (optional)

String Nome do departamento.

example: Medicamentos

nomTipo (optional)

String Nome do tipo.

example: Medicamento

nome (optional)

String Nome do produto.

example: Paracetamol 750mg

nomeCategoria (optional)

String Nome da categoria.

example: Uso Adulto

nomeClassificacao (optional)

String Nome da classificacao.

example: Tarja Amarela

nomeDepartamento (optional)

String Nome do departamento.

example: Medicamentos

nomeEcommerce (optional)

String Nome do produto para e-commerce.

example: Paracetamol 750mg - 20 comprimidos

nomeGrupo (optional)

String Nome do grupo.

example: Analgesicos

nomeLaboratorio (optional)

String Nome do laboratorio.

example: Laboratorio Exemplo

nomePrincipioAtivo (optional)

String Nome do principio ativo.

example: Paracetamol

observacaoVenda (optional)

String Observacao de venda.

example: Produto nao fracionavel.

percentualDesconto (optional)

Double Percentual de desconto. format: double

example: 10.0

percentualDescontoMax (optional)

Double Percentual maximo de desconto. format: double

example: 15.0

pesoEcommerce (optional)

Integer Peso em gramas para e-commerce. format: int32

example: 150

produtoManipulado (optional)

String Indica se o produto e manipulado.

example: N

profundidadeEcommerce (optional)

Integer Profundidade em milimetros para e-commerce. format: int32

example: 20

qtdLimiteCarrinhoEcommerce (optional)

Integer Limite de itens por carrinho no e-commerce. format: int32

example: 5

quantidadeEstoque (optional)

Integer Quantidade em estoque. format: int32

example: 100

quantidadeEstoqueEcommerce (optional)

Integer Quantidade de estoque para e-commerce. format: int32

example: 50

tags (optional)

array[String] Tags do produto.

tamanhoEcommerce (optional)

TamanhoEcommerce

tipo (optional)

Tipo

tipoLista (optional)

String Tipo de lista de precos.

example: PADRAO

unidade (optional)

String Unidade de medida.

example: UN

valorCusto (optional)

Double Valor de custo. format: double

example: 12.5

valorCustoMedio (optional)

BigDecimal Valor de custo medio.

example: 13.1

valorVenda (optional)

Double Valor de venda. format: double

example: 19.9

valorVendaEcommerce (optional)

Double Valor de venda para e-commerce. format: double

example: 21.9

`RetornoConsultaSmartpedDTO` Up

Dados de retorno da consulta Smartped.

cnpjLoja (optional)

String CNPJ da loja, somente números.

example: 12345678000199

codigoLoja (optional)

Integer Código da loja. format: int32

example: 1

datCotacao (optional)

Date Data da cotação no formato ISO 8601. format: date-time

razaoSocial (optional)

String Razão social da loja.

example: LOJA EXEMPLO LTDA

tipCotacao (optional)

String Tipo da cotação.

Enum:

SEM_ORIGEM

SMARTPED

VENDEDOR

example: SMARTPED

`StatusPedido` Up

Status do pedido.

codigo (optional)

String Código do status do pedido.

example: 1

descricao (optional)

String Descrição do status do pedido.

example: APROVADO

`StatusVendaEcommerceIntegracaoRetDto` Up

Objeto utilizado para retornar o status de uma venda e-commerce no PDV.

dataPedido (optional)

Date Data do pedido no e-commerce. format: date-time

numeroCupomFiscal (optional)

Integer Número do cupom fiscal. format: int32

example: 123456

numeroNota (optional)

Integer Número da venda gerada no PDV. format: int32

example: 12345

numeroNotaFiscal (optional)

Integer Número da nota fiscal. format: int32

example: 654321

numeroPedido (optional)

String Número do pedido no e-commerce vinculado à venda.

example: PED-20240001

statusPedido (optional)

String Status do pedido no e-commerce.

example: APROVADO

xmlNfe (optional)

String XML da nota fiscal eletrônica.

example: <xml>...</xml>

`TamanhoEcommerce` Up

Tamanho para e-commerce.

codigo (optional)

Integer Código do tamanho. format: int32

example: 5

nome (optional)

String Nome do tamanho.

example: M

`Tipo` Up

Tipo do produto.

codigo (optional)

Integer Código do tipo. format: int32

example: 1

nome (optional)

String Nome do tipo.

example: Medicamento

`VendaEcommerceIntegracaoDto` Up

Objeto utilizado para gerar uma venda e-commerce no PDV.

cliente (optional)

ClienteEcommerceIntegracaoDto

dataPedido

String Data do pedido no e-commerce. format: yyyy-MM-dd'T'HH:mm:ssZ

example: 2020-01-01T23:59:59-0300

enderecoEntrega (optional)

EnderecoEntregaIntegracaoDto

entrega (optional)

Boolean Indica se é uma venda Tele-Entrega ou não.

example: true

enviarMaquinaPOS (optional)

Boolean Indica se deve enviar para a máquina POS.

example: true

numeroPedido

String Número do pedido no e-commerce que será vinculado à venda.

example: PED-20240001

pagamento (optional)

PagamentoIntegracaoDto

pagamentoMultiplo (optional)

PagamentoMultiploIntegracaoDto

produtos (optional)

array[VendaItemEcommerceIntegracaoDto] Lista de produtos da venda.

valorFrete (optional)

Double Valor do frete do pedido. format: double

example: 10.0

valorTotalVenda

Double Valor total do pedido, que será utilizado como total da venda. format: double

example: 100.0

vendedor (optional)

VendedorEcommerceIntegracaoDto

`VendaEcommerceIntegracaoRetDto` Up

Objeto utilizado para retornar dados da geração ou finalização de uma venda e-commerce no PDV.

numeroNota (optional)

Integer Número da venda gerada no PDV. format: int32

example: 12345

numeroPedido (optional)

String Número do pedido no e-commerce vinculado à venda.

example: PED-20240001

statusPedido (optional)

StatusPedido

`VendaIntegracaoDto` Up

Dados de integração de venda.

codEcommerce (optional)

Integer Código da venda no e-commerce. format: int32

example: 5555

codFilial (optional)

Integer Código da filial. format: int32

example: 1

codParceiro (optional)

Integer Código do parceiro (quando aplicável). format: int32

example: 1001

codigoCliente (optional)

Integer Código do cliente. format: int32

example: 456

codigoVendedor (optional)

Integer Código do vendedor. format: int32

example: 789

condicaoPagamento (optional)

CondicaoPagamento

dadosEntrega (optional)

DadosEntregaDto

dataEmissao (optional)

Date Data de emissão em formato ISO 8601. format: date-time

entrega (optional)

Boolean Indica se possui entrega vinculada.

example: true

horaEmissao (optional)

Date Hora de emissão em formato ISO 8601. format: date-time

itens (optional)

array[VendaItemIntegracaoDto] Itens da venda.

modeloVenda (optional)

String Modelo da venda.

example: 55

numeroCupomFiscal (optional)

Integer Número do cupom fiscal. format: int32

example: 987654

numeroNota (optional)

Integer Número da venda/nota. format: int32

example: 123456

numeroNotaFiscal (optional)

Integer Número da nota fiscal (NF). format: int32

example: 7654321

numeroNotaOrigem (optional)

Integer Número da nota de origem (para devoluções/cancelamentos). format: int32

example: 123000

pagamentoNaEntrega (optional)

Boolean Indica se o pagamento é na entrega.

example: true

serNotaFiscal (optional)

String Série da nota fiscal.

example: 1

tipoCancelamento (optional)

String Tipo de cancelamento: D=Devolução, E=Estorno.

Enum:

example: D

vendaEcommerce (optional)

String Indicador de venda no e-commerce.

example: S

vendaIfood (optional)

Boolean Indica se a venda é do iFood.

example: false

vlrTroco (optional)

Double Valor do troco da venda. format: double

example: 5.5

xmlNfe (optional)

String Conteúdo do XML da NF-e (quando disponível).

example: <?xml version="1.0" encoding="UTF-8"?><nfeProc>...</nfeProc>

`VendaItemEcommerceIntegracaoDto` Up

Item da venda e-commerce no PDV.

codigoProduto

Integer Código do produto. format: int32

example: 12345

nomeProduto (optional)

String Nome do produto.

example: Produto Exemplo

quantidade

Integer Quantidade do produto. format: int32

example: 2

valorDesconto (optional)

Double Valor unitário do desconto aplicado ao produto. format: double

example: 0.5

valorUnitario

Double Valor unitário do produto. format: double

example: 50.0

`VendaItemIntegracaoDto` Up

Item de venda para integração.

codBarras (optional)

Long Código de barras do produto. format: int64

example: 7894900011517

codigoMedico (optional)

Integer Código do médico vinculado ao item, quando aplicável. format: int32

example: 321

codigoProduto (optional)

Integer Código reduzido do produto. format: int32

example: 12345

codigoVendedor (optional)

Integer Código do vendedor associado ao item. format: int32

example: 789

idVenda (optional)

String Identificador calculado da venda (hash MD5).

example: 9f6d5c0b2a3e4d1f8c7b6a5e4d3c2b1a

numSequencial (optional)

Integer Número sequencial do item na venda. format: int32

example: 1

parceiro (optional)

Boolean Indica se o item é de parceiro.

example: false

prcComissao (optional)

Double Percentual de comissão aplicado ao item. format: double

example: 5.0

prcDesconto (optional)

Double Percentual de desconto aplicado. format: double

example: 10.0

prcDescontoMax (optional)

Double Percentual máximo de desconto permitido. format: double

example: 15.0

quantidadeProdutos (optional)

Integer Quantidade de produtos no item. format: int32

example: 2

tabelaDesconto (optional)

String Nome da tabela de desconto aplicada.

example: PROMO_VERAO

valorTotalBruto (optional)

BigDecimal Valor total bruto do item (2 casas decimais).

example: 199.9

valorTotalCusto (optional)

BigDecimal Valor total de custo do item (2 casas decimais).

example: 150.0

valorTotalLiquido (optional)

BigDecimal Valor total líquido do item (2 casas decimais).

example: 189.9

vendaComDesconto (optional)

BigDecimal Valor da venda considerando o desconto (4 casas decimais).

example: 189.5678

vlrCustoAquisicao (optional)

BigDecimal Custo de aquisição do produto (4 casas decimais).

example: 75.1234

vlrCustoProduto (optional)

Double Custo cadastrado do produto. format: double

example: 75.12

vlrDesconto (optional)

Double Valor de desconto em moeda. format: double

example: 10.0

vlrUnitario (optional)

Double Valor unitário do produto. format: double

example: 99.95

`VendasVendedorIntegracaoDto` Up

Dados de vendas por vendedor para integração.

codigoVendedor (optional)

Integer Código do vendedor. format: int32

example: 789

dataEmissao (optional)

Date Data de emissão em formato ISO 8601. format: date-time

quantidadeAtendimentos (optional)

Integer Quantidade de atendimentos realizados. format: int32

example: 10

quantidadeItens (optional)

Integer Quantidade de itens vendidos. format: int32

example: 50

`VendedorEcommerceIntegracaoDto` Up

Objeto utilizado para informar o vendedor de uma venda e-commerce no PDV.

codigo (optional)

Integer Código do vendedor. format: int32

example: 123

nome (optional)

String Nome do vendedor.

example: Maria

`VendedorIntegracaoDto` Up

Dados de integração do vendedor.

ativo (optional)

Boolean Indica se o vendedor está ativo.

example: true

cep (optional)

String CEP do endereço do vendedor.

example: 88000000

codigo (optional)

Integer Código do vendedor. format: int32

example: 123

email (optional)

String E-mail do vendedor.

example: maria.silva@exemplo.com

nome (optional)

String Nome completo do vendedor.

example: Maria Silva

numeroCpf (optional)

String CPF do vendedor, somente números.

example: 12345678901

`WebhookDto` Up

Objeto que representa o webhook enviado pelo Agilego.

ActionBy (optional)

String Quem realizou a ação.

example: DRIVER

CurrentOrderValue (optional)

Double Valor atual do pedido. format: double

example: 20.0

CustomerOrderCode (optional)

String Código interno do pedido.

example: 001-220

DeliveredTo (optional)

String Nome do recebedor.

example: José

DeliveryOrderId (optional)

Integer Identificador da ordem de entrega. format: int32

example: 540

DeliveryOrderPointId (optional)

Integer Identificador do ponto da ordem de entrega. format: int32

example: 1168

Distance (optional)

Double Distância percorrida em quilômetros. format: double

example: 5.0

DriverName (optional)

String Nome do entregador.

example: Pedro

Lat (optional)

String Latitude da entrega.

example: -30.0296507

Lng (optional)

String Longitude da entrega.

example: -51.1961756

OldOrderValue (optional)

Double Valor antigo do pedido. format: double

example: 12.0

Status (optional)

String Enumeração que representa os possíveis status de um pedido no Agilego.

Enum:

PENDING

FINISHED

CANCELED

IN_PROGRESS

ERROR

example: FINISHED

StoreGroupId (optional)

String Identificador do grupo da loja.

example: 1

StoreGroupName (optional)

String Nome do grupo da loja.

example: PANVEL

StoreId (optional)

String Identificador da loja.

example: 220

SubStatus (optional)

String Enumeração que representa os substatus de um pedido no AgileGO.

Enum:

FINISHING_ANOTHER_ORDER

WAITING_DRIVER

DELIVERED

NOT_DELIVERED

RETURNED

HEADING_TO_PICKUP

PICKED_UP

ON_DELIVER

ADDRESS_NOT_FOUND

CUSTOMER_NOT_FOUND

HEADING_TO_RETURN_PRODUCT

example: DELIVERED

Type (optional)

String Identificador do status.

example: STATUS_UPDATE

UpdateAt (optional)

String Data e hora da atualização do status.

example: 2024-01-04 15:36:53

API-SGF

Access

Table of Contents

Consumes

Request body

Return type

Example data

Produces

Responses

200

400

401

500

Query parameters

Return type

Example data

Produces

Responses

200

400

401

500

Query parameters

Return type

Example data

Produces

Responses

200

400

401

500

Query parameters

Return type

Example data

Produces

Responses

200

400

401

500

Query parameters

Return type

Example data

Produces

Responses

200

400

401

500

Query parameters

Return type

Example data

Produces

Responses

200

400

401

500

Query parameters

Return type

Example data

Produces

Responses

200

400

401

500

Query parameters

Return type

Example data

Produces

Responses

200

400

401

500

Query parameters

Return type

Example data

Produces