Tutorial Processo VTEX
Sumário
Sumário ................................................................................................................................................................ 1
Parametrizações .................................................................................................................................................... 2
1.1. Pré-requisitos .............................................................................................................................................. 2
1.2. Informações Adicionais API´S ....................................................................................................................... 6
Característica de Cada API ..................................................................................................................................... 7
DD/MM/AAAA
1
Tutorial Processo VTEX
VTEX é uma plataforma de E-commerce. Este documento traz informações sobre o processo de Integração do ERP
WinThor com o ambiente VTEX. Esta integração passa pela utilização do TOTVS Conector (Produto TOTVS). Para
contemplar estes serviços foram desenvolvidas API´s que expoêm dados para este ambiente VTEX.
Parametrizações
1.1. Pré-requisitos
1. Caso ainda não possua, instale o WinThor Anywhere, para isso acesse o link Como instalar o WinThor
Anywhere ?
2. Acesse o WinThor Anywhere e no menu principal, preencha no campo de Pesquisar a rotina 801 - Atualização
de Serviços Web e tecle Enter (ou clique diretamente sobre a rotina no menu principal);
3. Na tela Gerenciador de Rotinas e Serviços, clique o botão Instalações;
2
Tutorial Processo VTEX
4. Instale os serviços:
Winthor-pedido-venda:
Winthor-compras-produto
Winthor-estoque-vtex
3
Tutorial Processo VTEX
5. Acesse a rotina 132 – Parâmetros da Presidência:
Informe conforme necessidade o parâmetro 4012 – Código RCA para cadastro de clientes Ciashop:
4
Tutorial Processo VTEX
No parâmetro 2277 - Tipo de precificação selecione tipo de precificação conforme necessidade:
Preencha conforme necessidade o parâmetro 4257 – Código da região para preço Ciashop:
Para exposição dos campos Categoria, Produto, Seção e Departamento a opção Envia para E-commerce
(enviaecommece) das rotinas 203 – Cadastrar Produto, 549 – Cadastrar Categoria, 513 –
5
Tutorial Processo VTEX
Cadastrar Departamento e 571 – Cadastrar Seção deve estar marcado como Sim nos Cadastros
(Seção, Categoria, Departamento e Produto).
1.2. Informações Adicionais API´S
APIs Pedidos (winthor-pedido-vendas) –
Expõe dados através de endpoints:
Endpoint de Cliente
- É possível listar todos os clientes sem necessariamente passar um parâmetro.
- É possível listar apenas um cliente utilizando o código do cliente representado pelo parâmetro “customerId” na –
requisição do serviço.
- É possível cadastrar um novo cliente passando alguns campos obrigatórios.
- É possível atualizar um cadastro de cliente já existente.
Endpoint de Pedido
- Ao gravar um pedido é utilizado o RCA adicionado a opção 4012-CODRCACIASHOP na rotina 132 e a região
padrão de preço deverá ser informada na opção 4257- CODREGIAOPRECOCIASHOP.
- Também é possível realizar a consulta de um pedido já cadastrado.
Endpoint de Preço
De acordo com as parametrizações feitas na rotina 132 é possível expor preço referente a rotina 201 – Precificar
Produto ou 2017 – Precificação Por Embalagem (caso trabalhe com preço por embalagem).
Regras por Filial:
Utiliza venda por embalagem = Sim
Utiliza preço de venda por embalagem = Sim
Tipo Precificação: cenário 01.
Atacado= Caso parâmetro Tipo Precificação estiver igual ATACADO é empregado o preço cadastrado da rotina 2017
– Precificação Por Embalagem ([Link]).
Varejo= Caso parâmetro Tipo Precificação estiver igual a VAREJO é empregado o preço cadastrado da rotina 2017
– Precificação Por Embalagem ([Link]).
Regras por Filial:
Tipo Precificação: cenário 02
Com o parâmetro 4257 – Código da região para preço CIASHOP (CODREGIAOPRECOCIASHOP) marcado como Sim,
é utilizada a Região definida neste parâmetro.
Se o parâmetro 2277 – Tipo de Precificação estiver igual a Padrão (P), é utilizado o preço cadastrado na rotina 201
– Precificar Produto (PCTABPR.PVENDA1).
Caso parâmetro 4257 Não esteja preenchido, é utilizada a região informada no parâmetro 2832 – Número da região
utilizada pelo e-commerce (REGIAOECOMMERCE)
6
Tutorial Processo VTEX
APIs Compras ( winthor-compras-produto)
Será exposto os dados de cadastros de Produtos, Marca, Seção, Categoria, Departamento, Embalagens para que os
clientes possam utilizá-los conforme necessidade.
Endpoint BRANDS: expõe em formato de lista os dados da tabela PCMARCA
Endpoint SECTIONS: expõe em formato de lista os dados da tabela PCSECAO
Endpoint DEPARTMENTS: expõe em formato de lista os dados da tabela PCDEPTO
Endpoint CATEGORY: expõe em formato de lista os dados da tabela PCCATEGORIA
Endpoint SKU expõe em formato de lista os dados da tabela PCEMBALAGEM
Endpoint PRODUCTS expõe em formato de lista ose dados da tabela PCPRODUT
API´s Estoque (serviço winthor-estoque-vtex)
Endpoint STOCK: expõe dados do estoque disponível da filial filtrada.
Característica de Cada API
Cada tabela se refere a uma API distinta. Demonstramos a seguir os campos expostos em cada API:
PRODUTO/ CLIENTE:
Marca
BRANDS | PCMARCA
Retorno API Campos Banco Winthor
id [Link]
name [Link]
title [Link]
description [Link]
keywords [Link]
isActive [Link]
adwordsRemarketingCode [Link]
lomadeeCampaignCode [Link]
lastChange [Link]
dtcreate [Link]
7
Tutorial Processo VTEX
Seção
SECTIONS | PCSECAO
Retorno API Campos Banco Winthor
department [Link]
id [Link]
description [Link]
id [Link]
name [Link]
fatherCategoryId [Link]
title [Link]
description [Link]
keywords [Link]
lastChange [Link]
updateStockGeneral [Link]
typeMerchandise [Link]
dtcreate [Link]
active [Link]
title [Link]
keywords [Link]
adWordsRemarketingCode [Link]
lastChange [Link]
dtcreate [Link]
Departamento
DEPARTMENTS | PCDEPTO
Retorno API Campos Banco Winthor
id [Link]
name [Link]
fatherCategoryId [Link]
title [Link]
description [Link]
keywords [Link]
8
Tutorial Processo VTEX
adWordsRemarketingCode [Link]
lomadeeCampaignCode [Link]
lastChange [Link]
updateStockGeneral [Link]
typeMerchandise [Link]
dtcreate [Link]
active [Link]
Categoria
CATEGORY | PCCATEGORIA
Retorno API Campos Banco Winthor
id [Link]
name [Link]
title [Link]
description [Link]
keywords [Link]
lastChange [Link]
section: { [Link]
id [Link]
description [Link]
title [Link]
keywords [Link]
adWordsRemarketingCode [Link]
lastChange [Link]
department: { [Link]
id [Link]
name [Link]
fatherCategoryId [Link]
title [Link]
description [Link]
keywords [Link]
adWordsRemarketingCode [Link]
lomadeeCampaignCode [Link]
9
Tutorial Processo VTEX
lastChange [Link]
updateStockGeneral [Link]
typeMerchandise [Link]
dtcreate [Link]
isActive [Link]
},
dtcreate: 2020-07-16T00:00:00 [Link]
},
dtcreate [Link] dtcreate
Embalagem
SKU | PCEMBALAGEM
Retorno API Campos Banco Winthor
id [Link]
name [Link]
lastChange [Link]
unitMultiplier [Link]
price [Link]
productRootId [Link]
realWidth [Link]
realWeightKg [Link]
realLength [Link]
realHeight [Link]
isActive [Link]
width [Link]
weightKg [Link]
length [Link]
height [Link]
productSKUId [Link]
listOfEAN [Link] + [Link]
isAvaiable [Link]
createDate [Link]
10
Tutorial Processo VTEX
isKit [Link]
nameproduct [Link]
brandId [Link]
categoryId [Link]
description2 pcprodut.descricao2
description3 pcprodut.descricao3
description4 pcprodut.descricao4
description5 pcprodut.descricao5
description6 pcprodut.descricao6
Produto
PRODUCTS | PCPRODUT
Retorno API Campos Banco Winthor
id [Link]
name [Link]
categoryId [Link]
brandId [Link]
linkId [Link]
isVisible [Link]
description [Link]
descriptionShort pcprodut.descricao1
releaseDate [Link]
keywords [Link]
title [Link]
isActive [Link]
supplierId [Link]
showWithoutStock [Link]
[Link]
adWordsRemarketingCode [Link]
lomadeeCampaignCode [Link]
lastChange [Link]
technicalInformation [Link]
11
Tutorial Processo VTEX
technicalData [Link]
idoriginal [Link]
Cliente
CUSTOMER | PCCLIENT
Retorno API Campos Banco Winthor
activityId pcclient.CODATV1
addressInfo [Link]
billingAddress [Link]
billingZipCode [Link]
businessDistrict [Link]
businessState [Link]
cityId [Link]
commercialAddress [Link]
commercialZipCode [Link]
corporate [Link]
corporatePhone [Link]
countryId [Link]
createDate [Link]
deliveryZipCode [Link]
documentType [Link]
email [Link]
id [Link]
lastChange [Link]
name [Link]
personIdentificationNumber [Link]
phone [Link]
sellerId pcclient.CODUSUR1
squareId [Link]
stateInscription [Link]
tradeName [Link]
"finalCostumer" [Link]
12
Tutorial Processo VTEX
"billingId" [Link]
"paymentPlanId" [Link]
"commercialAddressNumber" [Link]
"billingAddressNumber" [Link]
"deliveryAddressNumber" [Link]
ComplementDeliveryAddress [Link]
ComplementBusinessAddress [Link]
ComplementBillingAddress [Link]
Pedido
API PCPEDC PCPEDI
createData [Link] [Link]
id [Link] [Link]
orderId [Link] [Link]
orderStatus [Link]
chargingId [Link]
TotalPrice [Link]
DiscountValue [Link]
paymentPlanId [Link]
saleType [Link]
branchId [Link]
saleOrigin [Link]
productSKUERPReferenceKey [Link]
sellPrice [Link]
quantity [Link]
realCost [Link]
warehouseBranchId [Link]
gift [Link]
giftPrice [Link]
position [Link]
taxFigureId [Link]
valueFreight [Link]
13
Tutorial Processo VTEX
CustomerVendorInternalId
carrierId [Link]
lastChange [Link] (Prioridade 1)
lastChange [Link] (Prioridade 2)
orderIdHube [Link]
orderIdMktplace [Link]
saleOrigin [Link]
freightDispatch [Link]
ESTOQUE:
Observação: para o caso de venda por Embalagem, a API sempre irá utilizar a Menor embalagem cadastrada para
um determinado produto. Sendo Obrigatório o cadastro de Embalagem para o produto.
Serviço: winthor-estoque-
vtex
STOCK
Retorno API Campos Banco Winthor
CreateDate [Link]
[Link]
LastChange [Link]
[Link]
[Link]
[Link]
[Link]
[Link]
PCEST.DTALTERACAO1107
ProductId [Link] + [Link]
Quantity PKG_ESTOQUE.ESTOQUE_DISPONIVEL
unlimitedQuantity Apresenta o valor fixo "false"
WarehouseBranchId [Link]
WarehouseBranchName [Link]
14
Tutorial Processo VTEX
PREÇO:
Observação: quando se tratar de produto de Origem Web e/ou E-commerce a API não irá calcular o preço de venda
com Impostos. O preço de venda válido será sempre o preço vindo do E-commerce.
PRICE
Campos Banco CamposWinthor Rotina CamposWinthor Rotina
Retorno API Winthor 201 2017 (ATACADO) 2017 (VAREJO)
branchId [Link] [Link] [Link]
erpReferenceKey [Link] [Link] [Link]
fixedPrice [Link] [Link] [Link]
[Link] [Link] [Link]
lastChange A A A
origin 201 2017 2017
price PCTABPR.PVENDA1 PCEMBALAGEM.PVENDAATAC1 [Link]
PCTABPR.PVENDA2 [Link]
PCTABPR.PVENDA3 [Link]
PCTABPR.PVENDA4 [Link]
PCTABPR.PVENDA5 [Link]
PCTABPR.PVENDA6 [Link]
PCTABPR.PVENDA7 [Link]
pricingIpi [Link] [Link] [Link]
pricingSt [Link] [Link] [Link]
[Link], [Link], [Link],
skuId [Link] [Link] [Link]
taxFigureId [Link] [Link] [Link]
gnreST campo calculado campo calculado campo calculado
st campo calculado campo calculado campo calculado
calculationBaseFec
p campo calculado campo calculado campo calculado
calculationBaseIpi campo calculado campo calculado campo calculado
calculationBaseST campo calculado campo calculado campo calculado
internalSTAliquot campo calculado campo calculado campo calculado
ipi campo calculado campo calculado campo calculado
ipiAliquot campo calculado campo calculado campo calculado
externalSTAliquot campo calculado campo calculado campo calculado
fecp campo calculado campo calculado campo calculado
fecpAliquot campo calculado campo calculado campo calculado
15