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 = RESGATADA |
| int | 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 | idRetaguardaProfissional | - "RCA-9999"
- Quando iniciado por RCA, gravará o código no campo PCPEDC.CODUSUR2
- O código precisa existir na PCUSUARI, para TIPOVEND = 'P'
- "PRO-9999"
- Quando iniciado por PRO, gravará o código no campo PCPEDC.CODPROFISSIONAL
- O código precisa existir na PCPROFISSIONAL
| Código do profissional informado com os seguintes prefixos: - PRO-codigoDoProfissional (Rotina 4140)
- RCA-codigoDoRCAProfissional (Rotina 517)
| String | 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 | freteTotal | Campo preenchido no caso de teste unitário |
| int | 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 | codigoCobranca | Caso seja enviado, será adicionado na tabela PCPEDC.CODCOB o valor. Caso valor esteja vazio na hora da reserva, assumira um valor default. | PCPEDC.CODCOB | String | NAO |
|
Totvs custom tabs box items |
---|
default | no |
---|
referencia | passo2 |
---|
| Exemplo do envio da requisição:
Bloco de código |
---|
| method: 'POST',
url: '/winthor/varejo/matcon/v1/orders/pdvsync'
|
Bloco de código |
---|
language | js |
---|
title | Body Request |
---|
| {
"cliente": {
"bairro": "DOUTOR GUSMAO",
"celular": null,
"cep": "45821610",
"cidade": "EUNAPOLIS",
"clienteAlterado": false,
"complemento": "PRACA GETULIO VARGAS",
"cpfCnpj": "24416863802",
"dataNascimento": "1900-01-01T00:00:00",
"email": "[email protected]",
"endereco": "PRACA GETULIO VARGAS",
"enderecos": [],
"estado": "BA",
"estadoCivil": 0,
"id": 1,
"idRetaguarda": "11432",
"idRetaguardaProfissional": "PRO-83",
"nome": "Kamilly Patrícia Cecília Gonçalves",
"numero": "952",
"pessoaFisica": 1,
"rgInscricao": null,
"sexo": 0,
"telefone": "01145838800"
},
"codigoPromocional": null,
"cpfConsumidor": "24416863802",
"data": "2024-12-26T08:09:42.300411",
"dataAtualizacao": "2024-12-26T08:09:42.632439",
"dataCadastro": "2024-12-26T08:06:05.253263",
"descontoPercentualTotal": 0.0,
"descontoTotal": 0.0,
"fretePercentualTotal": 0.0,
"freteTotal": 0.0,
"id": {{$randomInt}},
"idCanalVendaRetaguarda": null,
"idInquilino": "MATCONHML",
"idLojaRetaguarda": "1",
"idOperadorRetaguarda": "244",
"idRetaguarda": null,
"idRetaguardaProfissional": "PRO-83",
"modalidadeFrete": 0,
"motivoDesconto": null,
"multiplosPedidos": false,
"nomeConsumidor": "Kamilly Patrícia Cecília Gonçalves",
"numero": "{{$randomInt}}",
"numeroAutorizacao": null,
"numeroPdv": 33,
"numeroVenda": null,
"preVendaItens": [
{
"acrescimo": 0.0,
"acrescimoPercentual": 0.0,
"dataAtualizacao": "2024-12-26T08:09:42.802469",
"dataCadastro": "2024-12-26T08:09:42.802467",
"desconto": 0.0,
"descontoPercentual": 0.0,
"entrega": {
"dataEntrega": "2024-12-26T00:00:00",
"idLojaEntregaRetaguarda": "1",
"lockerMachineCode": null,
"lockerParcelCode": null,
"tipoEntrega": 1
},
"frete": 0.0,
"fretePercentual": 0.0,
"id": 356,
"idPrecoRetaguarda": null,
"idPreVenda": {{$randomInt}},
"idProdutoEmbalagemRetaguarda": null,
"idProdutoRetaguarda": "17891132007469-860",
"idVendedorRetaguarda": "RCA-107",
"itensKit": null,
"motivoDesconto": null,
"ordemItem": 1,
"preco": 13337.0,
"quantidade": 10.0,
"quantidadeEncomenda": 0.0,
"quantidadeFaturada": 0.0,
"situacao": 1,
"tipoValorFrete": 0
}
],
"preVendaPagamentos": null,
"serieVenda": null,
"sincronizado": 0,
"sistemaOrigem": 1,
"situacao": 1,
"situacaoPreVenda": "DISPONIVEL",
"terminalOrigem": null,
"tipoCancelamento": 0,
"tipoDescontoAcrescimo": 0,
"tipoEntrega": 0,
"tipoPreVenda": 1,
"tipoValorFrete": 0,
"tipoVenda": 1,
"totalBruto": 13337.0,
"totalLiquido": 13337.0,
"vendaPagamentos": null
} |
Bloco de código |
---|
language | js |
---|
title | Body Response |
---|
| {
"success": true,
"hasNext": false,
"message": "",
"data": {
"idPedidoRetaguarda": "107000169",
"cliente": {
"id": "1",
"idRetaguarda": "11432"
}
}
} |
|
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: 'GET',
url: '/winthor/varejo/matcon/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
rescueTv1 : false - Resgata pedido TV1 |
Bloco de código |
---|
language | js |
---|
title | Body Response |
---|
| {
"data": [
{
"acrescimoPercentualTotal": 0,
"acrescimoTotal": 0,
"cliente": {
"cpfCnpj": "15376770000100",
"nome": "BETINA BETINA TIPO TEXTO"
},
"dataCadastro": "2024-12-18T23:48:00",
"descontoPercentualTotal": 0,
"descontoTotal": 0,
"freteTotal": 0,
"idLojaRetaguarda": "1",
"idOperadorRetaguarda": "244",
"idRetaguarda": "5002664",
"idRetaguardaProfissional": "PRO-83",
"situacaoPreVenda": "DISPONIVEL",
"totalBruto": 195.38,
"totalLiquido": 195.38
}
],
"hasNext": false,
"message": "",
"success": true
} |
Bloco de código |
---|
language | text |
---|
title | URI pedido detalhado |
---|
| method: 'GET',
url: '/winthor/varejo/matcon/v1/orders/pdvsync/consulta/{idRetaguarda}'
|
Bloco de código |
---|
language | js |
---|
title | Body Response |
---|
| {
"data": {
"acrescimoPercentualTotal": 0,
"acrescimoTotal": 0,
"cliente": {
"bairro": "SETOR CENTRAL",
"celular": "6635666786",
"cep": "76740970",
"cpfCnpj": "15376770000100",
"email": "[email protected]",
"endereco": "Rua Noronha 215",
"estado": "MT",
"idRetaguarda": "1257",
"nome": "BETINA BETINA TIPO TEXTO",
"telefone": "6635666786"
},
"dataAtualizacao": "2024-12-18T00:00:00",
"dataCadastro": "2024-12-18T22:11:00",
"descontoPercentualTotal": 0,
"descontoTotal": 0,
"freteTotal": 0,
"idLojaRetaguarda": "1",
"idOperadorRetaguarda": "244",
"idRetaguarda": "5002663",
"idRetaguardaProfissional": "RCA-113",
"preVendaItens": [
{
"acrescimoPercentual": 0,
"descontoPercentual": 0,
"entrega": {
"idLojaEntregaRetaguarda": "1",
"tipoEntrega": "SEM_TIPO_DEFINIDO"
},
"idPreVenda": 0,
"idProdutoEmbalagemRetaguarda": "7891132007998-1186",
"idProdutoRetaguarda": "7891132007998-1186",
"idVendedorRetaguarda": "RCA-5",
"itensKit": [
],
"preco": 72.45,
"quantidade": 1,
"quantidadeEncomenda": 0
}
],
"preVendaPagamentos": [
{
"pagamentoCondicao": {
"idRetaguarda": "1"
},
"pagamentoForma": {
"idRetaguarda": "D"
},
"quantidadeParcelas": 0,
"valorPago": 72.45
}
],
"situacaoPreVenda": "DISPONIVEL",
"totalBruto": 72.45,
"totalLiquido": 72.45
},
"hasNext": false,
"message": "",
"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 |
---|
| {
"success": true,
"hasNext": false,
"message": "",
"data": {
"idRetaguarda": "1002043",
"cliente": {
"nome": "COD. 10 - CLI DA FILIAL 7",
"endereco": "END. ENT. CLI.: 10",
"bairro": "BAIRRO ENT. CLI.: 10",
"estado": "DF",
"cep": "74000000",
"telefone": "62999988998",
"celular": "62999988998",
"email": "[email protected]",
"cpfCnpj": "07.577.599/0005-01",
"idRetaguarda": "10"
},
"situacaoPreVenda": "DISPONIVEL",
"preVendaItens": [
{
"quantidade": 12,
"preco": 206.470109,
"descontoPercentual": 0,
"acrescimoPercentual": 0,
"quantidadeEncomenda": 0,
"idPreVenda": 0,
"idProdutoRetaguarda": "100-1",
"idProdutoEmbalagemRetaguarda": "125-1",
"idVendedorRetaguarda": "RCA-1",
"entrega": {
"idLojaEntregaRetaguarda": "1",
"tipoEntrega": "1"
},
"itensKit": [],
"produtoEmbalagem": {
"descricao": "COD.: 1 - ICCOD.: 1 - ICCOD.: 1 - ICCOD",
"codigoBarras": "125",
"quantidadeValorAtacado": 0,
"unidadeMedida": "UN",
"quantidade": 1,
"situacao": 1
}
}
],
"preVendaPagamentos": [
{
"valorPago": 2477.64,
"pagamentoForma": {
"idRetaguarda": "BK"
},
"pagamentoCondicao": {
"idRetaguarda": "1"
},
"quantidadeParcelas": 0
}
],
"idLojaRetaguarda": "1",
"idOperadorRetaguarda": "1",
"totalLiquido": 2477.64,
"descontoPercentualTotal": 0,
"descontoTotal": 0,
"acrescimoPercentualTotal": 0,
"acrescimoTotal": 0,
"totalBruto": 2477.64,
"dataCadastro": "2025-03-06T17:51:00",
"dataAtualizacao": "2025-03-06T00:00:00"
}
} |
|
|