Este documento tem como objetivo explicar o funcionamento para atualizar a flag enviaecommerce do cadastro de produtos. Totvs custom tabs box items |
---|
default | yes |
---|
referencia | passo1 |
---|
| 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 fornecedor | List<Long> | NÃO |
| supplierCNPJ | PCFORNEC.CGC | CNPJs do fornecedor | 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çãos | 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 Departamento 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 Subcatergorias WEB | List<Long> | NÃO |
| typeOfMerchandise | PCPRODUT.TIPOMERC | Tipos de mercadoria. Ex. de tipos: - PA
- KT
- BD
- EM
- L
- ME
- PB
- MP
- M
- MA
- PL
- RE
- SA
- SP
- SF
- VA
| 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 |
|
Obs: campos com o tipo "List" aceita 1 ou mais valores |
Totvs custom tabs box items |
---|
default | no |
---|
referencia | passo2 |
---|
| Exemplo JSON do envio da requisição e dados do retorno: Bloco de código |
---|
language | js |
---|
title | URI - Cadastrar Cliente |
---|
| method: 'PATCH',
url: '/api/purchases/v1/products/e-commerce'
|
Bloco de código |
---|
| {
"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: Bloco de código |
---|
language | js |
---|
title | 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*/
} |
|
Totvs custom tabs box items |
---|
default | no |
---|
referencia | passo3 |
---|
| Exemplo JSON do envio da requisição e dados do retorno: Bloco de código |
---|
language | js |
---|
title | URI - Cadastrar ClienteConsultar |
---|
| method: 'PATCH',
url: '/api/purchases/v1/products/e-commerce/totals'
parametros:
- page page - página
- pageSize pageSize - tamanho da pagina
- branch branch - filais, campo obrigatório (Aceita mais de um valor, Ex: branch=1,2)
- supplierId supplierId - código fornecedor (Aceita mais de um valor, Ex: supplierId=1,2)
- supplierCNPJ supplierCNPJ - CNPJ do fornecedor (Aceita mais de um valor, Ex: supplierCNPJ=00000000000000,111111111111111)
- brandId brandId - código da marca (Aceita mais de um valor, Ex: brandId=1,2)
- departmentId departmentId - código do departamento (Aceita mais de um valor, Ex: departmentId=1,2)
- sectionId sectionId - código da seção (Aceita mais de um valor, Ex: sectionId=1,2)
- categoryId categoryId - código da categoria (Aceita mais de um valor, Ex: categoryId=1,2)
- subcategoryId subcategoryId - código da subcategoria (Aceita mais de um valor, Ex: subcategoryId=1,2)
- webDepartmentId webDepartmentId - código do departamento WEB (Aceita mais de um valor, Ex: webDepartmentId=1,2)
- webSectionId webSectionId - código da seção WEB (Aceita mais de um valor, Ex: webSectionId=1,2)
- webCategoryId webCategoryId - código da categoria WEB (Aceita mais de um valor, Ex: webCategoryId=1,2)
- webSubcategoryId webSubcategoryId - código da subcategoria WEB (Aceita mais de um valor, Ex: webSubcategoryId=1,2)
- typeOfMerchandise typeOfMerchandise - Tipo de mercadoria (Aceita mais de um valor, Ex: typeOfMerchandise=PA,L)
- minYearOfSales minYearOfSales - Mínimo de anos para filtrar as vendas, para verificar os produtos mais vendidos
- maxTopProductsSold maxTopProductsSold - Limita a quantidade dos produtos mais vendidos
- percentageTopSellingProducts percentageTopSellingProducts - Verifica a quantidade de produtos mais vendidos pelo percentual do total de produtos cadastrado na base do cliente
- productId productId - código do produto
- minStockAvailable minStockAvailable - Estoque mínimo do produto
- resale resale - revenda |
Exemplo JSON da resposta: Bloco de código |
---|
language | js |
---|
title | 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
}
} |
|
|