TOTVS Distribuição e Varejo - linha Winthor

Páginas filhas
  • APIs Integrações - Clientes

Versões comparadas

Versão antiga 29

changes.mady.by.user Usuário desconhecido (joao.mattos)

Gravado em

comparado com

Nova versão 30

changes.mady.by.user Usuário desconhecido (joao.mattos)

Gravado em

Chave

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

...

Totvs custom tabs box
tabsDados integrados com Winthor, Envio Parâmetros/Resposta da Requisição, Listar Dados Cliente
idspasso1,passo2,passo3

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: 

CUSTOMER              PCCLIENTReferência rotina 302


APIReferência Winthor DescriçãoTipo(Tamanho)ObrigatórioObservações
activityIdpcclient.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;
billingAddresspcclient.endercobEndereço Cobrança - aba endereço cobrançaVARCHAR2(40,0)Sim
billingAddressNumberpcclient.numerocobNumero do endereço de cobrança - aba endereço cobrançaVARCHAR2(6,0)Não
billingDistrictpcclient.bairrocobBairro - aba endereço cobrançaVARCHAR2(40,0)

Não


billingIdpcclient.codcobCódigo de cobrança - aba posição financeira - valor padrão "D"VARCHAR2(4,0)

Não


billingStatepcclient.estcobEstado - aba endereço cobrançaVARCHAR2(2,0)

Não


billingZipCodepcclient.cepcobCEP - aba endereço cobrançaVARCHAR2(9,0)Sim
branchParameterIdFilial de referência para considerar o parâmetro ALTERACLIAUTOECOMMERCE

Não
businessCitypcclient.municentCampo Municipio - aba endereço comercialVARCHAR2(15,0)Não
businessCityIdpcclient.codcidadecomCidade IBGE - aba endereço entregaNUMBER(6,0)Não
businessDistrictpcclient.bairroentBairro - aba endereço comercialVARCHAR2(40,0)Sim
businessStatepcclient.estentEstado - aba endereço entregaVARCHAR2(2,0)Não
cityIdpcclient.codcidadeCidade IBGENUMBER(6,0)Sim
cnaeIdpcclient.codcnaeCNAE - aba capaVARCHAR2(60,0)Não
commercialAddresspcclient.enderentEndereço comercial - aba endereço comercialVARCHAR2(40,0)Sim
commercialAddressNumberpcclient.numeroentNumero do endereço comercial - aba endereço entregaVARCHAR2(6,0)Não
commercialZipCodepcclient.cepcomCEP - aba endereço entregaVARCHAR2(9,0)Sim
complementBillingAddresspcclient.complementocobComplemento endereço de cobrança - aba endereço cobrançaVARCHAR2(80,0)Não
complementBusinessAddresspcclient.complementoentComplemento endereço de cobrança - aba endereço comercialVARCHAR2(80,0)Não
complementDeliveryAddresspcclient.complementocomComplemento endereço de cobrança - aba endereço entregaVARCHAR2(80,0)Não
corporate
**
pcclient.tipofjTipo de Pessoa - aba capaVARCHAR2(1,0)Sim
corporatePhone***pcclient.telentTelefone comercial - aba endereço comercialVARCHAR2(13,0)Não
countryIdpcclient.codpais
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, defini como pessoa física ("F").
corporatePhonepcclient.telentTelefone comercial
Código do pais
- aba endereço comercial
NUMBER
VARCHAR2(
6
13,0)
SimcreateDatepcclient.dtcadastro
NãoNa requisição POST esse parâmetro não é lido. O valor é criado na tabela 'pcclient.telent' a partir do campo 'phone';
countryIdpcclient.codpaisCódigo do pais - aba endereço comercialNUMBER(6,0)Sim
createDatepcclient.dtcadastroData e Hora de cadastro - aba dados cadastraisDATE(7,0)Sim
customerOrigin****SimdeliveryAddresspcclient.endercomEndereço - aba endereço entregaVARCHAR2(40,0)NãodeliveryAddressNumberpcclient.numerocomNumero do endereço de entrega - aba endereço entregaVARCHAR2(6,0)NãodeliveryDistrictpcclient.bairrocomBairro - aba endereço entregaVARCHAR2(40,0)NãodeliveryStatepcclient.estcomEstado - aba endereço entregaVARCHAR2(2,0)NãodeliveryZipCodepcclient.CEPENTCEP - aba endereço COMERCIALVARCHAR2(9,0)NãodocumentNãodocumentType*pcclient.tipodocumentoTipo de documento - aba condições comerciais - opçõesVARCHAR2(1,0)Nãoemailpcclient.emailE-mail - aba endereço comercialVARCHAR2(100,0)NãofinalCostumer*****pcclient.consumidorfinalConsumidor Final  - aba condições comerciais - opçõesVARCHAR2(1,0)Nãoid*pcclient.codcliCódigo - aba capaVARCHAR2(9,0)NãolastChangepcclient.dtultalterData e Hora da última alteração - aba dados cadastraisDATE(7,0)Simnamepcclient.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**pcclient.telentTelefone 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ão
Observações: 
*  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'.
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


