Blog

Objetivo

Permite consultar as formulações dos produtos e os componentes diretamente vinculados a cada fórmula.

Rota

GET /v1/produto_formulacao_get

Parâmetros

Parâmetro	Tipo	Descrição
Page	Integer	Número da página.
PageSize	Integer	Quantidade de registros por página.
CodigoProduto	String	Código do produto.
GrupoProduto	String	Código do grupo do produto.
SomenteFormulaPadrao	Boolean	Retorna somente a fórmula padrão.
SomenteFormulasAtivas	Boolean	Retorna somente fórmulas ativas.

Parâmetros obrigatórios

Para realizar a consulta, deve ser informado pelo menos um dos filtros abaixo:

• CodigoProduto
• GrupoProduto

Os parâmetros:

• SomenteFormulaPadrao
• SomenteFormulasAtivas

são opcionais e podem ser utilizados para restringir o resultado da consulta.

Exemplo de requisição

GET /v1/produto_formulacao_get?Page=1&PageSize=50&CodigoProduto=B1&SomenteFormulaPadrao=true&SomenteFormulasAtivas=true

Estrutura do retorno

{
  "pageSize": 50,
  "currentPage": 1,
  "maxPageSize": 200,
  "totalPages": 1,
  "totalItens": 1,
  "data": [
    {
      "codigoProduto": "B1",
      "descricaoProduto": "suco Limao",
      "unidadeMedida": "UN",
      "formulas": [
        {
          "codigoFormula": 1,
          "descricaoFormula": "Mistura",
          "formulaPadrao": true,
          "formulaAtiva": true,
          "quantidadePadraoFormula": 1,
          "composicao": [
            {
              "codigoMateriaPrima": "B2",
              "descricaoMateriaPrima": "Limao",
              "unidadeMedidaMateriaPrima": "UN",
              "quantidadeMateriaPrima": 0.1,
              "baixaEstoque": true
            }
          ]
        }
      ]
    }
  ]
}

O retorno agrupa as fórmulas dentro da propriedade formulas. Cada fórmula possui sua própria composição.

Campos do produto

Campo	Descrição
codigoProduto	Código do produto.
descricaoProduto	Descrição do produto.
unidadeMedida	Unidade de medida.
formulas	Lista de fórmulas do produto.

Campos da fórmula

Campo	Descrição
codigoFormula	Código da fórmula.
descricaoFormula	Descrição da fórmula.
formulaPadrao	Indica se é a fórmula padrão.
formulaAtiva	Indica se a fórmula está ativa.
quantidadePadraoFormula	Quantidade padrão da fórmula.
composicao	Componentes da fórmula.

Campos da composição

Campo	Descrição
codigoMateriaPrima	Código do componente.
descricaoMateriaPrima	Descrição do componente.
unidadeMedidaMateriaPrima	Unidade de medida do componente.
quantidadeMateriaPrima	Quantidade utilizada.
baixaEstoque	Indica se realiza baixa de estoque.

A consulta apresenta somente a composição direta da fórmula. Subfórmulas não são expandidas recursivamente.