Histórico da Página

Objetivo

Este documento tem como objetivo explicar o funcionamento da integração do Cadastro de Cliente.

Pré-Requisitos e Restrições

Necessário a instalação do serviço winthor-pedido-venda. Para realizar a instalação desse serviço, segue link com as devidas explicações:

Comece por aqui -> Parametrizações WTA

Para realizar o cadastro de clientes no WinThor, acesse o link abaixo:

Como cadastrar cliente na rotina 302?

Todos os campos obrigatórios do cadastro de cliente (Rotina 302) serão obrigatórios na API.
O atributo activityId, caso não seja enviado, a API utilizará o valor padrão "1" do parâmetro 4013 - Código do ramo de atividade para cadastro de clientes na Ciashop (CODATVCIASHOP) da rotina 132.
O atributo cnaeId, caso não seja enviado, a API utilizar um valor padrão "4729-6/99" do parâmetro 4585- Código do CNAE para cadastro de clientes e-commerce. (CODCNAEECOMMERCE) da rotina 132.
No WinThor, acessar a rotina 132 - Parâmetros da Presidência, parâmetro 4532 - "Permite alterar o cliente ao receber dados para inserção via ecommerce/API "ALTERACLIAUTOECOMMERCE" permite ou não alteração do cadastro de cliente de forma automática ao receber dados do cliente ou pedido via API, por padrão esse campo receberá 'SSim' sendo possível sua configuração por filial. Para que essa funcionalidade esteja disponível na rotina 132 - Parâmetros da Presidência é necessário executar a rotina 560, versão 30.0.102.2, tabela "PCPARAMFILIAL".

...

No corpo da requisição o atributo "branchParameterId" é correspondente a filial que permite ou não a alteração.
Obrigatoriamente os cadastro de clientes oriundos da integração deverão informar o atributo "customerOrigin" igual a "VT" (VTEX)
Ao inserir um novo cadastro a API priorizará o CEP informado no atributo "commercialZipCode". Caso o CEP seja inválido e/ou a API (terceira de CEP) esteja indisponível, será considerado a Cidade informada "cityId" e posteriormente os atributos inseridos "businessCity", "businessState".
Ao integrar clientes será considerado o CNPJ/CPF e IE, se tiver um cadastro com o CNPJ/CPF validaremos a Inscrição estadual para cadastrar/alterar, caso seja uma nova Inscrição estadual, será integrado um novo cadastro.
O atributo "sellerId" , caso não seja enviado ou seu valor seja igual a 0, a API utilizará o valor padrão cadastrado no parâmetro "4012 - Código do RCA para cadastro de clientes na Ciashop" na rotina 132.
Ao inserir um novo registro, o valor do código RCA será registrado na coluna CODUSUR1 da tabela PCCLIENT, e em caso de alteração de um registro existente, o valor do código RCA será registrado na coluna CODUSUR3 da mesma tabela, mantendo o registro do código RCA inicial na coluna CODUSUR1.
O atributo documentType, caso não seja enviado, será gravado automaticamente como A, para AMBOS.
O parâmetro withDeliveryAddress dos endpoints de buscar clientes está disponível a partir da versão 1.2.0.1122 do winthor-pedido-venda
No WinThor, o parâmetro 4672 - Aceita validar CEP online nas APIs do WinThor da rotina 132 permite validar se o CEP informado está valido em API terceiros (ViaCEP e ByJG). Caso falso, essa validação não ocorrerá. O padrão do parâmetro é "Sim";
Para que seja realizada a busca automática da praça do cliente, o parâmetro 4680 - Permite busca automática do código da praça no cadastro do cliente via API Winthor da rotina 132 deve estar habilitado. Para esse parâmetro existe a seguinte regra:
- Caso o parâmetro 4680 da rotina 132 esteja habilitado (sim), a API irá consultar o código da praça no cadastrado na rotina 572 do Winthor através do CEP do cliente (a API irá buscar o código cujo CEP está entre CEP inicial e CEP final cadastrado na rotina 572);
  - Caso não encontrado pelo intervalo de CEP, a API pegará o código do parâmetro 4011 - Código da praca para cadastro de clientes na Ciashop da rotina 132, e caso o mesmo esteja nulo irá setar o valor padrão 1;
