Histórico da Página

...

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 Winthor	Descrição	Tipo(Tamanho)	Obrigatório
CUSTOMER	PCCLIENT	Referência rotina 302
activityId	pcclient.codatv1	Código da atividade do Cliente - aba dados cadastrais	NUMBER(6,0)	Sim
addressInfo*	pcclient.enderent			Não
billingAddress	pcclient.endercob	Endereço Cobrança - aba endereço cobrança	VARCHAR2(40,0)	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,0)	Não
billingZipCode	pcclient.cepcob	CEP - aba endereço cobrança	VARCHAR2(9,0)	Sim
branchParameterId	Filial de referência para considerar o parâmetro ALTERACLIAUTOECOMMERCE			Não
businessCity	pcclient.municent	Campo Municipio - aba endereço comercial	VARCHAR2(15,0)	Não
businessCityId	pcclient.codcidadecom	Cidade IBGE - aba endereço entrega	NUMBER(6,0)	Não
businessDistrict	pcclient.bairroent	Bairro - aba endereço comercial	VARCHAR2(40,0)	Sim
businessState	pcclient.estent	Estado - aba endereço entrega	VARCHAR2(2,0)	Não
cityId	pcclient.codcidade	Cidade IBGE	NUMBER(6,0)	Sim
cnaeId	pcclient.codcnae	CNAE - aba capa	VARCHAR2(60,0)	Não
commercialAddress	pcclient.enderent	Endereço comercial - aba endereço comercial	VARCHAR2(40,0)	Sim
commercialAddressNumber	pcclient.numeroent	Numero do endereço comercial - aba endereço entrega	VARCHAR2(6,0)	Não
commercialZipCode	pcclient.cepcom	CEP - aba endereço entrega	VARCHAR2(9,0)	Sim
complementBillingAddress	pcclient.complementocob	Complemento endereço de cobrança - aba endereço cobrança	VARCHAR2(80,0)	Não
complementBusinessAddress	pcclient.complementoent	Complemento endereço de cobrança - aba endereço comercial	VARCHAR2(80,0)	Não
complementDeliveryAddress	pcclient.complementocom	Complemento endereço de cobrança - aba endereço entrega	VARCHAR2(80,0)	Não
corporate**	pcclient.tipofj	Tipo de Pessoa - aba capa	VARCHAR2(1,0)	Sim
corporatePhone***	pcclient.telent	Telefone comercial - aba endereço comercial	VARCHAR2(13,0)	Não
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,0)	Sim
customerOrigin****				Sim
deliveryAddress	pcclient.endercom	Endereço - aba endereço entrega	VARCHAR2(40,0)	Não
deliveryAddressNumber	pcclient.numerocom	Numero do endereço de entrega - aba endereço entrega	VARCHAR2(6,0)	Não
deliveryDistrict	pcclient.bairrocom	Bairro - aba endereço entrega	VARCHAR2(40,0)	Não
deliveryState	pcclient.estcom	Estado - aba endereço entrega	VARCHAR2(2,0)	Não
deliveryZipCode	pcclient.CEPENT	CEP - aba endereço COMERCIAL	VARCHAR2(9,0)	Não
document				Não
documentType*	pcclient.tipodocumento	Tipo de documento - aba condições comerciais - opções	VARCHAR2(1,0)	Não
email	pcclient.email	E-mail - aba endereço comercial	VARCHAR2(100,0)	Não
finalCostumer*****	pcclient.consumidorfinal	Consumidor Final - aba condições comerciais - opções	VARCHAR2(1,0)	Não
id*	pcclient.codcli	Código - aba capa	VARCHAR2(9,0)	Não
lastChange	pcclient.dtultalter	Data e Hora da última alteração - aba dados cadastrais	DATE(7,0)	Sim
name	pcclient.cliente	Campo cliente - Nome do cliente - aba capa	VARCHAR2(60,0)	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,0)	Sim
phone**	pcclient.telent	Telefone comercial - aba endereço comercial	VARCHAR2(13,0)	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,0)	Sim
tradeName	pcclient.fantasia	Fantasia - aba capa	VARCHAR2(40,0)	Não

Observações:
* Só Esse parâmetro só é retornado no GET da requisição. Não é utilizado para gravar informações;
** Campo booleano. true para é pessoa jurídica("J") e false para pessoa física ("F");
*** Na requisição POST esse parâmetro não é lido. O valor é criado na tabela 'pcclient.telent' a partir do campo 'phone';
**** Os valores aceitos para esse campo são: "VT" - VTEX; "WB" - WEB; "WTN" - Winthor não Web; "WTW" - WTA - Winthor Web; "N" - Nenhum;
***** Campo booleano. true para 'S', false para 'N'.

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: "Phone" 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 Pais será 10581 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",
    "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
}

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

Bloco de código

language	js
title	URI Parameters - Listar todos cadastros

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

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",
    "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
}

...

Páginas filhas

Versões comparadas

Versão antiga 28

Nova versão 29

Chave