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: | CUSTOMER | PCCLIENT | Referência rotina 302 |
|
| | API | Referência WinthorWinthor | Descrição | Tipo(Tamanho) | Obrigatório |
|---|
| activityId | pcclient.codatv1 | Código da atividade do Cliente. Aba Dados Cadastrais Winthor | Numérico(6) | Sim | | 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 |
|---|
| {
"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
} |
|
|