- Caso o parâmetro 4680 da rotina 132 esteja desabilitado (não), a API irá considerar o que foi enviado na requisição (atributo squareId), e caso o mesmo seja nulo ou zero, irá setar o valor padrão 1;

Aviso

title	Importante

Quando não houver preenchimento do campo DATA, exemplo (data de cadastro, data de alteração), nossas APIs retornará por padrão a informação "1900-01-01T00:00:00".

Caso necessário, realizar o ajuste nos cadastros para que a API apresente a data desejada.

Possíveis problemas:

Caso o ambiente esteja utilizando o antivírus Kaspersky, o serviço de consultas de cep que é realizado na integração de clientes VIACEP é bloqueado.

Exemplo de consultas do serviço VIACEP:

https://viacep.com.br/ws/35450000/json/

Para que o cadastro de clientes seja integrado com sucesso, é necessário verificar todas restrições referentes ao antivírus ou inativá-lo.

Integração

Totvs custom tabs box

tabs	Dados integrados com Winthor, Envio Parâmetros/Resposta da Requisição, Listar Dados Cliente
ids	passo1,passo2,passo3

A integração consiste em receber e enviar dados que serão utilizados no E-Commerce.

Totvs custom tabs box items

default	yes
referencia	passo1

Os dados integrados são:

API	Referência
CUSTOMER	PCCLIENT	Referência rotina 302

...

Winthor	Descrição	Tipo(Tamanho)	Obrigatório	Observações
activityId	pcclient.codatv1	Código da atividade do Cliente - aba dados cadastrais	NUMBER(6,0)	Sim
addressInfo	pcclient.

...

enderent			Não	Esse parâmetro só é retornado no GET da requisição. Não é utilizado para gravar informações;
billingAddress	pcclient.endercob	Endereço Cobrança - aba endereço cobrança	VARCHAR2(40)	Sim
billingAddressNumber	pcclient.numerocob	Numero do endereço de cobrança - aba endereço cobrança	VARCHAR2(6,0)	Não
billingDistrict	pcclient.bairrocob	Bairro - aba endereço cobrança	VARCHAR2(40,0)	Não
billingId	pcclient.codcob	Código de cobrança - aba posição financeira - valor padrão "D"	VARCHAR2(4,0)	Não
billingState	pcclient.estcob	Estado - aba endereço cobrança	VARCHAR2(2)	Não
billingZipCode	pcclient.cepcob	CEP - aba endereço cobrança	VARCHAR2(9)	Sim
branchParameterId	Filial de referência para considerar os parâmetro ALTERACLIAUTOECOMMERCE e CODPRACACIASHOP			Não
businessCity	pccidade.nomecidade	Campo município - aba endereço comercial	VARCHAR2(80)	Não
businessCityId	pcclient.codcidadecom	Cidade - aba endereço entrega	NUMBER(6,0)	Não	Relaciona o ID da cidade cadastrado no banco de dados.
businessDistrict	pcclient.bairroent	Bairro - aba endereço comercial	VARCHAR2(40)	Sim
businessState	pcclient.

...

estent	Estado - aba endereço entrega	VARCHAR2(2)	Não
cityId	pcclient.codcidade	Cidade	NUMBER(10,0)	Sim	Relaciona o ID da cidade cadastrado no banco de dados.
cnaeId	pcclient.codcnae	CNAE - aba capa	VARCHAR2(60)	Não
commercialAddress	pcclient.enderent	Endereço comercial - aba endereço comercial	VARCHAR2(40)	Sim
commercialAddressNumber	pcclient.numeroent	Numero do endereço comercial - aba endereço entrega	VARCHAR2(6)	Não
commercialZipCode

...

	pcclient.cepcom	CEP - aba endereço entrega	VARCHAR2(9)	Sim
