TOTVS Distribuição e Varejo - linha Winthor

Páginas filhas
  • APIs Integrações - Categoria

Objetivo

Este documento tem como objetivo explicar o funcionamento da integração da Categoria.

Pré-Requisitos e Restrições

  • Necessário a instalação do serviço winthor-compras-produto. Para realizar a instalação desse serviço, segue link com as devidas explicações:

Comece por aqui -> Parametrizações WTA

  • Para realizar o cadastro de Categorias no WinThor, acesse o link abaixo:

Como realizar o cadastro de categoria no WinThor?

A categoria cadastrada deve estar com o campo Enviar para E-commerce igual a Sim.


Importante

Quando não houver preenchimento do campo DATA, exemplo (data de cadastro, data de alteração), nossas API's retornarão, por padrão, a informação "1900-01-01T00:00:00".

Caso necessário, realizar o ajuste nos cadastros para que a API apresente a data desejada.

Integração

A integração consiste em enviar todas as categorias que serão utilizados no E-Commerce.

Os dados integrados são: 

CATEGORYPCCATEGORIA
APIReferência Winthor
idpccategoria.codcategoria
namepccategoria.categoria
titlepccategoria.categoria
descriptionpccategoria.categoria
keywordspcpalavraschave.descricao
lastChangepccategoria.dtultalter
section
idpcsecao.codsec
descriptionpcsecao.descricao
titlepcdepto.titulo
keywordspcpalavraschave.descricao
adWordsRemarketingCodepcdepto.codadwords
lastChangepcsecao.dtultalter
department
idpcdepto.codepto
namepcdepto.descricao
fatherCategoryIdpcdepto.coddeptoprinc
titlepcdepto.titulo
descriptionpcdepto.descricaoecommerce
keywordspcpalavraschave.descricao
adWordsRemarketingCodepcdepto.codadwords
lomadeeCampaignCodepcdepto.codcamplomadee
lastChangepcdepto.dtultalter
updateStockGeneralpcdepto.atualizainvgeral
typeMerchandisepcdepto.tipomerc
dtcreatepcdepto.dtcadastro
isActivepcdepto.enviaecommerce
dtcreatepcsecao.dtcadastro
dtcreatepccategoria.dtcadastro dtcreate
subcategories
categoryIdpcsubcategoria.codcategoria
descriptionpcsubcategoria.subcategoria
idpcsubcategoria.codsubcategoria
keywordspchave.descricao
namepcsubcategoria.subcategoria
sectionIdpcsecao.sectionId
title(sem referencia de tabela)

Exemplo do envio da requisição:

method: 'GET',
url: '/api/purchases/v1/productCategories/{id secao}/{id categoria}' --> Apresenta apenas uma categoria de acordo com o filtro.

method: 'GET',
url: '/api/purchases/v1/productCategories/' --> Retorna a lista de categorias de acordo com os parâmetros abaixo.
Params
order  		: lastChange			- ordenação
lastChange  : 1900-01-01T00:00:00	- data da última alteração
page		: 1						- número de página
pageSize	: 10					- quantidade por página
sectionId	: 1						- código da seção

Exemplo JSON da resposta:  

Body Response 
{
   "first": false,
   "items": [
	{
		"description": "string",
		"dtcreate": "2020-11-16T14:53:16",
		"id": 0,
		"keywords": "",
		"lastChange": "1900-01-01T00:00:00",
		"name": "string",
			"section": {
				"id": 0,
				"description": "string",
				"title": "string",
				"keywords": "",
				"adWordsRemarketingCode": "",
				"lastChange": "2020-10-27T09:22:29",
				"department": {
					"id": 0,
					"name": "string",
					"fatherCategoryId": 0,
					"title": "string",
					"description": "string",
					"keywords": "",
					"adWordsRemarketingCode": null,
					"lomadeeCampaignCode": null,
					"lastChange": "2020-10-27T08:53:07",
					"updateStockGeneral": boolean,
					"typeMerchandise": "string",
					"dtcreate": "2020-07-16T00:00:00",
					"active": boolean
				},
				"dtcreate": "2020-07-16T00:00:00"
		},
		"sectionId": 0,
		"subcategories": [],
		"title": ""
	} 
 ],
 "hasNext": true
}

Demonstração utilizando o Postman para realizar as requisições na API. 



Para que seja realizada uma nova integração atualizando um registro já integrado, o sistema verifica a data de última atualização do registro. Portanto, ao realizar alguma alteração no registro, ele será encaminhado novamente para a view para manter a integridade dos dados do ERP com o E-commerce. 



  • Sem rótulos