CONTEÚDO
- Visão Geral
- Configuração
- Informações Enviadas
- Exemplo de utilização
- Detalhes do campo lastChange
01. VISÃO GERAL
Este documento tem a função de disponibilizar informações de como cadastrar produtos similares(Specifications) para enviar ao TOTVS Conector Vtex.
É utilizado no endpoint: productsimilars
02. CONFIGURAÇÃO
Para os produtos similares serem enviados para o Conector, é necessário que tenham as seguintes configurações primeiro:
- Dados do grupo(root) configurados para o TOTVS Conector Vtex.
- Dados do produto(sku) configurados para o TOTVS Conector Vtex.
03. INFORMAÇÕES ENVIADAS
Para utilizar a requisição productsimilars, é 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).
Também tem os parâmetros, que especificam o tipo do retorno, onde um deles deve estar informado como "true":
- IsProduct: Para cada produto encontrado serão retornados os similares vinculados a ele, desde que o produto similar esteja configurado para ser enviado ao Conector Vtex.
- IsRoot: Para cada produto encontrado será retornado a sua grade do grupo, desde que esses produtos estejam configurados para ser enviados ao Conector Vtex.
- IsReference: Para cada grupo encontrado serão retornados todos os códigos de produto dos grupos vinculados a ele e também os produtos do próprio grupo, desde que esses produtos estejam configurados para ser enviados ao Conector Vtex.
Esses são os dados de especificações do produto que são enviados ao Conector VTEX através dos endpoints productsimilars.
Para o parâmetro IsProduct será enviado essa informação.
Para o parâmetro IsReference será enviado essa informação.
Para o parâmetro IsRoot será enviado essa informação.
Os campos companyId, branchId e lastChange já foram descritos na documentação de cadastro de grupo(root).
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 productsimilars as entidades PRD_PRDWEB, PRD_GRDWEB, PRD_PRDSIMILAR são verificadas, estas entidades são utilizadas respectivamente nos componentes abaixo.
- PRDFM328 - "Configuração de produto para o TOTVS Conector Vtex" → botão "Grade" no frame "Informações".
- PRDFM328 - "Configuração de produto para o TOTVS Conector Vtex" no frame "Informações".
- PRDFM009 - "Manutenção de Grupo/grade" → opção Similar → botão grade.