complementBillingAddress	pcclient.complementocob	Complemento endereço de cobrança - aba endereço cobrança	VARCHAR2(80)	Não
complementBusinessAddress	pcclient.complementoent	Complemento endereço de cobrança - aba endereço comercial	VARCHAR2(80)	Não
complementDeliveryAddress	pcclient.complementocom	Complemento endereço de cobrança - aba endereço entrega	VARCHAR2(80)	Não
corporate	pcclient.tipofj	Tipo de Pessoa - aba capa	VARCHAR2(1)	Sim	Campo Booleano. true é para pessoa jurídica("J") e false para pessoa física ("F"); Como padrão, caso parâmetro não seja enviado, será definido de acordo com o CGC informado, caso seja enviado um CPF será pessoa física ("F"), caso seja CNPJ será pessoa jurídica("J").
corporatePhone	pcclient.telent	Telefone - aba endereço comercial	VARCHAR2(13)	Não	O valor é criado na tabela 'pcclient.telent'.
deliveryPhone	pcclient.telcom	Telefone comercial - aba endereço de entrega	VARCHAR2(13)	Não	O valor é criado na tabela 'pcclient.telcom'.
billingPhone	pcclient.telcob	Telefone comercial - aba endereço de cobrança	VARCHAR2(13)	Não	O valor é criado na tabela 'pcclient.telcob'.
countryId	pcclient.codpais	Código do pais - aba endereço comercial	NUMBER(6,0)	Sim
createDate	pcclient.dtcadastro	Data e Hora de cadastro - aba dados cadastrais	DATE(7)	Sim	O formato correto de envio é: "yyyy-MM-dd'T'HH:mm:ss.SSS".

...

Sendo: yyyy para ano com quatro dígitos, MM para mês com dois dígitos, dd para dia com dois dígitos, HH para hora com dois dígitos, mm para minutos com dois dígitos, ss para segundos com dois dígitos, e SSS para milésimos com três dígitos. Exemplo de input válido: "2021-12-02T15:35:20.003". Para 'CustomerOrigin' sendo 'VT', o campo não é obrigatório e pega os dados do de data e horário da requisição.
customerOrigin				Sim	Os valores aceitos para esse campo são: "VT" - VTEX; "WB" - WEB; "WTN" - Winthor não Web; "WTW" - WTA - Winthor Web; "N" - Nenhum;
deliveryAddress	pcclient.endercom	Endereço - aba endereço entrega	VARCHAR2(40)	Não
deliveryAddressNumber	pcclient.numerocom	Numero do endereço de entrega - aba endereço entrega	VARCHAR2(6)	Não
deliveryDistrict	pcclient.bairrocom	Bairro - aba endereço entrega	VARCHAR2(40)	Não
deliveryState	pcclient.estcom	Estado - aba endereço entrega	VARCHAR2(2)	Não
deliveryZipCode	pcclient.CEPENT	CEP - aba endereço COMERCIAL	VARCHAR2(9)	Não
document				Não
documentType*	pcclient.tipodocumento	Tipo de documento - aba condições comerciais - opções	VARCHAR2(1)	Não	Os valores aceitos são 'A' para Ambos, 'C' para Cupom ou 'N' para Nota Fiscal.
email	pcclient.email	E-mail - aba endereço comercial	VARCHAR2(100)	Sim
emailNfe	pcclient.emailnfe	E-mail NF-e - aba endereço comercial	VARCHAR2(3500)	Não	Caso esse parâmetro não seja enviado, será replicado o valor do campo 'email' para o 'emailNfe'.
finalCostumer	pcclient.consumidorfinal	Consumidor Final - aba condições comerciais - opções	VARCHAR2(1)	Não	Campo booleano. true para 'S', false para 'N'.
ibgeId	pccidade.codibge		NUMBER(10,0)	Não	Não é um campo obrigatório porém por redundância, o cliente pode envia-lo para verificar se o ID do IBGE existe no banco de dados. Campo utilizado no POST somente para validação de dados - e o envio deve ser feito pelo body como String.
id*	pcclient.codcli	Código - aba capa	VARCHAR2(9)	Não
lastChange	pcclient.dtultalter	Data da última alteração - aba dados cadastrais	DATE(7)	Sim	O formato correto de envio é: "yyyy-MM-dd'T'HH". Sendo: yyyy para ano com quatro dígitos, MM para mês com dois dígitos, dd para dia com dois dígitos. Exemplo de input válido: "2021-12-02T00:00".
name	pcclient.cliente	Campo cliente - Nome do cliente - aba capa	VARCHAR2(60)	Sim
paymentPlanId	pcclient.codplpag	Plano de pagamento - aba condições comerciais - parâmetros	NUMBER(4,0)	Não
personIdentificationNumber	pcclient.cgcent	CNPJ/CPF - aba capa	VARCHAR2(18)	Sim
phone	*Não é gravado em tabela nenhuma	Telefone comercial - aba endereço comercial	VARCHAR2(13)	Não
sellerId	pcclient.codusur1	RCA 1 - Código do RCA	NUMBER(4,0)	Sim
squareId	pcclient.codpraca	Campo praça - endereço comercial	NUMBER(6,0)	Sim
stateInscription	pcclient.ieent	Ins. Est./ Produtor - aba dados cadastrais: Informar Inscrição Estadual. Caso não tenha, informar ISENTO.	VARCHAR2(15)	Sim
tradeName	pcclient.fantasia	Fantasia - aba capa	VARCHAR2(40)	Não
customerNetId	pcclient.codrede	Indica o código da rede do cliente.	NUMBER(4,0)	Não
mainClientId	pcclient.codcliprinc		NUMBER(9,0)	Não
regionId	pcpraca.numregiao		NUMBER(4)	Não
wholesalePriceUses	pcclient.cliatacado	Indica se Usa preço de atacado	VARCHAR2(1)	Não
professionalId	pcclient.codprofissional	Indica o código do profissional.	NUMBER(6)	Não

