Páginas filhas
  • APIs Integrações - Atualizar flag enviaecommerce produto - HOMOLOGAÇÃO

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Totvs custom tabs box
tabsDados integrados com Winthor, Envio Parâmetros/Resposta da Requisição Para Atualiza Atualizar 'enviaecommerce',Envio Parâmetros/Resposta da Requisição Para Consultar
idspasso1,passo2,passo3

Este documento tem como objetivo explicar o funcionamento para atualizar a flag enviaecommerce do cadastro de produtos.

Totvs custom tabs box items
defaultyes
referenciapasso1

Os dados integrados são: 

APIReferência Winthor DescriçãoTipoObrigatórioDefault
branchPCEMBALAGEM.CODFILIALFiliaisList<String>SIM
supplierIdPCPRODUT.CODFORNECCódigos do fornecedores List<Long>NÃO
supplierCNPJPCFORNEC.CGCCNPJs do fornecedoresList<String>NÃO
brandIdPCPRODUT.CODMARCACódigos das marcasList<Long>NÃO
departmentIdPCPRODUT.CODEPTOCódigos dos departamentosList<Long>NÃO
sectionIdPCPRODUT.CODSECCódigos das seções List<Long>NÃO
categoryIdPCPRODUT.CODCATEGORIACódigos das categoriasList<Long>NÃO
subcategoryIdPCPRODUT.CODSUBCATEGORIACódigos das subcategoriasList<Long>NÃO
webDepartmentIdPCPRODUT.CODDEPTOWEBCódigos dos departamentos WEBList<Long>NÃO
webSectionIdPCPRODUT.CODSECAOWEBCódigos das seções WEBList<Long>NÃO
webCategoryIdPCPRODUT.CODCATEGORIAWEBCódigos das categorias WEBList<Long>NÃO
webSubcategoryIdPCPRODUT.CODSUBCATEGORIAWEBCódigos das subcategorias WEBList<Long>NÃO
typeOfMerchandisePCPRODUT.TIPOMERC

Tipos de mercadorias

Ex. de tipos:

  • PA
  • KT
  • BD
  • EM
  • L
  • ME
  • PB
  • MP
  • M
  • MA
  • PL
  • RE
  • SA
  • SP
  • SF
  • VA
List<String>NÃO
resalePCPRODUT.REVENDARevendaBooleanNÃO
minYearOfSales
Mínimo de anos para filtrar as vendas, para verificar os produtos mais vendidos IntegerNÃO1
maxTopProductsSold
Limita a quantidade dos produtos mais vendidosIntegerNÃO
percentageTopSellingProducts
Verifica a quantidade de produtos mais vendidos pelo percentual do total de produtos cadastrado na base do clienteDoubleNÃO
productIdPCPRODUT.CODPRODCódigo do produtoLongNÃO
updatedQuantity

Quantidade de produtos atualizados

Este campo somente é usado na resposta da API

LongNÃO
sendToECommercePCPRODUT.ENVIAECOMMERCEAtualiza o produto para enviar para ecommerceBooleanNÃOtrue

minStockAvailable

PKG_ESTOQUE.ESTOQUE_DISPONIVELVerifica o estoque mínimo do produto IntegerNÃO


Observação: campos com o tipo "List" aceita 1 ou mais valores  

Totvs custom tabs box items
defaultno
referenciapasso2

Exemplo JSON do envio da requisição e dados do retorno:

Bloco de código
languagejs
titleURI - Cadastrar Cliente
method: 'PATCH',
url: '/api/purchases/v1/products/e-commerce'
Bloco de código
languagejs
titleBody
{
    "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
languagejs
titleBody 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
defaultno
referenciapasso3

Exemplo JSON do envio da requisição e dados do retorno:

Bloco de código
languagejs
titleURI - Consultar
method: 'PATCH',
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
languagejs
titleBody 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
    }
}

...