Exibir origem

Objetivo

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

Pré-Requisitos e Restrições

Todos os campos obrigatórios do cadastro de cliente (Rotina 302) serão obrigatórios na API.
O atributo CNAE caso não seja enviado, a API utilizar um valor fixo '4729-6/99'.
O parâmetro "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á 'S' 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".

Integração

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

Os dados integrados são:

API	Referência Winthor
CUSTOMER	PCCLIENT
activityId	pcclient.codatv1
addressInfo	pcclient.endcob
billingAddress	pcclient.endercob
billingZipCode	pcclient.cepcob
businessDistrict	pcclient.bairroent
businessState	pcclient.estcom
cityId	pcclient.codcidade
commercialAddress	pcclient.enderent
commercialZipCode	pcclient.cepent
corporate	pcclient.tipofj
corporatePhone	pcclient.telent
countryId	pcclient.codpais
createDate	pcclient.dtcadastro
deliveryZipCode	pcclient.cepcom
documentType	pcclient.tipodocumento
email	pcclient.email
id	pcclient.codcli
lastChange	pcclient.dtultalter
name	pcclient.cliente
personIdentificationNumber	pcclient.cgcent
phone	pcclient.telcom
sellerId	pcclient.codusur1
squareId	pcclient.codpraca
stateInscription	pcclient.ieent
tradeName	pcclient.fantasia
finalCostumer	pcclient.consumidorfinal
billingId	pcclient.codcob
paymentPlanId	pcclient.codplpag
commercialAddressNumber	pcclient.numerocom
billingAddressNumber	pcclient.numerocob
deliveryAddressNumber	pcclient.numeroent
complementDeliveryAddress	pcclient.complementoent
complementBusinessAddress	pcclient.complementocom
complementBillingAddress	pcclient.complementocob
bussinnescity	pcclient.municent
branchParameterId	Filial de referência para considerar o parâmetro ALTERACLIAUTOECOMMERCE

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

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

{
    "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:

{
    "Id": 0
}

{
    "code": "WT-PV-000000",
    "message": "Erro ao validar itens",
    "detailedMessage": "Lista de validações em details",
    "details": [
        {
            "code": "WT-PV-000082",
            "message": "Campo obrigatório",
            "detailedMessage": "Preenchimento do endereço comercial é obrigatório. ",
            "details": []
        },
        {
            "code": "WT-PV-000083",
            "message": "Campo obrigatório",
            "detailedMessage": "Preenchimento do bairro comercial é obrigatório. ",
            "details": []
        },
        {
            "code": "WT-PV-000092",
            "message": "Email inválido",
            "detailedMessage": "O email informado não é válido. Email: 45",
            "details": []
        },
        {
            "code": "WT-PV-000079",
            "message": "Campo obrigatório",
            "detailedMessage": "Preenchimento da inscrição estadual é obrigatória. ",
            "details": []
        },
        {
            "code": "WT-PV-000078",
            "message": "Campo obrigatório",
            "detailedMessage": "Preenchimento do cpf/cnpj é obrigatório. ",
            "details": []
        },
        {
            "code": "WT-PV-000086",
            "message": "Campo obrigatório",
            "detailedMessage": "Preenchimento do endereço de cobrança é obrigatório. ",
            "details": []
        },
        {
            "code": "WT-PV-000075",
            "message": "Campo obrigatório",
            "detailedMessage": "Preenchimento do nome é obrigatório",
            "details": []
        },
        {
            "code": "WT-PV-000084",
            "message": "Campo obrigatório",
            "detailedMessage": "Preenchimento do código da cidade é obrigatório. ",
            "details": []
        }
    ]
}

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

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

*PARAMS:*
customerId  : 0      -    Informar o código do cliente

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

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

Para que seja realizada uma nova integração atualizando um registro já integrado, o sistema verifica o 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.