Observações da requisição POST:

Se a origem do pedido for "VT":

Será utilizado o CEP para preencher os dados do nome da cidade, nome do estado, e o bairro (tanto comercial, de cobrança e entrega). Caso os dados da API de consulta falhem, serão utilizados valores informados na requisição do corpo;
O parâmetro: "CommercialZipCode" irá definir os campos: 'CepComercial', 'CepEntrega' e 'CepCobranca'. Sendo assim, esses valores serão iguais;
O parâmetro: "ComplementBusinessAddress" irá definir os campos: 'ComplementoEnderecoComercial', 'ComplementoEnderecoEntrega' e 'ComplementoEndereçoCobranca'. Sendo assim, esses valores serão iguais;
O parâmetro: "CommercialAddressNumber" irá definir os campos: 'NumeroEnderecoComercial', 'NumeroEnderecoEntrega' e 'NumeroEnderecoCobrança'. Sendo assim, esses valores serão iguais;
O parâmetro: "CommercialAddress" irá definir os campos: 'EnderecoComercial', 'EnderecoEntrega' e 'EnderecoCobrança'. Sendo assim, esses valores serão iguais;
O parâmetro: "corporatePhone" irá definir os campos: 'Telefone comercial', 'TelefoneEntrega' e 'TelefoneCobranca'. Sendo assim, esses valores serão iguais;
O CNAE padrão será 4729-6/99;
Código do país será 1058 que representa o Brasil;

Totvs custom tabs box items

default	no
referencia	passo2

Exemplo JSON do envio da requisição e dados do retorno:

Bloco de código

language	js
title	URI - Cadastrar Cliente

method: 'POST',
url: '/api/wholesale/v1/customer/'

Bloco de código

language	js
title	Body

{
    "corporate": true,
    "name": "string",
    "personIdentificationNumber": "string",
    "stateInscription": "string",
    "commercialAddress": "string",
    "businessDistrict": "string ",
    "commercialZipCode": "string",
    "email": "string",
	"emailNfe": "string",
    "customerOrigin": "VT",
    "finalCostumer": "false",
    "billingId": "string",
    "paymentPlanId":0,
    "commercialAddressNumber": "string",
    "billingAddressNumber": "string",
    "deliveryAddressNumber": "string",
    "squareId": 0,
    "activityId": 0,
    "complementBillingAddress": "string",
    "complementBusinessAddress": "string",
    "complementDeliveryAddress": "string",
    "BusinessCity": "string",
    "sellerId": 0,
    "businessCity": "string",
    "cityId": 0,
    "countryId": 0,
	"documentType": "A"
}

Exemplo JSON da resposta:

Bloco de código

language	js
title	Body Response

{
    "Id": 0
}

Bloco de código

language	js
title	Body Response - Error

{
    "code": "WT-PV-000000",
    "message": "Erro ao validar itens",
    "detailedMessage": "Lista de validações em details",
    "details": [
        {
            "code": "WT-PV-0000XX",
            "message": "Campo obrigatório",
            "detailedMessage": "Detalhes do campo obrigatório. ",
            "details": []
        }
    ]
}

