TOTVS Varejo PDV Omni

Árvore de páginas

Versões comparadas

Versão antiga 2

changes.mady.by.user Erik Lopes Vitelli

Gravado em

comparado com

Nova versão 3

changes.mady.by.user Geovani Lima Azevedo

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Expandir
titleDefinição dos campos de retorno
Expandir
title200 - Ok
Expandir
titleExemplo do retorno 200

{
    "success": true,
    "message": "string",
    "data": [
        {
            "tipo": 0,
            "status": 0,
            "conteudo": "string",
            "idVendaRetaguarda": "string",
            "numeroLoja": "string",
            "dataTroca": "dateTime",
            "valorTotal": "Decimal",
            "id": "string",
            "idInquilino": "string",
            "idRetaguarda": "string",
            "dataAtualizacao": "dateTime",
            "dataCadastro": "dateTime",
            "idProprietario": "string",
            "loteOrigem": "string",
            "lote": "string"
        }
    ],
    "errors": null,
    "totalTime": 0,
    "numberOfRecords": 0
}

Expandir
titleDefinições do retorno 200

Campo

Tipo

Descrição

successBooleanoIndica se a criação do compartilhamento foi feita com sucesso
messageStringCaso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo
dataLista de ObjetosLista com as trocasretornadas
data.tipoInteiroTipo da troca
data.statusInteiroStatus da troca
data.conteudoStringConteúdo da troca em base64 *
data.idVendaRetaguardaStringIdentificador da venda na retaguarda
data.numeroLojaStringNúmero da loja
data.dataTrocaData/HoraData da troca
data.valorTotalDecimalValor da troca
data.idStringIdentificador da troca no POSH
data.idInquilinoStringIdentificador do inquilino
data.idRetaguardaStringIdentificador da troca na retaguarda
data.dataAtualizacaoData/HoraUltima atualização da troca
data.dataCadastroData/HoraData de cadastro da troca
data.idProprietarioStringIdentificador do proprietário
data.loteOrigemStringIdentificador do lote
data.loteStringIdentificador do lote
errorsLista de objetosListas com os erros encontrados no processo
totalTimeInteiroTempo da requisição
numberOfRecordsInteiroNúmero de linhas afetadas
Expandir
title* Conteúdo da Troca
  • 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"
}

  • Campos

Campo

Tipo

Descrição

VendaPagamentoIdInteiroCódigo Id da Venda Pagamento
IdVendaRetaguardaStringCódigo Retaguarda da Venda
CpfCnpjStringCPF/CNPJ do Cliente
NomeStringNome do Cliente
MotivoIdInteiroCódigo Id do Motivo da Troca
MotivoObjetoInformações do Motivo da Troca
Motivo.IdRetaguardaStringCódigo Retaguarda do Motivo
Motivo.DescricaoStringDescrição do Motivo
DataTrocaData/HoraData da Troca
ValorTotalDecimalValor Total da Troca
TrocaItemsLista de ObjetosLista de Itens da Troca
TrocaItems[0].IdItemRetaguardaStringCódigo Retaguarda do Item de Troca
TrocaItems[0].TrocaIdInteiroCódigo Id do Item de Troca
TrocaItems[0].ProdutoIdInteiroCódigo Id do Produto
TrocaItems[0].ProdutoObjetoProduto do Item de Troca
TrocaItems[0].Produto.idInteiroCódigo Id do Produto
TrocaItems[0].Produto.idRetaguardaStringCódigo Retaguarda do Produto
TrocaItems[0].Produto.codigoProdutoStringCódigo do Produto
TrocaItems[0].Produto.descricaoStringDescrição do Produto
TrocaItems[0].ValorDecimalValor de Venda do Produto
TrocaItems[0].QuantidadeDecimalQuantidade
TrocaItems[0].SituacaoInteiro

Situação, sendo:

  • 0 - Inativo
  • 1 - Ativo
TrocaItems[0].IdRetaguardaStringCódigo Retaguarda do Item de Troca
TrocaItems[0].IdInteiroCódigo Id do Item de Troca
TrocaItems[0].DataCadastroData/HoraData de Cadastro
TrocaItems[0].DataAtualizacaoData/HoraData de Atualização
SituacaoInteiro

Situação, sendo:

  • 0 - Inativo
  • 1 - Ativo
IdRetaguardaStringCódigo Retaguarda da Troca
IdInteiroCódigo Id da Troca
DataCadastroData/HoraData de Cadastro da Troca
DataAtualizacaoData/HoraData de Atualização da Troca



Expandir
title400 - Bad Request

Campo

Tipo

Descrição

SuccessboolIndica se a criação do compartilhamento foi feita com sucesso
MessagestringCaso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo
DataobjetoObjeto compartilhamento criado
ErrorsListaListas com os erros encontrados no processo
TotalTimeinttempo da requisição
NumberOfRecordsintnúmero de dados inseridos

...