Histórico da Página

...

Pré-Requisitos e Restrições

Necessário a instalação do serviçodo serviço winthor-compras-produto

Integração

...

Totvs custom tabs box

tabs	Dados integrados com Winthor, Envio Parâmetros/Resposta da Requisição Para Atualiza Atualizar 'enviaecommerce',Envio Parâmetros/Resposta da Requisição Para Consultar
ids	passo1,passo2,passo3

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 fornecedores	List<Long>	NÃO
supplierCNPJ	PCFORNEC.CGC	CNPJs do fornecedorfornecedores	List<String>	NÃO
brandId	PCPRODUT.CODMARCA	Códigos das Marcasmarcas	List<Long>	NÃO
departmentId	PCPRODUT.CODEPTO	Códigos dos Departamentosdepartamentos	List<Long>	NÃO
sectionId	PCPRODUT.CODSEC	Códigos das Seçãos seções	List<Long>	NÃO
categoryId	PCPRODUT.CODCATEGORIA	Códigos das Categoriascategorias	List<Long>	NÃO
subcategoryId	PCPRODUT.CODSUBCATEGORIA	Códigos das Subcategoriassubcategorias	List<Long>	NÃO
webDepartmentId	PCPRODUT.CODDEPTOWEB	Códigos dos Departamento departamentos WEB	List<Long>	NÃO
webSectionId	PCPRODUT.CODSECAOWEB	Códigos das Seções seções WEB	List<Long>	NÃO
webCategoryId	PCPRODUT.CODCATEGORIAWEB	Códigos das Categorias categorias WEB	List<Long>	NÃO
webSubcategoryId	PCPRODUT.CODSUBCATEGORIAWEB	Códigos das Subcatergorias subcategorias WEB	List<Long>	NÃO
typeOfMerchandise	PCPRODUT.TIPOMERC	Tipos de mercadoria.mercadorias 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

ObsObservação: 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

language	js
title	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:

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: 'PATCHGET',
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:

Bloco de código

language	js
title	Body Response

{
    "branchtotalBranches": [
        {
            "branchId": "1"], /*Filial*/
            "supplierIdquantityProduct": [0],
5731, /*Quantidade de produtos*/
            "supplierCNPJquantityEcommerceProducts": ["0000000000000"],
 5731, /*Quantidade de produtos marcado para enviar para ecommerce*/
            "quantityProductsContainsStock": 5731, /*Quantidade de produtos que contém estoques*/
            "brandIdquantityProductsContainsStockAndEcommerce": [0],
 5731/*Quantidade de produtos que contém estoques e estão marcados para enviar para ecommerce*/
        }
    ],
    "products": {
        "departmentIdfirst": [0]false,
        "sectionIditems": [0],

            {
                "categoryIdname": [0]"produto",
    "subcategoryId            "active": [0]true,
    "webDepartmentId            "visible": [0]true,
      "webSectionId          "brandId": [0],
    "webCategoryId            "categoryId": [0],
                "webSubcategoryIddescription": [0]"",
                "typeOfMerchandiseid": ["PA"],
 11317,
                "isActive": true,
                "resaleisVisible": true,
                "minYearOfSaleslastChange": 5/*Consulta vendas dos ultimos 5 anos*/"2023-02-02T13:48:39",
                "length3": 0,
    "maxTopProductsSold            "NCM": 50"22222222",
     "percentageTopSellingProducts           "webDepartmentId": 100,
                "productIdwebSectionId": 10,
                "sendToECommercewebCategoryId": true0,
            "minStockAvailable    "webSubcategoryId  ": 50 /*Produtos com estoque maior ou igual a 50*/  
}

Exemplo JSON da resposta:

Bloco de código

language	js
title	Body Response

{ 0,
                "netWeightKg": 1,
    "branch            "observation": ["1PL"],
       "supplierId         "principalProductId": [0]11317,
    "supplierCNPJ            "productionLineId": ["0000000000000"]0,
                "brandIdproductSKUId": [0],
"11317-11317",
                "departmentIdrealHeight3": [0],
        "sectionId        "realWeightKg": [0]1,
                "categoryIdreleaseDate": [0]"1900-01-01T00:00:00",
    "subcategoryId            "sectionId": [0]9999,
     "webDepartmentId           "showWithoutStock": [0]false,
    "webSectionId            "subcategoryId": [0],
    "webCategoryId": [0],
            "supplierDescription": "TOTVS BRASILIA S.A.",
         "webSubcategoryId       "supplierId": [0]1292,
                "typeOfMerchandisetechnicalData": ["PA"],
    "resale            "technicalInformation": true"",
                "minYearOfSalesmerchandiseType": 5"L",
       "maxTopProductsSold         "title": 50,
"LOW ACHOCOLATADO DIET NEW CHOCO 300GR",
                "percentageTopSellingProductsvolume": 100,
    "productId": 1,
            "width3": 0
            }
        ],
        "updatedQuantityhasNext": 250 /*250 produtos atualizados*/
} true
    }
}

Páginas filhas

Versões comparadas

Versão antiga 12

Nova versão Atual

Chave

Pré-Requisitos e Restrições

Integração