Totvs custom tabs box items

default	no
referencia	passo3

Enviar as requisições conforme indicação abaixo para listar os cadastros existentes:

Bloco de código

language	js
title	URI Parameters - Listar um único cadastro

method: 'GET',
url: '/api/wholesale/v1/customer/'

*PARAMS:*
customerId  : 0             - Informar o código do cliente 
branchId    : 1,2           - Informar o(s) código(s) de filial(is) do cliente
withDeliveryAddress : false - Informe para retornar os endereços de entregas do cliente

Bloco de código

language	js
title	URI Parameters - Listar todos cadastros

method: 'GET',
url: '/api/wholesale/v1/customer/list'

*PARAMS:*
withDeliveryAddress : false  - Informe para retornar os endereços de entregas do cliente  
branchId            :  1,2   - Informar o(s) código(s) de filial(is) do cliente
finalCostumer       : String - Informe 'S' para retornar somente consumidor final e 'N' para não consumidor final (Não obrigatório) 
personalType        : String - Informe 'J' para retornar somente cliente pessoa jurídica e 'F' para somente pessoa física (Não obrigatório)
personIdentificationNumber   -  CPF ou CNPJ do cliente - * Disponível a partir da versão 1.3.0.1 (Versão de homologação)

Observações da requisição ao consultar:

Em caso de não encontrar registro pelo CPF/CNPJ retornará o http status 404 com a descrição do erro: "Não foi possível encontrar os clientes com os dados informados: personIdentificationNumber: XPTO. Verifique se informou corretamente os dados e realize nova consulta."
Caso o parâmetro finalCostumer ou personalType não seja enviado a lista de clientes não será filtrada, sendo assim trazendo todos os registro pois são parâmetros não obrigatórios.
Caso o Cliente consultado esteja excluidio, o campo active será apresentado com valor 0 (zero). Indicativo de cliente inativo.

Bloco de código

language	js
title	Body Response - Exemplo para todos os casos

{
    "corporate": true,
    "name": "string",
    "personIdentificationNumber": "string",
    "stateInscription": "string",
    "commercialAddress": "string",
    "businessDistrict": "string ",
    "commercialZipCode": "string",
    "email": "string",
	"emailNfe": "string",
    "customerOrigin": "VT",
    "finalCostumer": "false",
    "billingId": "string",
    "paymentPlanId":0,
    "commercialAddressNumber": "string",
    "billingAddressNumber": "string",
    "deliveryAddressNumber": "string",
    "squareId": 0,
    "activityId": 0,
    "complementBillingAddress": "string",
    "complementBusinessAddress": "string",
    "complementDeliveryAddress": "string",
    "BusinessCity": "string",
    "sellerId": 0,
    "businessCity": "string",
    "cityId": 0,
    "countryId": 0,
	"documentType": "A",
	"phone": "string",
	"corporatePhone": "string",
	"billingPhone": "string",
	"deliveryPhone": "string",
	"active": true,
 	"customerNetId": 19,
    "mainClientId": 40,
 	"regionId": 4,
    "professionalId": 45,
    "wholesalePriceUses": "N",
    "deliveryAddresses": [
       {
            "id": "number",
            "receiverName": "string",
            "receiverEmail": "string",
            "customerId": "number",
            "squareId": "number",
            "zipCode": "string",
            "state": "string",
            "city": "string",
            "district": "string",
            "address": "string",
            "complement": "string",
            "cityId": "number",
            "number": "number",
            "tradeName": "string",
            "lastChangeDate": "string",
            "receiverCountryId": "number",
            "receiverPhone": "number",
            "referencePoint": "string"
        }
     ]
	"permissions":{
        "acceptValidateZipCodeOnline": false
    } 
}

...

Para que seja realizada uma nova integração atualizando um registro já integrado, o sistema verifica a data de última atualização do registroo CPF/CNPJ. Portanto, ao realizar alguma alteração no registro, ele será encaminhado novamente para a view para manter a integridade dos dados do ERP com o E-commerce. Page TreerootIntegração Pedidos de Vendas

Páginas filhas

Versões comparadas

Versão antiga 6

Nova versão 81

Chave

Objetivo

Pré-Requisitos e Restrições

Possíveis problemas:

Integração