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

Versões comparadas

Chave

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

...

  • 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 "Permite alterar o cliente ao receber dados para inserção via ecommerce/API" 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á 'Sim' sendo possível sua configuração por filial. 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, 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.

Integração


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              PCCLIENT
APIReferência Winthor
activityIdpcclient.codatv1
addressInfopcclient.endcob
billingAddresspcclient.endercob
billingZipCodepcclient.cepcob
businessDistrictpcclient.bairroent
businessStatepcclient.estcom
cityIdpcclient.codcidade
commercialAddresspcclient.enderent
commercialZipCodepcclient.cepent
corporatepcclient.tipofj
corporatePhonepcclient.telent
countryIdpcclient.codpais
createDatepcclient.dtcadastro
deliveryZipCodepcclient.cepcom
documentTypepcclient.tipodocumento
emailpcclient.email
idpcclient.codcli
lastChangepcclient.dtultalter
namepcclient.cliente
personIdentificationNumberpcclient.cgcent
phonepcclient.telcom
sellerIdpcclient.codusur1
squareIdpcclient.codpraca
stateInscriptionpcclient.ieent
tradeNamepcclient.fantasia
finalCostumerpcclient.consumidorfinal
billingIdpcclient.codcob
paymentPlanIdpcclient.codplpag
commercialAddressNumberpcclient.numerocom
billingAddressNumberpcclient.numerocob
deliveryAddressNumberpcclient.numeroent
complementDeliveryAddresspcclient.complementoent
complementBusinessAddresspcclient.complementocom
complementBillingAddresspcclient.complementocob
bussinnescitypcclient.municent
branchParameterIdFilial de referência para considerar o parâmetro ALTERACLIAUTOECOMMERCE
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
}

...