API do PDVSync.Core.Comercial responsável por obter as Vendas para a atualização de Status da Venda Trocas geradas no PDV Omnishop.Omni
Para acessar os dados a requisição é a seguinte
- Endpoint:
- V2: /api/pdvsyncclient/v2
/vendaMensagens- /TrocaMensagens/{idInquilino}
- V3: /api/pdvsyncclient/v3/TrocaMensagens/{idInquilino}
- Método: GET
- Autenticação: Bearer token
- Permissão: Client
...
| Expandir |
|---|
| title | Definição dos campos de retorno |
|---|
|
| Expandir |
|---|
| | Expandir |
|---|
| title | Exemplo do retorno 200 |
|---|
| {
"success": true,
"message": "string",
"data": [
{
"ccftipo": "string"0,
"chaveAcessostatus": "string"0,
"conteudo": "string",
"cupomidVendaRetaguarda": "string",
"dataEmissao": "dateTime",
"numeroLoja": "string",
"observacaodataTroca": "stringdateTime",
"pdvvalorTotal": "string",
"serieNota": "string",
"status": 0,
"tipo": 0,
"valorBruto": "Decimal",
"situacaoVenda": 0,
"id": "string",
"idInquilino": "string",
"idRetaguarda": "string",
"dataAtualizacao": "dateTime",
"dataCadastro": "dateTime",
"idProprietario": "string",
"loteOrigem": "string",
"lote": "string"
}
],
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
} |
| Expandir |
|---|
| title | Definições do retorno 200 |
|---|
| Campo | Tipo | Descrição |
|---|
| success | Booleano | Indica se a criação do compartilhamento foi feita com sucesso | | message | String | Caso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo | | data | Lista de Objetos | Lista com |
a vendas retornadasccfStringCCF vendachaveAcessoString | Chave de acesso| Inteiro | Status da troca | | data.conteudo | String | Conteúdo da |
venda cupomCupom | data.dataEmissao | Data/Hora | Data de emissão | | data.numeroLoja | String | Número da loja | | data. |
observacaoString | Observação | | Data/Hora | Data da troca | | data.valorTotal | Decimal | Valor da troca | | data. |
| data.pdv | String | PDV onde foi feita a venda | | data.serieNota | String | Serie nota | | data.status | Inteiro | Status da venda | | data.tipo | Inteiro | Tipo da venda | | data.valorBruto | Decimal | Valor bruto da venda | | data.situacaoVenda | Inteiro | Situação da venda | data. venda | troca no POSH | | data.idInquilino | String | Identificador do inquilino | | data.idRetaguarda | String | Identificador da |
venda | troca na retaguarda | | data.dataAtualizacao | Data/Hora | Ultima |
data de venda| troca | | data.dataCadastro | Data/Hora | Data |
em que a venda foi cadastrada no PDV| de cadastro da troca | | data.idProprietario | String | Identificador do proprietário | | data.loteOrigem | String | Identificador do lote | | data.lote | String | Identificador do lote | | errors |
Nulo| Lista de objetos | Listas com os erros encontrados no processo | | totalTime | Inteiro |
tempo | Tempo da requisição | | numberOfRecords | Inteiro |
Linha afetadas| Número de linhas afetadas |
| Expandir |
|---|
| - Body de Envio (Base64 decodificado)
{
"VendaPagamentoId": 0,
"IdVendaRetaguarda": "00000000-0000-0000-0000-000000000000",
"CpfCnpj": "string",
"Nome": "string",
"MotivoId": 0,
"Motivo": {
"IdRetaguarda": "00000000-0000-0000-0000-000000000000",
"Descricao": "string"
},
"DataTroca": "2024-08-15T16:25:42.04222",
"ValorTotal": 0.0,
"TrocaItems": [
{
"IdItemRetaguarda": "string",
"TrocaId": 0,
"ProdutoId": 0,
"Produto": {
"id": 0,
"idRetaguarda": "string",
"codigoProduto": "string",
"descricao": "string"
},
"Valor": 0.0,
"Quantidade": 0.0,
"Situacao": 0,
"IdRetaguarda": "string",
"Id": 0,
"DataCadastro": "2024-08-15T16:25:42.083797",
"DataAtualizacao": "2024-08-15T16:25:42.083798"
}
],
"Situacao": 1,
"IdRetaguarda": "string",
"Id": 21,
"DataCadastro": "2024-08-15T16:25:42.04222",
"DataAtualizacao": "2024-08-15T16:25:42.051398"
} Campo | Tipo | Descrição |
|---|
| VendaPagamentoId | Inteiro | Código Id da Venda Pagamento | | IdVendaRetaguarda | String | Código Retaguarda da Venda | | CpfCnpj | String | CPF/CNPJ do Cliente | | Nome | String | Nome do Cliente | | MotivoId | Inteiro | Código Id do Motivo da Troca | | Motivo | Objeto | Informações do Motivo da Troca | | Motivo.IdRetaguarda | String | Código Retaguarda do Motivo | | Motivo.Descricao | String | Descrição do Motivo | | DataTroca | Data/Hora | Data da Troca | | ValorTotal | Decimal | Valor Total da Troca | | TrocaItems | Lista de Objetos | Lista de Itens da Troca | | TrocaItems[0].IdItemRetaguarda | String | Código Retaguarda do Item de Troca | | TrocaItems[0].TrocaId | Inteiro | Código Id do Item de Troca | | TrocaItems[0].ProdutoId | Inteiro | Código Id do Produto | | TrocaItems[0].Produto | Objeto | Produto do Item de Troca | | TrocaItems[0].Produto.id | Inteiro | Código Id do Produto | | TrocaItems[0].Produto.idRetaguarda | String | Código Retaguarda do Produto | | TrocaItems[0].Produto.codigoProduto | String | Código do Produto | | TrocaItems[0].Produto.descricao | String | Descrição do Produto | | TrocaItems[0].Valor | Decimal | Valor de Venda do Produto | | TrocaItems[0].Quantidade | Decimal | Quantidade | | TrocaItems[0].Situacao | Inteiro | Situação, sendo: | | TrocaItems[0].IdRetaguarda | String | Código Retaguarda do Item de Troca | | TrocaItems[0].Id | Inteiro | Código Id do Item de Troca | | TrocaItems[0].DataCadastro | Data/Hora | Data de Cadastro | | TrocaItems[0].DataAtualizacao | Data/Hora | Data de Atualização | | Situacao | Inteiro | Situação, sendo: | | IdRetaguarda | String | Código Retaguarda da Troca | | Id | Inteiro | Código Id da Troca | | DataCadastro | Data/Hora | Data de Cadastro da Troca | | DataAtualizacao | Data/Hora | Data de Atualização da Troca |
|
|
|
| Expandir |
|---|
| Campo | Tipo | Descrição |
|---|
| Success | bool | Indica se a criação do compartilhamento foi feita com sucesso | | Message | string | Caso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo | | Data | objeto | Objeto compartilhamento criado | | Errors | Lista | Listas com os erros encontrados no processo | | TotalTime | int | tempo da requisição | | NumberOfRecords | int | número de dados inseridos |
|
|
...
