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 consultar promoção ou preço para o produto(price products) para enviar informações para o Totvs Conector Vtex.
É utilizado o endpoint: branchpriceproducts.
02. CONFIGURAÇÃO
Para o preço (price) ser enviado para o Conector, é necessário que tenham as seguintes configurações:
- Dados de qual o tipo e código de valor serão enviados configurados para o TOTVS Conector Vtex -> Configuração -> Parâmetros
- O mesmo valor informado no parâmetro DS_VALOR_ECOMMERCE_VA deve ser informado ao produto ou grupo no componente PRDFM015 ou PRDFP020.
02.01 Dados do preço
Os dados do produto são cadastrados pelo componente PRDFM015 ou PRDFP020 que é chamado pelo componente PRDFM009 clicando no opção "Valor"
Neste componente são configuradas as informações do preço do produto(sku) que serão enviadas para o TOTVS Conector.
- Tipo de Preço: O tipo informado para o produto(sku), deve ser o mesmo informado no parâmetro DS_VALOR_ECOMMERCE_VA para o TOTVS Conector Vtex -> Configuração -> Parâmetros.
- Valor: Valor para o produto(sku) configurados para o TOTVS Conector Vtex.
02.02 Configuração da promoção
Para o preço de promoção (price) ser enviado para o Conector, é necessário que tenham as seguintes configurações:
- Dados de qual o tipo e código de valor serão enviados configurados para o TOTVS Conector Vtex -> Configuração -> Parâmetros
- Caso possuir promoção cadastrado no componente PRDFM002 o tipo de valor deve ser o mesmo do parâmetro DS_VALOR_ECOMMERCE_VA.
Neste componente são configuradas as informações do preço de promoção para o produto(sku) que serão enviadas para o TOTVS Conector.
- Tipo de Preço: O tipo informado para o produto(sku), deve ser o mesmo informado no parâmetro DS_VALOR_ECOMMERCE_VA para o TOTVS Conector Vtex -> Configuração -> Parâmetros.
- Valor: Valor de promoção para o produto(sku) configurados para o TOTVS Conector Vtex.
- Período: Período da promoção para o produto(sku) configurados para o TOTVS Conector Vtex.
03. INFORMAÇÕES ENVIADAS
Para utilizar a requisição branchpriceproducts é necessário enviar ao menos os campos obrigatórios:
- BasebranchId: Código da filial.
- LastChange: Data da última modificação.
- BranchId: Código da empresa (O mesmo que o BranchId).
- PriceIdList: Lista com os tipos de valores conforme configurado no parâmetro DS_VALOR_ECOMMERCE_VA para o TOTVS Conector Vtex -> Configuração -> Parâmetros.
- Ispromotion: Quando informado o valor false, será enviado apenas o preço do produto(sku), quando informado true, retornará preço e promoção.
Esses são os dados de preço enviados ao TOTVS Conector através do endpoint branchpriceproducts, apenas preço com o isPromotion igual a false.
Alguns campos do exemplo não foram descritos pois contém valores padrão do TOTVS Conector VTEX:
- companyId: Empresa integrada.
- branchId: Filial integrada (o mesmo que companyId).
- initialDate: Data inicial para o tipo de valor preço.
- finalDate: Data final para o tipo de valor preço.
- createDate: Data de criação para o tipo de valor preço.
- lastChange: Data da alteração para o tipo de valor preço.
- discountValue: Valor de diferença entre os campos grossValue e netValue.
- minimunSalePrice: Valor default 0.0.
- discountFactor: Valor default 0.0.
- isActive: Valor default true.
Esses são os dados de preço enviados ao TOTVS Conector através do endpoint branchpriceproducts, apenas preço com o isPromotion igual a true.
Alguns campos do exemplo não foram descritos pois contém valores padrão do TOTVS Conector VTEX:
- discountValue: Valor de diferença entre os campos grossValue e netValue.
- minimunSalePrice: Valor default 0.0.
- discountFactor: Valor default 0.0.
- isActive: Valor default true.
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 branchpriceproducts as entidades PRD_PROMOCAO, PRD_PROMOCAOITEM, PRD_VALOR são verificadas, estas entidades são utilizadas respectivamente nos componentes abaixo.
- PRDFM002 - "Manutenção de promoção temporária".
- PRDFM002- "Manutenção de promoção temporária".
- PRDFP020 - "Alteração de preço para cor e tamanho".