Histórico da Página

...

Necessário a instalação do serviço winthor-pedido-venda.
Todos os campos obrigatórios do cadastro de cliente (Rotina 302) serão obrigatórios na API.
O atributo activityId, caso não seja enviado, a API utilizará o valor padrão "1" do parâmetro 4013 - Código do ramo de atividade para cadastro de clientes na Ciashop (CODATVCIASHOP)na rotina 132.
O atributo cnaeId, caso não seja enviado, a API utilizar um valor padrão "4729-6/99" do parâmetro 4585- Código do CNAE para cadastro de clientes e-commerce. (CODCNAEECOMMERCE) na rotina 132.
O parâmetro 4532 - "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 e/ou a API (terceira de CEP) esteja indisponível, 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.
O atributo "sellerId", caso não seja enviado ou seu valor seja igual a 0, a API utilizará o valor padrão cadastrado no parâmetro "4012 - Código do RCA para cadastro de clientes na Ciashop" na rotina 132.
Ao inserir um novo registro, o valor do código RCA será registrado na coluna CODUSUR1 da tabela PCCLIENT, e em caso de alteração de um registro existente, o valor do código RCA será registrado na coluna CODUSUR3 da mesma tabela, mantendo o registro do código RCA inicial na coluna CODUSUR1.

Integração

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
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

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 23

Nova versão 24

Chave

Integração