Histórico da Página

CONTEÚDO

1. Visão Geral
2. Configuração
3. Informações Enviadas
4. Exemplo de utilização
5. Detalhes do campo lastChange

01. VISÃO GERAL

Este endpoint documento tem a função de disponibilizar informações de cadastro do produto para compor o catálogo de produtos na Plataforma de E-Commerce VTEX. Este endpoint refere-se à requisição /api/ecommerce/v1/completeproductroots.

02. CONFIGURAÇÃO

Abaixo será demonstrado as configurações necessárias para que um produto seja integrado com o Conector Vtex.

...

como cadastrar um grupo(root) para enviar informações para o TOTVS Conector Vtex.
São utilizados os endpoints:  completeproductroots e colorproductroots

02. CONFIGURAÇÃO

Para o grupo ser enviado para o Conector, é necessário que tenham as seguintes configurações:

• Dados base do grupo, configurados no PRDFM328 que são:
  • Descrição
  • Subcategoria
  • Marca
  • Empresa integrada

02.01 Envio da marca

A marca  do produto da VTEX é uma classificação do produto no Totvs Moda.

Para enviar a marca é necessário configurar um dos dois parâmetros disponíveis, o DS_LST_ECOMMERCE_VA_MARCA ou o CD_TPCLAS_MARCA_ECOMMERCE. Caso configure os dois, será considerado apenas o CD_TPCLAS_MARCA_ECOMMERCE.

No parâmetro DS_LST_ECOMMERCE_VA_MARCA é possível configurar um ou mais classificações como marca, conforme imagem abaixo.

Image Added

No parâmetro CD_TPCLAS_MARCA_ECOMMERCE informa- se somente o tipo de classificação, onde todos os produtos com esse tipo de classificação serão consideras no envio.

Image Added

É necessário que o produto tenha o mesmo tipo e a classificação de acordo com um dos parâmetro configurados anteriormente. 

Image Added

02.02 Subcategorias

As subcategorias são cadastradas no componente PRDFM318, onde se monta a árvore de categorias que será enviada para o Conector

02.03 Dados do Grupo(root)

Para configurar o grupo para que seja enviado para o Conector deve acessar o componente PRDFM328. Esse componente é chamado também pelo PRDFC072 botão TOTVS Conector.

Image Added

Para o grupo ser enviado, obrigatoriamente precisa ter dados gravados nesse componente. Configurando obrigatoriamente a área de Informações, Subcategoria, Marca e Empresa.

• Informações: Dados base do grupo.
• Subcategoria: Deve-se cadastrar apenas uma subcategoria para o grupo.
• Marca: Classificação configurada na imagem anterior, de acordo com os parâmetros CD_TPCLAS_MARCA_ECOMMERCE ou DS_LST_ECOMMERCE_VA_MARCA.
• Empresa: Deve ser cadastrado qual empresa o produto estará disponível para o envio de informações.

02.04 Enviar código do grupo quebrado por Cor

Para enviar os grupos(root) quebrados por cor, deve ser utilizado o componente INTFM028 que vai gerar um código integrador. Para quem utiliza o código integrador quebrado por cor, é obrigatório que todos os seus grupos(root) tenham um código integrador gerado, pois será utilizado o endPoint colorproductroots, que somente disponibiliza grupos(root) que possuem esse código.

Image Added

03. INFORMAÇÕES ENVIADAS

Para utilizar as requisições  completeproductroots e colorproductroots, é necessário enviar como parâmetro de entrada 3 campos obrigatórios:

• BranchId: Código da filial.
• LastChange: Data da última modificação do produto.
• CompanyId: Código da empresa (O mesmo que o BranchId).

Esses são os dados de grupo de produto enviados ao Conector através dos endpoints completeproductroots.

Image Added

Alguns campos do exemplo não foram descritos pois não estão em tela para apresentar:

• createDate: Data da criação do grupo de produto.
• isActive: Situação ativo/inativo dos dados para filial do produto, encontrado no PRDFM009.
• isVisible: Sempre será true.
• descriptionAux: Descrição auxiliar, campo "Descritivo" no PRDFM164.

Esses são os dados cor de produto enviados ao Conector através do endpoint colorproductroots.

Image Added

Alguns campos não foram exemplificados pois são os mesmo da imagem anterior.

04. EXEMPLO DE UTILIZAÇÃO

Documento de como utilizar a API: https://www30.bhan.com.br:12443/api/ecommerce/v1/swagger/index.html

05. DETALHES DO CAMPO LASTCHANGE

Para apresentar o campo lastchange no retorno do endpoint completeproductroots as entidades PRD_GRDWEB PRD_GRDCLASWEB são verificadas, estas entidades são utilizadas respectivamente nos componentes abaixo

• PRDFM328 - "Configuração de produto para o TOTVS Conector Vtex"  no frame "Informações".
• PRDFM328 - "Configuração de produto para o TOTVS Conector Vtex" no frame "Subcategoria" abrirá o PRDFM182

Para apresentar o campo lastchange no retorno do endpoint colorproductroots as entidades PRD_GRDWEB, INT_DEPARAGRDC, PRD_GRDCLASWEB são verificadas, estas entidades são utilizadas respectivamente nos componentes abaixo

• PRDFM328 - "Configuração de produto para o TOTVS Conector Vtex"  no frame "Informações".
• PRDFM328 - "Configuração de produto para o TOTVS Conector Vtex" → botão "Código integrador" no frame "Grupo de Produto De Para".
• PRDFM328 - "Configuração de produto para o TOTVS Conector Vtex" no frame "Subcategoria" abrirá o PRDFM182

<!-- esconder o menu --> 


<style>
div.theme-default .ia-splitter #main {
    margin-left: 0px;
}
.ia-fixed-sidebar, .ia-splitter-left {
    display: none;
}
#main {
    padding-left: 10px;
    padding-right: 10px;
    overflow-x: hidden;
}

.aui-header-primary .aui-nav,  .aui-page-panel {
    margin-left: 0px !important;
}
.aui-header-primary .aui-nav {
    margin-left: 0px !important;
}
</style>