SimOs 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
deliveryAddressNumberpcclient.numerocomNumero do endereço de entrega - aba endereço entregaVARCHAR2(6,0)Não
deliveryDistrictpcclient.bairrocomBairro - aba endereço entregaVARCHAR2(40,0)Não
deliveryStatepcclient.estcomEstado - aba endereço entregaVARCHAR2(2,0)Não
deliveryZipCodepcclient.CEPENTCEP - aba endereço COMERCIALVARCHAR2(9,0)Não
document


Não
documentType*pcclient.tipodocumentoTipo de documento - aba condições comerciais - opçõesVARCHAR2(1,0)NãoEsse parâmetro só é retornado no GET da requisição. Não é utilizado para gravar informações.
emailpcclient.emailE-mail - aba endereço comercialVARCHAR2(100,0)Não
finalCostumerpcclient.consumidorfinalConsumidor Final  - aba condições comerciais - opçõesVARCHAR2(1,0)NãoCampo booleano. true para 'S', false para 'N'.
id*pcclient.codcliCódigo - aba capaVARCHAR2(9,0)Não
lastChangepcclient.dtultalterData e Hora da última alteração - aba dados cadastraisDATE(7,0)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". 
namepcclient.clienteCampo cliente - Nome do cliente - aba capaVARCHAR2(60,0)Sim
paymentPlanIdpcclient.codplpagPlano de pagamento - aba condições comerciais  - parâmetrosNUMBER(4,0)Não
personIdentificationNumberpcclient.cgcentCNPJ/CPF - aba capaVARCHAR2(18,0)Sim
phonepcclient.telentTelefone comercial - aba endereço comercialVARCHAR2(13,0)Não
sellerIdpcclient.codusur1RCA 1 - Código do RCANUMBER(4,0)Sim
squareIdpcclient.codpracaCampo praça - endereço comercialNUMBER(6,0)Sim
stateInscriptionpcclient.ieentIns. Est./ Produtor - aba dados cadastrais: Informar Inscrição Estadual. Caso não tenha, informar ISENTO. VARCHAR2(15,0)Sim
tradeNamepcclient.fantasiaFantasia - aba capaVARCHAR2(40,0)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: "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
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/'
Bloco de código
languagejs
titleBody
{
    "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
languagejs
titleBody Response 
{
    "Id": 0
}
Bloco de código
languagejs
titleBody 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
defaultno
referenciapasso3

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

Bloco de código
languagejs
titleURI 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
languagejs
titleURI Parameters - Listar todos cadastros
method: 'GET',
url: '/api/wholesale/v1/customer/list'
Bloco de código
languagejs
titleBody 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
}

...