Histórico da Página

Informações
Este método é responsável pela

...

consulta de pedidos de pré-venda disponíveis na retaguarda.

Ao realizarmos uma requisição na API de ProcessoOnlinePreVendaConsulta, será gerada uma consulta simplificada (lista) de pedidos da pré-venda.

Deck of Cards

id	requisicoes_sync_retaguarda

Card

label	Requisição PDV OMNI -> PDV SYNC

Endpoint: /api/pdvsyncserver/retaguarda/v2/

...

Quantidade de itens da página

ProcessoOnlinePreVendaConsulta
Método: POST
Autenticação: Bearer token
Permissão: Client

Body da requisição

Deck of Cards

id	credito_consulta_get

Card

label	Definição das propriedades

Campo	Tipo	Descrição	Obrigatório
IdInquilino	String

Identintificador

Identificador do inquilino

DataInicio

Sim

Datetime

IdLojaRetaguarda

Data de início

DataFim

Datetime

Data Fim

CpfCnpj

String

Cpf ou Cnpj

Serie

String

Serie

Cupom

String

Cupom

IdRetaguardaProduto

String

Identificador do Produto na retaguarda

IdRetaguardaLoja

String

Identificador da loja na retaguarda

Tipo

Lista de String

Tipos

Pagina

Int

Página

String	Identiticador da loja na retaguarda	Sim
IdOperadorRetaguarda	String	Identificador do operador na retaguarda	Não
CpfCnpj	String	CPF ou CNPJ do cliente	Não
Nome	String	Nome do cliente	Não
IdClienteRetaguarda	String	Identificador do cliente na retaguarda	Não
DataInicio	Data/Hora	Data início	Não
DataFim	Data/Hora	Data fim	Não

ItensPagina

Int

Card

label	Body

{
"idInquilino": "string",
"

dataInicio

idLojaRetaguarda": "

2024-06-13T18:13:32.029Z

string",
"

dataFim

idOperadorRetaguarda": "

2024-06-13T18:13:32.029Z

string",
"cpfCnpj": "string",
"

serie

nome": "string",
"

cupom

idClienteRetaguarda": "string",
"

idRetaguardaProduto

dataInicio": "

string

2024-06-13T18:42:05.318Z",
"

idRetaguardaLoja

dataFim": "

string",
"tipo": [
"string"
],
"pagina": 0,
"itensPagina": 0

2024-06-13T18:42:05.318Z"
}

Retornos

Deck of Cards

id	credito_consulta_get

Card

label	200 - OK

Campo	Tipo	Descrição
Success	Booleano	Indica se a requisição foi feita com sucesso
Message	String	Mensagem de retorno

de erros

em
Data	Lista de Objetos	Lista com

os créditos retornados

as pré-vendas

Data

[]

.

IdRetaguardaLoja

Cliente

StringIdentificador da loja na retaguardaData[].DataHoraStringData e hora da nota

Objeto	Objeto de cliente
Data.Cliente.Nome	String	Nome do cliente
Data.Cliente

Data[]

.CpfCnpj	String	CPF ou CNPJ do cliente
Data

[].ValorTotalDecimalValor total da notaData[].TipoStringTipo da notaData[].QtdItensDecimalQuantidade de itens da notaData[].ItensLista de ObjetosItens da notaData[].Itens[].DescricaoStringDescrição do item Data[].Itens[].ValorUnitarioDecimalValor unitário do itemData[].Itens[].QtdVendidaDecimalQuantidade vendidaData[].Itens[].QtdDisponivelDecimalQuantidade disponívelData[].Itens[].IdRetaguardaCupomItemStringIdentificador do cupom na retaguardaData[].Itens[].IdRetaguardaProdutoStringIdentificador do produto na retaguardaData[].SerieStringSéria da notaData[].IdRetaguardaCupomStringIdentificador do cupom na retaguardaData[].CupomStringCupom

.Offline	Booleano
Data.SituacaoPreVenda	String	Situação da pré-venda
Data.IdLojaRetaguarda	String	Identificação da loja na retaguarda
Data.IdOperadorRetaguarda	String	Identificação do operador na retaguarda
Data.TotalLiquido	Decimal	Total liquido da pré-venda
Data.DescontoPercentualTotal	Decimal	Desconto percentual total da pré-venda
Data.DescontoTotal	Decimal	Desconto total da pré-venda
Data.AcrescimoPercentualTotal	Decimal	Acréscimo Percentual total da pré-venda
Data.AcrescimoTotal	Decimal	Acréscimo total da pré-venda
Data.FreteTotal	Decimal	Valor total do frete
Data.TotalBruto	Decimal	Total bruto da pré-venda
Data.MultiplosPedidos	Booleano	Indica se são múltiplos pedidos
Data.DataCadastro	Data/Hora	Data de cadastro
Data.Id	Inteiro	Id
Data.IdRetaguarda	String	Identificador da pré-venda na retaguarda

Data[].SituacaoStringSituação


Errors	Lista de objetos	Lista de erros
TotalTime	Inteiro	Tempo total da requisição
NumberOfRecords	Inteiro	Número de registros

