Objetivo
Este documento tem como objetivo explicar o funcionamento para atualizar a flag enviaecommerce dos produtos.
Pré-Requisitos e Restrições
- Necessário a instalação do serviço winthor-compras-produto
Integração
Este documento tem como objetivo explicar o funcionamento para atualizar a flag enviaecommerce do cadastro de produtos.
Os dados integrados são:
| API | Referência Winthor | Descrição | Tipo | Obrigatório | Default |
|---|---|---|---|---|---|
| branch | PCEMBALAGEM.CODFILIAL | Filiais | List<String> | SIM | |
| supplierId | PCPRODUT.CODFORNEC | Códigos do fornecedores | List<Long> | NÃO | |
| supplierCNPJ | PCFORNEC.CGC | CNPJs do fornecedores | List<String> | NÃO | |
| brandId | PCPRODUT.CODMARCA | Códigos das marcas | List<Long> | NÃO | |
| departmentId | PCPRODUT.CODEPTO | Códigos dos departamentos | List<Long> | NÃO | |
| sectionId | PCPRODUT.CODSEC | Códigos das seções | List<Long> | NÃO | |
| categoryId | PCPRODUT.CODCATEGORIA | Códigos das categorias | List<Long> | NÃO | |
| subcategoryId | PCPRODUT.CODSUBCATEGORIA | Códigos das subcategorias | List<Long> | NÃO | |
| webDepartmentId | PCPRODUT.CODDEPTOWEB | Códigos dos departamentos WEB | List<Long> | NÃO | |
| webSectionId | PCPRODUT.CODSECAOWEB | Códigos das seções WEB | List<Long> | NÃO | |
| webCategoryId | PCPRODUT.CODCATEGORIAWEB | Códigos das categorias WEB | List<Long> | NÃO | |
| webSubcategoryId | PCPRODUT.CODSUBCATEGORIAWEB | Códigos das subcategorias WEB | List<Long> | NÃO | |
| typeOfMerchandise | PCPRODUT.TIPOMERC | Tipos de mercadorias Ex. de tipos:
| List<String> | NÃO | |
| resale | PCPRODUT.REVENDA | Revenda | Boolean | NÃO | |
| minYearOfSales | Mínimo de anos para filtrar as vendas, para verificar os produtos mais vendidos | Integer | NÃO | 1 | |
| maxTopProductsSold | Limita a quantidade dos produtos mais vendidos | Integer | NÃO | ||
| percentageTopSellingProducts | Verifica a quantidade de produtos mais vendidos pelo percentual do total de produtos cadastrado na base do cliente | Double | NÃO | ||
| productId | PCPRODUT.CODPROD | Código do produto | Long | NÃO | |
| updatedQuantity | Quantidade de produtos atualizados Este campo somente é usado na resposta da API | Long | NÃO | ||
| sendToECommerce | PCPRODUT.ENVIAECOMMERCE | Atualiza o produto para enviar para ecommerce | Boolean | NÃO | true |
minStockAvailable | PKG_ESTOQUE.ESTOQUE_DISPONIVEL | Verifica o estoque mínimo do produto | Integer | NÃO |
Observação: campos com o tipo "List" aceita 1 ou mais valores
Exemplo JSON do envio da requisição e dados do retorno:
URI - Cadastrar Cliente
method: 'PATCH', url: '/api/purchases/v1/products/e-commerce'
Body
{
"branch": ["1"],
"supplierId": [0],
"supplierCNPJ": ["0000000000000"],
"brandId": [0],
"departmentId": [0],
"sectionId": [0],
"categoryId": [0],
"subcategoryId": [0],
"webDepartmentId": [0],
"webSectionId": [0],
"webCategoryId": [0],
"webSubcategoryId": [0],
"typeOfMerchandise": ["PA"],
"resale": true,
"minYearOfSales": 5/*Consulta vendas dos ultimos 5 anos*/,
"maxTopProductsSold": 50,
"percentageTopSellingProducts": 10,
"productId": 1,
"sendToECommerce": true,
"minStockAvailable": 50 /*Produtos com estoque maior ou igual a 50*/
}
Exemplo JSON da resposta:
Body Response
{
"branch": ["1"],
"supplierId": [0],
"supplierCNPJ": ["0000000000000"],
"brandId": [0],
"departmentId": [0],
"sectionId": [0],
"categoryId": [0],
"subcategoryId": [0],
"webDepartmentId": [0],
"webSectionId": [0],
"webCategoryId": [0],
"webSubcategoryId": [0],
"typeOfMerchandise": ["PA"],
"resale": true,
"minYearOfSales": 5,
"maxTopProductsSold": 50,
"percentageTopSellingProducts": 10,
"productId": 1,
"updatedQuantity": 250 /*250 produtos atualizados*/
}
Exemplo JSON do envio da requisição e dados do retorno:
URI - Consultar
method: 'GET', url: '/api/purchases/v1/products/e-commerce/totals' parametros: - page - página - pageSize - tamanho da página - branch - filais, campo obrigatório (Aceita mais de um valor, Ex: branch=1,2) - supplierId - código fornecedor (Aceita mais de um valor, Ex: supplierId=1,2) - supplierCNPJ - CNPJ do fornecedor (Aceita mais de um valor, Ex: supplierCNPJ=00000000000000,111111111111111) - brandId - código da marca (Aceita mais de um valor, Ex: brandId=1,2) - departmentId - código do departamento (Aceita mais de um valor, Ex: departmentId=1,2) - sectionId - código da seção (Aceita mais de um valor, Ex: sectionId=1,2) - categoryId - código da categoria (Aceita mais de um valor, Ex: categoryId=1,2) - subcategoryId - código da subcategoria (Aceita mais de um valor, Ex: subcategoryId=1,2) - webDepartmentId - código do departamento WEB (Aceita mais de um valor, Ex: webDepartmentId=1,2) - webSectionId - código da seção WEB (Aceita mais de um valor, Ex: webSectionId=1,2) - webCategoryId - código da categoria WEB (Aceita mais de um valor, Ex: webCategoryId=1,2) - webSubcategoryId - código da subcategoria WEB (Aceita mais de um valor, Ex: webSubcategoryId=1,2) - typeOfMerchandise - Tipo de mercadoria (Aceita mais de um valor, Ex: typeOfMerchandise=PA,L) - minYearOfSales - Mínimo de anos para filtrar as vendas, para verificar os produtos mais vendidos - maxTopProductsSold - Limita a quantidade dos produtos mais vendidos - percentageTopSellingProducts - Verifica a quantidade de produtos mais vendidos pelo percentual do total de produtos cadastrado na base do cliente - productId - Código do produto - minStockAvailable - Estoque mínimo do produto - resale - Revenda
Exemplo JSON da resposta:
Body Response
{
"totalBranches": [
{
"branchId": "1", /*Filial*/
"quantityProduct": 5731, /*Quantidade de produtos*/
"quantityEcommerceProducts": 5731, /*Quantidade de produtos marcado para enviar para ecommerce*/
"quantityProductsContainsStock": 5731, /*Quantidade de produtos que contém estoques*/
"quantityProductsContainsStockAndEcommerce": 5731/*Quantidade de produtos que contém estoques e estão marcados para enviar para ecommerce*/
}
],
"products": {
"first": false,
"items": [
{
"name": "produto",
"active": true,
"visible": true,
"brandId": 0,
"categoryId": 0,
"description": "",
"id": 11317,
"isActive": true,
"isVisible": true,
"lastChange": "2023-02-02T13:48:39",
"length3": 0,
"NCM": "22222222",
"webDepartmentId": 0,
"webSectionId": 0,
"webCategoryId": 0,
"webSubcategoryId ": 0,
"netWeightKg": 1,
"observation": "PL",
"principalProductId": 11317,
"productionLineId": 0,
"productSKUId": "11317-11317",
"realHeight3": 0,
"realWeightKg": 1,
"releaseDate": "1900-01-01T00:00:00",
"sectionId": 9999,
"showWithoutStock": false,
"subcategoryId": 0,
"supplierDescription": "TOTVS BRASILIA S.A.",
"supplierId": 1292,
"technicalData": "",
"technicalInformation": "",
"merchandiseType": "L",
"title": "LOW ACHOCOLATADO DIET NEW CHOCO 300GR",
"volume": 0,
"width3": 0
}
],
"hasNext": true
}
}
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas