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 um produto(sku) para enviar informações para o Totvs Conector Vtex.
São utilizados os endpoints: completeproductskus e colorproductskus
02. CONFIGURAÇÃO
Para o produto(sku) ser enviado para o Conector, é necessário que tenham as seguintes configurações:
- Dados do grupo(root) configurados para o TOTVS Conector Vtex
- Dados do produto cadastrado no componente PRDFM329.
- A situação do produto no PRDFM329 deve estar com ATIVO.
02.01 Dados do produto
Os dados do produto são cadastrados pelo componente PRDFM329 que é chamado pelo componente PRDFM328 clicando no botão "Grade"
Neste componente são configuradas as informações que serão enviadas para o TOTVS Conector, onde os produtos(sku) podem ser configurados individualmente no bloco "Informações".
- Descrição: Descrição do produto(sku). Caso este campo não seja informado será enviada a descrição do grupo(root).
- Peso e Medidas: Informações referentes a Peso, Altura, Largura e Profundidade do produto(sku). Caso estes campos não sejam informados serão enviados os valores do grupo(root).
- Situação: Pode ser alternada entre "Ativo" e "Bloqueado". Caso o produto esteja com a situação "Bloqueado", não será enviado ao Conector.
02.02 Valor do produto(sku)
O envio de valor do produto(sku) é feita através do cadastro do parâmetro DS_VALOR_ECOMMERCE_VA onde deverá ser informado o tipo de valor que será enviado ao Conector.
02.03 Código de barras do produto(sku)
O envio da informação de Código de Barras é feita através do cadastro de um Código de Barras padrão no componente PRDFM022
02.04 Unidade de medida produto(sku)
A plataforma VTEX aceita a seguinte lista de unidades de medida. Caso o produto(sku) esteja informado com uma unidade de medida diferente, será enviada a unidade de medida padrão "un".
- un (unidade);
- kg (kilograma);
- g (grama);
- mg (miligrama);
- m (metro);
- cm (centímetro);
- mm (milímetro);
- oz (onça);
- lb (libra);
- ft (pés);
- in (polegada);
02.05 Cadastro de informação de cor do produto(sku)
Para enviar os dados de cor do produto, deve-se configurar ao menos um produto, para que possa ser enviado ao VTEX através do endpoint colorproductskus.
03. INFORMAÇÕES ENVIADAS
Para utilizar as requisições completeproductskus e colorproductskus, é necessário enviar ao menos 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 produto enviados ao TOTVS Conector através dos endpoints completeproductskus, colorproductskus.
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).
- createDate: Data da criação do produto.
- isActive:
- Caso o campo "Inativo" do componente PRDFM009 → "Dados para filial", estiver marcado será retornado o valor "false".
- Caso o campo "Inativo" do componente PRDFM009 → "Dados para filial", não estiver marcado e o campo situação do componente PRDFM329 estiver com o valor "Inativo", será retornado o valor "false".
- Caso o campo "Inativo" do componente PRDFM009 → "Dados para filial", não estiver marcado e o campo situação do componente PRDFM329 estiver com o valor "Ativo", será retornado o valor "true".
- isAvaiable: Valor padrão = "true".
- unitMultiplier: Valor padrão = 1.0.
- rewardValue: Valor padrão = 0.0.
- price: Valor cadastrado no componente PRDFM009 → Valor, e informado no parâmetro DS_VALOR_ECOMMERCE_VA.
- priceAux: Valor cadastrado no componente PRDFM009 → Valor, e informado no parâmetro DS_VALORAUX_ECOMMERCE_VA.
- modalType: Valor padrão = null.
- modalId: Valor padrão = null.
- listPrice: Valor padrão = null.
- cubicWeight: Valor padrão = 0.0
- commercialConditionId: Valor padrão = null.
- classifications: como parâmetro de busca, os endpoints contam com o campo "classificationTypeCodeList" onde é retornado o tipo de classificação informado.
O campo isKit é informado como "true" quando o produto faz parte de algum kit.
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 completeproductskus as entidades PRD_PRDWEB, PRD_GRDWEB, PRD_VALOR e PRD_PRDINFO 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".
- PRDFP020 - "Alteração de preço para cor e tamanho".
- PRDFM236 - Manutenção de Produto Configurável, bloco "Dados por empresa".
Para apresentar o campo lastchange no retorno do endpoint colorproductskus as entidades PRD_PRDWEB, PRD_GRDWEB, INT_DEPARAGRDC, INT_DEPARAGRDI, PRD_VALOR e PRD_PRDINFO 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".
- 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" → botão "Código integrador" no frame "Grupo de Produto De Para".
- PRDFP020 - "Alteração de preço para cor e tamanho".
- PRDFM236 - Manutenção de Produto Configurável, bloco "Dados por empresa".