{
"success": true,
"message": "String",
"data": [
{
"

idRetaguardaLoja

cliente":

"String",

{
"

dataHora

nome": "

13/06/2024 15:19:39

String",
"cpfCnpj": "String"

,

"valorTotal": 0.0

},
"

tipo

offline":

"String"

false,
"

qtdItens

situacaoPreVenda":

0.0

"String",
"

itens

idLojaRetaguarda":

[
{

"String",
"

descricao

idOperadorRetaguarda": "String",

"

valorUnitario

totalLiquido": 0.0,

"

qtdVendida

descontoPercentualTotal": 0.0,

"

qtdDisponivel

descontoTotal": 0.0,

"

idRetaguardaCupomItem

acrescimoPercentualTotal":

"String"

0.0,

"

idRetaguardaProduto

acrescimoTotal":

"String"

0.0,

}

"freteTotal": 0.0,

]

"totalBruto": 0.0,
"

serie

multiplosPedidos":

"String"

false,
"

idRetaguardaCupom

dataCadastro": "

String

0001-01-01T00:00:00",
"

cupom

id":

"String"

0,
"

situacao

idRetaguarda": "String"
}
],
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
}

Card

label	400 - Bad Request

Campo	Tipo	Descrição

Obeservação

Observação
Success	bool	Indica se a requisição foi feita com sucesso
Message	string	Mensagem de retorno de erros
Data	Objeto	Objeto de

retonro

retorno
Errors	Lista de objetos	Lista de erros	Somente é retornado na V3
TotalTime	Int	Tempo total da requisição
NumberOfRecords	Int	Número de registros

{
"success": false,
"message": "string",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
}

Card

label	Requisição PDV SYNC -> ERP Retaguarda

Informações

title	Importante

As informações desta aba diz respeito apenas a comunicação do TOTVS VAREJO PDV OMNI SMART HUB SERVER (PDV) com a API do ERP Retaguarda (PSH, WSH e etc).

frontend - Acesso autorizado apenas para o time responsável (Integrações Sync).

Endpoint: configurável no cadastro de Inquilinos no frontend, através do campo "Endpoint PreVendaConsultaPedido"
Método: GET
Autenticação: definida pelo ERP Retaguarda, vide documentação do frontend
Permissão: Definido pelo ERP Retaguarda

Após o envio do POST, o microserviço se encarrega de transforma-lo em GET para comunicação com ERP Retaguarda e retornar os dados solicitados.

Os parâmetros para a requisição estão abaixo

Campo	Tipo	Descrição	Tipo Parâmetro	Obrigatório
idLojaRetaguarda	string	Identiticador da loja na retaguarda	Parameter/Path/Query Params	Sim
dataInicio	Data/Hora	Data início	Parameter/Path/Query Params	Não
dataFim	Data/Hora	Data fim	Parameter/Path/Query Params	Não
idOperadorRetaguarda	string	Identificador do operador na retaguarda	Parameter/Path/Query Params	Não
cpfCnpj	string	CPF ou CNPJ do cliente	Parameter/Path/Query Params	Não
nome	string	Nome do cliente	Parameter/Path/Query Params	Não
idClienteRetaguarda	string	Identificador do cliente na retaguarda	Parameter/Path/Query Params	Não

Retornos

Deck of Cards

id	prevenda_consulta_get

Card

label	200 - OK

Campo	Tipo	Descrição
Success	Booleano	Indica se a requisição foi feita com sucesso
Message	String	Mensagem de retorno em
Data	Lista de Objetos	Lista com as pré-vendas
Data.Cliente	Objeto	Objeto de cliente
Data.Cliente.Nome	String	Nome do cliente
Data.Cliente.CpfCnpj	String	CPF ou CNPJ do cliente
Data.Offline	Booleano
Data.SituacaoPreVenda	String	Situação da pré-venda
Data.IdLojaRetaguarda	String	Identificação da loja na retaguarda
Data.IdOperadorRetaguarda	String	Identificação do operador na retaguarda
Data.TotalLiquido	Decimal	Total liquido da pré-venda
Data.DescontoPercentualTotal	Decimal	Desconto percentual total da pré-venda
Data.DescontoTotal	Decimal	Desconto total da pré-venda
Data.AcrescimoPercentualTotal	Decimal	Acréscimo Percentual total da pré-venda
Data.AcrescimoTotal	Decimal	Acréscimo total da pré-venda
Data.FreteTotal	Decimal	Valor total do frete
Data.TotalBruto	Decimal	Total bruto da pré-venda
Data.MultiplosPedidos	Booleano	Indica se são múltiplos pedidos
Data.DataCadastro	Data/Hora	Data de cadastro
Data.Id	Inteiro	Id
Data.IdRetaguarda	String	Identificador da pré-venda na retaguarda

{
"success": true,
"message": "String",
"data": [
{
"cliente": {
"nome": "String",
"cpfCnpj": "String"
},
"offline": false,
"situacaoPreVenda": "String",
"idLojaRetaguarda": "String",
"idOperadorRetaguarda": "String",
"totalLiquido": 0.0,
"descontoPercentualTotal": 0.0,
"descontoTotal": 0.0,
"acrescimoPercentualTotal": 0.0,
"acrescimoTotal": 0.0,
"freteTotal": 0.0,
"totalBruto": 0.0,
"multiplosPedidos": false,
"dataCadastro": "0001-01-01T00:00:00",
"id": 0,
"idRetaguarda": "String"
}
]

}

Card

label	400 - Bad Request

Campo	Tipo	Descrição
Success	bool	Indica se a requisição foi feita com sucesso
Message	string	Mensagem de retorno de erros
Data	Objeto	Objeto de retorno

{
"success": false,
"message": "string",
"data": null
}

'

Árvore de páginas

Versões comparadas

Versão antiga 1

Nova versão Atual

Chave

Body da requisição

Retornos

Retornos