TOTVS Distribuição e Varejo - linha Winthor

Páginas filhas
  • APIs Integrações - Endereço de entrega

Versões comparadas

Versão antiga 2

changes.mady.by.user Beatriz Menezes de Oliveira

Gravado em

comparado com

Nova versão 3

changes.mady.by.user Beatriz Menezes de Oliveira

Gravado em

Chave

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

...

VARCHAR2(40
Totvs custom tabs box
tabsDados integrados com Winthor, Envio Parâmetros/Resposta da Requisição
idspasso1,passo2

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

Totvs custom tabs box items
defaultyes
referenciapasso1

Os dados integrados são: 

DELIVERY ADDRESS              PCCLIENTENTENDReferência rotina 3324


APIReferência Winthor DescriçãoTipo(Tamanho)ObrigatórioObservações
activityId
receiverName
pcclient
PCCLIENTENTEND.
codatv1

Código da atividade do Cliente - aba dados cadastrais

NUMBER(6,0)SimaddressInfopcclient.enderent

Não

Esse parâmetro só é retornado no GET da requisição. Não é utilizado para gravar informações;
RAZAORECEBEDOR

Nome/Razão Social do Recebedor da mercadoria

VARCHAR2(60,0)Não
receiverEmailPCCLIENTENTEND.EMAILRECEBEDORE-mail do Recebedor da mercadoriaVARCHAR2(60,0)

Não


customerIdPCCLIENTENTEND.CODCLICódigo do cliente ao qual o endereço de entrega está vinculadoNUMBER(9,0)Sim
squareIdPCCLIENTENTEND.CODPRACAENTCódigo da praçaNUMBER(6
billingAddresspcclient.endercobEndereço Cobrança - aba endereço cobrançaVARCHAR2(40,0)SimbillingAddressNumberpcclient.numerocobNumero do endereço de cobrança - aba endereço cobrançaVARCHAR2(6,0)NãobillingDistrictpcclient.bairrocobBairro - aba endereço cobrança
,0)Não
billingId

date
pcclient
PCCLIENTENTEND.
codcob
DTCADASTRO
Código de cobrança - aba posição financeira - valor padrão "D"VARCHAR2(4,0)

Não

Data de cadastro do registroDATENãoSe não enviado, será assumida a data no instante em que a requisição foi realizada;
lastChangeDatePCCLIENTENTEND.DTULTALTERIdentifica quando foi feita a última alteraçãoDATE

Não

Se não enviado, será assumida a data no instante em que a requisição foi realizada;
zipCodePCCLIENTENTEND.CEPENTCEP de entrega
billingStatepcclient.estcobEstado - aba endereço cobrançaVARCHAR2(2,0)

Não

billingZipCodepcclient.cepcobCEP - aba endereço cobrança
VARCHAR2(9,0)

Sim

branchParameterIdFilial de referência para considerar o parâmetro ALTERACLIAUTOECOMMERCENãobusinessCitypcclient.municentCampo município - aba endereço comercialVARCHAR2(15,0)Não
Necessário para a consulta das outras informações na API de terceiros VIACEP
statePCCLIENTENTEND.ESTENTEstado de
businessCityIdpcclient.codcidadecomCidade - aba endereço entregaNUMBER(6,0)NãoRelaciona o ID da cidade cadastrado no banco de dados.businessDistrictpcclient.bairroentBairro - aba endereço comercialVARCHAR2(40,0)SimbusinessStatepcclient.estentEstado - aba endereço
entregaVARCHAR2(2,0)

Não

cityIdpcclient.codcidadeCidadeNUMBER(10,0)SimRelaciona o ID da cidade cadastrado no banco de dados.cnaeIdpcclient.codcnaeCNAE - aba capaVARCHAR2(60,0)NãocommercialAddresspcclient.enderentEndereço comercial - aba endereço comercialVARCHAR2(40,0)SimcommercialAddressNumberpcclient.numeroentNumero do endereço comercial - aba endereço entregaVARCHAR2(6,0)NãocommercialZipCodepcclient.cepcomCEP - aba endereço entregaVARCHAR2(9,0)SimcomplementBillingAddresspcclient.complementocobComplemento endereço de cobrança - aba endereço cobrançaVARCHAR2(80,0)NãocomplementBusinessAddresspcclient.complementoentComplemento endereço de cobrança - aba endereço comercialVARCHAR2(80,0)NãocomplementDeliveryAddresspcclient.complementocomComplemento endereço de cobrança - aba endereço entregaVARCHAR2(80,0)Nãocorporatepcclient.tipofjTipo de Pessoa - aba capaVARCHAR2(1,0)SimCampo 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").corporatePhonepcclient.telentTelefone - aba endereço comercialVARCHAR2(13,0)NãoO valor é criado na tabela 'pcclient.telent'.deliveryPhonepcclient.telcomTelefone comercial - aba endereço de entregaVARCHAR2(13,0)NãoO valor é criado na tabela 'pcclient.telcom'.billingPhonepcclient.telcobTelefone comercial - aba endereço de cobrançaVARCHAR2(13,0)NãoO valor é criado na tabela 'pcclient.telcob'.countryIdpcclient.codpais
Caso o atrbuto "acceptValidateZipCodeOnline" seja enviado true, o campo não precisa ser enviado pois será gravado o estado retornado na API de terceiros VIACEP. Do contrário, o campo deve ser enviado na requisição.
cityPCCLIENTENTEND.MUNICENTCidade de entregaVARCHAR2(15,0)NãoCaso o atrbuto "acceptValidateZipCodeOnline" seja enviado true, o campo não precisa ser enviado pois será gravada a cidade retornada na API de terceiros VIACEP. Do contrário, o campo deve ser enviado na requisição.
districtPCCLIENTENTEND.BAIRROENTBairro de entregaVARCHAR2(40,0)NãoCaso o atrbuto "acceptValidateZipCodeOnline" seja enviado true, o campo não precisa ser enviado pois será gravado o bairro retornado na API de terceiros VIACEP. Do contrário, o campo deve ser enviado na requisição.
addressPCCLIENTENTEND.ENDERENTEndereço de entregaNUMBER(40,0)Não
complementPCCLIENTENTEND.COMPLEMENTOENTComplemento de entregaVARCHAR2(60,0)Não
cityIdPCCLIENTENTEND.CODCIDADECódigo da cidade de entrega
Código do pais - aba endereço comercial
NUMBER(6,0)
Sim
Não
createDate

number
pcclient
PCCLIENTENTEND.
dtcadastroData e Hora de cadastro - aba dados cadastrais
NUMEROENTNúmero do endereço de entregaVARCHAR2(6
DATE(7
,0)Não
SimO 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.

regionNumberPCCLIENTENTEND.NUMREGIAOCaso sistema trabalhe com tributação por endereço de entrega, e não utilize tributação por UF, no momento do cálculo dos impostos, será utilizada a região do endereço de entrega para impostos.NUMBER(4
customerOriginSimOs valores aceitos para esse campo são: "VT" - VTEX; "WB" - WEB; "WTN" - Winthor não Web; "WTW" - WTA - Winthor Web; "N" - Nenhum;deliveryAddresspcclient.endercomEndereço - aba endereço entregaVARCHAR2(40
,0)Não
deliveryAddressNumber

observation
pcclient
PCCLIENTENTEND.
numerocom
OBSERVACAO
Numero
Observações do cadastro de endereço de entrega
- aba endereço entrega
VARCHAR2(
6
4000,0)Não
deliveryDistrict

tradeName
pcclient
PCCLIENTENTEND.
bairrocom
FANTASIANome Fantasia para identificação do estabelecimento de
Bairro - aba endereço
entregaVARCHAR2(
40
100,0)Não
deliveryState

receiverZipCode
pcclient
PCCLIENTENTEND.
estcom
CEPRECEBEDORCEP do Recebedor da mercadoria
Estado - aba endereço entrega
VARCHAR2(
2
9,0)Não
deliveryZipCode

receiverCountryId
pcclient
PCCLIENTENTEND.
CEPENTCEP - aba endereço COMERCIAL
CODPAISRECEBEDORCódigo do pais do Recebedor da mercadoriaNUMBER(6
VARCHAR2(9
,0)Não
documentNãodocumentType*pcclient.tipodocumentoTipo de documento - aba condições comerciais - opções

receiverPhonePCCLIENTENTEND.FONERECEBEDORTelefone do Recebedor da mercadoriaNUMBER(14
VARCHAR2(1
,0)Não
Os valores aceitos são 'A' para Ambos, 'C' para Cupom ou 'N' para Nota Fiscal.

receiverStateInscriptionPCCLIENTENTEND.IERECEBEDORInscrição estadual do Recebedor da mercadoriaNUMBER(14
emailpcclient.emailE-mail - aba endereço comercialVARCHAR2(100
,0)
Sim
Não
emailNfe

latitude
pcclient
PCCLIENTENTEND.
emailnfe
LATITUDEIndica a Latitude
E-mail NF-e - aba endereço comercial
VARCHAR2(
3500
20,0)Não
Caso esse parâmetro não seja enviado, será replicado o valor do campo 'email' para o 'emailNfe'.

longitudePCCLIENTENTEND.LONGITUDEIndica a LongitudeVARCHAR2(20
finalCostumerpcclient.consumidorfinalConsumidor Final  - aba condições comerciais - opçõesVARCHAR2(1
,0)Não
Campo booleano. true para 'S', false para 'N'.ibgeIdpccidade.codibgeNUMBER(10,0)NãoNã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.

referencePointPCCLIENTENTEND.PONTOREFERIndica o Ponto de ReferênciaVARCHAR2(80
id*pcclient.codcliCódigo - aba capaVARCHAR2(9
,0)Não
lastChange

customerOrigin
pcclient.dtultalterData e Hora da última alteração - aba dados cadastrais
-Origem do clienteVARCHAR2(3
DATE(7
,0)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". namepcclient.clienteCampo cliente - Nome do cliente - aba capaVARCHAR2(60,0)SimpaymentPlanIdpcclient.codplpagPlano de pagamento - aba condições comerciais  - parâmetrosNUMBER(4,0)NãopersonIdentificationNumberpcclient.cgcentCNPJ/CPF - aba capaVARCHAR2(18,0)Simphone*Não é gravado em tabela nenhumaTelefone comercial - aba endereço comercialVARCHAR2(13,0)NãosellerIdpcclient.codusur1RCA 1 - Código do RCANUMBER(4,0)SimsquareIdpcclient.codpracaCampo praça - endereço comercialNUMBER(6,0)SimstateInscriptionpcclient.ieentIns. Est./ Produtor - aba dados cadastrais: Informar Inscrição Estadual. Caso não tenha, informar ISENTO. VARCHAR2(15,0)SimtradeNamepcclient.fantasiaFantasia - aba capaVARCHAR2(40,0)Nãopermissions.acceptValidateZipCodeOnlinebooleanNão

Default: true

Em caso de 'false' a aplicação não irá validar se o CEP está valido em API terceiros (ViaCEP e ByJG)

Obs: opção disponível a partir da versão: 1.2.0.1087

("VT", "Vtex"), ("WB", "Web"), ("WTN", "Winthor não Web"), ("WTW", "WTA - Winthor Web"), ("N", "Nenhum"); Só haverá consulta de informações complementares na API de terceiros VIACEP (cidade, estado e bairro) se a origem for igual a "VT";
permissions.acceptValidateZipCodeOnline-Permissão que indica se a API deverá realizar a consulta online do CEP (VIACEP)booleanNãoDefault true;



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.  Caso os dados da API de consulta falhem, serão utilizados valores informados na requisição do corpo;
  • Código Pais será 1058 que representa o Brasil;


{

{
    "receiverName":"",


    "receiverEmail":"",


    "customerId":0,


    "squareId":

0,


    "date":

"2022-10-04T20:05:12",


    "lastChangeDate":

"2022-10-04T20:05:12",


    "zipCode":

0000000,


    "state":

"",


    "city":"",


    "district":"",


    "address":"",


    "complement":"",


    "cityId":0,


    "number":"",


    "regionNumber":0,


    "customerOrigin":"VT",


    "tradeName":"",


    "receiverZipCode":"",


    "receiverCountryId":0,


    "receiverPhone":0,


    "latitude":"",


    "longitude":"",


    "referencePoint":"0",

"ibgeId":0,


    "ibgeId":0,
    "receiverStateInscription":0,
    "observation":"",
    "permissions":

{

{
        "acceptValidateZipCodeOnline":true

}


    }
}

Exemplo JSON da resposta:  

Totvs custom tabs box items
defaultno
referenciapasso2


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

Bloco de código
languagejs
titleURI - Cadastrar Cliente
method: 'POST',
url: '/api/wholesale/v1/customer/deliveryAddress'
Bloco de código
languagejs
titleBody
Bloco de código
languagejs
titleBody Response 
{
    "Id": 0
}

...