A integração consiste em receber e enviar dados do pedido que será incluído no winthor. Totvs custom tabs box items |
---|
default | yes |
---|
referencia | passo1 |
---|
| Os dados integrados são: API | Descrição | Coluna | Tipo | Obrigatório | situacaoPreVenda | 0 = CANCELADA 1 = RECEBIDO 2 = DISPONIVEL 3 = RESGATADAint | SIM | numero | Identificação do pedido no PDV. | PCPEDC.NUMPEDHUBE | String | SIM | modalidadeFrete | Utiliza despacho de frete (freteiros) Valores: "C" - CIF - Contratação do Frete por conta do Remetente ( modalidadeFrete= 0) "F" - FOB - Contratação do Frete por conta do Destinatário ( modalidadeFrete= 1) "T" - Contratação do Frete por conta de Terceiros ( modalidadeFrete= 2) "R" - Transporte Próprio por conta do Remetente ( modalidadeFrete= 3) "D" - Transporte Próprio por conta do Destinatário ( modalidadeFrete= 4) "G" - Gratuito - Sem Ocorrência de Transporte ( modalidadeFrete= 9) | PCPEDC.FRETEDESPACHO | int | NÃO | observacoes | PCPEDC.OBS | NÃO | idOperadorRetaguarda | Matricula do funcionário. Caso não informado irá usar o RCA do parâmetro 4012. | PCPEDC.CODUSUR | long | NÃO | idLojaRetaguarda | Código da filial. | SIM | preVendaItens.*.quantidade | Deve ser maior que zero. | PCPEDI.QT | int | SIM | preVendaItens.*.preco | Deve ser maior que zero. | PCPEDI.PVENDA | SIM | preVendaItens.*.desconto | Valor de desconto. | NÃO | preVendaItens.*.descontoPercentual | Percentual de desconto. | NÃO | preVendaItens.*.idProdutoRetaguarda | Código auxiliar mais o código do produto. Ex: 123-1. | PCPEDI.CODPROD | SIM | preVendaItens.*.idVendedorRetaguarda | NÃO | preVendaItens.*.entrega.idRetaguardaLojaEntrega | Código da filial retira. | PCPEDI.CODFILIAL | SIM | preVendaItens.*.entrega.tipoEntrega | 0 = RETIRA_IMEDIATA("RI", "Retira Imediata"), 1 = RETIRA_POSTERIOR("RP", "Retira Posterior"), 2 = ENTREGA_NORMAL("EN", "Entrega Normal") 3 = ENCOMENDA("EF", "Encomenda") | PCPEDI.TIPOENTREGA | SIM | preVendaItens.*.entrega.dataEntrega | Data da entrega do item | PCPEDI.DTENTREGA | cliente | Caso não seja informado o cliente será usado o cliente consumidor final. Caso o cliente esteja com o cadastro completo, ele já será gravado na base do winthor . | NÃO | cliente.bairro | Este campo é obrigatório para gravar o cliente, caso não seja informado o cliente não será gravado e será usado o cliente consumidor final para gerar a reserva de estoque | NÃO | cliente.telefone | Caso não preenchido será usado o campo celular | NÃO | cliente.celular | Caso não preenchido será usado o campo telefone | NÃO | cliente.cep | Este campo é obrigatório para gravar o cliente, caso não seja informado o cliente não será gravado e será usado o cliente consumidor final para gerar a reserva de estoque | NÃO | cliente.cidade | Este campo é obrigatório para gravar o cliente, caso não seja informado o cliente não será gravado e será usado o cliente consumidor final para gerar a reserva de estoque | NÃO | cliente.complemento | NÃO | cliente.cpfCnpj | Este campo é obrigatório para gravar o cliente, caso não seja informado o cliente não será gravado e será usado o cliente consumidor final para gerar a reserva de estoque Caso já exista um cliente com mesmo CGC e o idRetaguarda não seja informado será usado o cliente mais antigo que contém o mesmo CGC NÃO | cliente.email | Este campo é obrigatório para gravar o cliente, caso não seja informado o cliente não será gravado e será usado o cliente consumidor final para gerar a reserva de estoque | NÃO | cliente.endereco | Este campo é obrigatório para gravar o cliente, caso não seja informado o cliente não será gravado e será usado o cliente consumidor final para gerar a reserva de estoque | NÃO | cliente.estado | Este campo é obrigatório para gravar o cliente, caso não seja informado o cliente não será gravado e será usado o cliente consumidor final para gerar a reserva de estoque | NÃO | cliente.idRetaguarda | Código cliente | NÃO | cliente.numero | NÃO | VendaPagamentos.valorLiquido | Valor líquido | PCFORMAPGTOPEDIDO.VALOR | SIM | VendaPagamentos.pagamentoForma.idRetaguarda | Forma de pagamento | PCFORMAPGTOPEDIDO.CODCOB | SIM | VendaPagamentos.pagamentoForma.descricao | Descrição da forma de pagamento | NÃO | VendaPagamentos.vendaPagamentoItems.valorParcela | Valor da parcela | PCFORMAPGTOPEDIDO.VALOR (Só utilizado caso cobrança cartão com parcelas) | NÃO | VendaPagamentos.vendaPagamentoItems.dataVencimento | Data de vencimento da parcelaVLFRETE | PCFORMAPGTOPEDIDO.DTVENC (Só utilizado caso cobrança cartão com parcelas) | NÃO | PreVendaPagamentos.vendaPagamentoTefs.nsuHost | NSU | PCFORMAPGTOPEDIDO.NSU (Só utilizado caso cobrança cartão com parcelas) | NÃO | Caso seja enviado o valor do frete maior que zero, o campo (PCPEDC.DTCALCFRETE) será preenchido. | PCPEDC.DTCALCFRETE | Data (DD/MM/YYY) | NÃO | Totvs custom tabs box items |
---|
default | no |
---|
referencia | passo2 |
---|
| Exemplo do envio da requisição: Bloco de código |
---|
| method: 'POST',
url: '/api/wholesale/v1/orders/pdvsync'
|
Bloco de código |
---|
language | js |
---|
title | Body Request |
---|
| {
"NumeroVenda": null,
"TipoPreVenda": 1,
"Data": "2023-04-13T16:33:29.946503",
"CpfConsumidor": null,
"CpfCliente": "03425067141",
"DescontoTotal": 0.0,
"TotalLiquido": 6.130000,
"TotalBruto": 6.130000,
"IdLojaRetaguarda": 1,
"CodigoPromocional": null,
"situacaoPreVenda": "RECEBIDO",
"modalidadeFrete": "2",
"NomeConsumidor": null,
"EnderecoCliente": "RUA GIOTO",
"NomeCliente": "Cliente 0123",
"IdOperadorRetaguarda": 1,
"SistemaOrigem": 1,
"TerminalOrigem": null,
"TipoEntrega": 0,
"Sincronizado": 0,
"TipoDescontoAcrescimo": null,
"DescontoPercentualTotal": 0.0,
"IdMotivoDesconto": null,
"DescricaoMotivoDescontoAcrescimo": null,
"IdTransacaoMotorPromocaoTerceiro": null,
"SerieVenda": null,
"NumeroAutorizacao": null,
"TipoVenda": 1,
"TipoCancelamento": null,
"IdCanalVenda": null,
"DescontoMotorPromocaoAplicado": false,
"PreVendaItens": [
{
"quantidade": 1.0,
"preco": 24.9,
"desconto": 0.0,
"descontoPercentual": 0.0,
"idProdutoRetaguarda": "3-3",
"idVendedorRetaguarda": "1",
"entrega": {
"idLojaEntregaRetaguarda": "1",
"TipoEntrega": 1,
"dataEntrega": "2022-04-25T17:08:56.18511"
}
}
],
"vendaPagamentos": [
{
"valorLiquido": 1.0,
"valorPago": 24.9,
"valorTroco": 0.0,
"idPagamentoCondicaoRetaguarda": 0.0,
"pagamentoForma":
{
"descricao": "DINHEIRO EM TRANSITO",
"idRetaguarda": "DH"
},
"vendaPagamentoItems": [
{
"dataVencimento": "2022-05-10T17:08:56.18511",
"valorParcela": 24.9,
"numeroParcela": 1
}
]
}
],
"Cliente": {
"Nome": "Cliente alterar",
"Endereco": "RUA GIOTO",
"Numero": "S/N",
"Complemento": "",
"Bairro": "SETOR GENTIL",
"Cidade": "GOIANIA",
"Estado": "GO",
"Cep": "74916-100",
"Telefone": "",
"Celular": "62900000000",
"Email": "[email protected]",
"DataNascimento": "2001-04-01T00:00:00",
"PessoaFisica": 1,
"CpfCnpj": "40141279079",
"RgInscricao": "6346333",
"Sexo": 2,
"EstadoCivil": 2,
"AvatarUrl": "",
"Enviarpnet": 0,
"Atividade": null,
"Cracha": null,
"Situacao": 1,
"Id": 4,
"IdRetaguarda": "00000000-0000-0000-0000-000000000000",
"DataCadastro": "2023-03-29T13:51:38.556565",
"DataAtualizacao": "2023-03-29T13:51:38.55657",
"_expandables": []
},
"Situacao": 0,
"IdRetaguarda": 54382,
"Id": "20230612140631122023235",
"numero": "20230612140631122023235",
"DataCadastro": "2023-04-13T16:32:45.651279",
"DataAtualizacao": "2023-04-13T16:33:30.123302",
"_expandables": []
} |
Bloco de código |
---|
language | js |
---|
title | Body Response |
---|
| {
"success": true,
"hasNext": false,
"message": "",
"data": {
"idRetaguardaPedido": "1007217",
"cliente": {
"idRetaguardaClienteidProdutoRetaguarda": "7707891132007998-1186",
},
"messageidVendedorRetaguarda": "RCA-5",
"success": true
}
} |
| Totvs custom tabs box items |
---|
default | no |
---|
referencia | passo3 |
---|
| Exemplo do envio da requisição: Bloco de código |
---|
language | text |
---|
title | URI lista de pedidos |
---|
| method: 'POST',
url: '/api/wholesale/v1/orders/pdvsync/consulta'
|
Bloco de código |
---|
| idRetaguarda : 0 - Número do Pedido no WinThor
idLojaRetaguarda : 2 - Código da Filial **requerido**
cpfCliente : String - CPF ou CNPJ do cliente
nomeCliente : String - Nome do Cliente
idOperadorRetaguarda : String - Código do Vendedor no WinThor
dataInicio : Timestamp - Data inicial da busca (Formato: 2023-07-25T11:43:45.086336)
dataFim : Timestamp - Data final da busca (Formato: 2023-07-25T11:43:45.086336)
idClienteRetaguarda : 0 - Código do Cliente no WinThor |
Bloco de código |
---|
language | js |
---|
title | Body Request |
---|
| {
"success": true,
"hasNext": false,
"message": "",
"data": [
"itensKit": [
],
"preco": 72.45,
"quantidade": 1,
"quantidadeEncomenda": 0
}
],
"preVendaPagamentos": [
{
"pagamentoCondicao": {
"idRetaguarda": "1"
},
"pagamentoForma": {
"idRetaguarda": "D"
{},
"offlinequantidadeParcelas": false0,
"idRetaguardavalorPago": "10000908",
72.45
}
],
"situacaoPreVenda": "DISPONIVEL",
"totalBruto": 72.45,
"idLojaRetaguardatotalLiquido": "2",72.45
},
"hasNext": false,
"idOperadorRetaguardamessage": "10",
"success": true
} |
Quando o pedido for TV1 será apresentado os dados da embalagem no objeto produtoEmbalagem nas especificações da preVendaItens: Bloco de código |
---|
language | js |
---|
title | Body Response |
---|
| {
"totalLiquidosuccess": 75.22true,
"descontoPercentualTotalhasNext": 9.991624false,
"acrescimoPercentualTotalmessage": 0"",
"totalBrutodata": 83.57,
{
"multiplosPedidosidRetaguarda": false"1002043",
"dataCadastro": "2023-08-02T23:27:00"
"cliente": {
}
]
} |
Bloco de código |
---|
language | text |
---|
title | URI pedido detalhado |
---|
| method: 'POST',
url: '/api/wholesale/v1/orders/pdvsync/consulta/{idRetaguarda}'
|
Bloco de código |
---|
language | js |
---|
title | Body Response |
---|
| {
"nome": "COD. 10 - CLI DA FILIAL 7",
"success"endereco": "END. ENT. CLI.: true10",
"bairro"hasNext": "BAIRRO ENT. CLI.: false10",
"messageestado": "DF",
"datacep": {
"74000000",
"offlinetelefone": false"62999988998",
"idRetaguardacelular": "1000090862999988998",
"clienteemail": {"[email protected]",
"nomecpfCnpj": "COD. 10 - CLI DA FILIAL 707.577.599/0005-01",
"enderecoidRetaguarda": "END. ENT. CLI.: 10",
10"
},
"numerosituacaoPreVenda": "DISPONIVEL",
"complementopreVendaItens": "",[
"bairro": "BAIRRO ENT. CLI.: 10",
{
"cidadequantidade": ""12,
"estadopreco": "GO"206.470109,
"cepdescontoPercentual": "74000000"0,
"telefoneacrescimoPercentual": "TELENT.: 10"0,
"celularquantidadeEncomenda": "TELENT.: 10"0,
"emailidPreVenda": "[email protected]"0,
"cpfCnpjidProdutoRetaguarda": "79.621.574/0007-22100-1",
"idRetaguardaidProdutoEmbalagemRetaguarda": "10125-1",
"clienteAlteradoidVendedorRetaguarda": false"RCA-1",
},
"situacaoPreVendaentrega": "DISPONIVEL",
{
"preVendaItens": [
"idLojaEntregaRetaguarda": "1",
{
"quantidadetipoEntrega": "1,"
"preco": 75.215471},
"descontoitensKit": 0[],
"descontoPercentualprodutoEmbalagem": 10,{
"acrescimoPercentual": 0,
"descricao": "COD.: 1 - ICCOD.: 1 - ICCOD.: 1 - ICCOD",
"quantidadeEncomenda": 0,
"idPreVendacodigoBarras": 0,
"125",
"idProdutoRetaguardaquantidadeValorAtacado": "304-13"0,
"entregaunidadeMedida": {"UN",
"idLojaEntregaRetaguardaquantidade": "2"1,
"tipoEntregasituacao": "2"1
}
}
],
"preVendaPagamentos": [
{
"valorPago": 752477.2264,
"pagamentoForma": {
"idRetaguarda": "BK"
},
"CARD"
"pagamentoCondicao": {
},
"idRetaguarda": "1"
"pagamentoCondicao": {
"idRetaguarda": 1
},
"quantidadeParcelas": 10
}
],
"idLojaRetaguarda": "21",
"idOperadorRetaguarda": "101",
"totalLiquido": 752477.2264,
"descontoPercentualTotal": 9.9916240,
"descontoTotal": 0,
"acrescimoPercentualTotal": 0,
"acrescimoTotal": 0,
"totalBruto": 832477.5764,
"multiplosPedidosdataCadastro": false"2025-03-06T17:51:00",
"dataCadastrodataAtualizacao": "20232025-0803-02T2306T00:2700:00"
}
} |
|
|