Histórico da Página
Índice printable false
GET /api/bo-ba/v1/insights/stock/rupturealert
printable | false |
---|
Retorna os dados do insight RuptureAlerts, filtrados pela Empresa/Filial que o usuário tem acesso. As filiais que o usuário tem acecsso são determinadas pelos grupos do usuário, e se o mesmo não pertencer a nenhum grupo, serão as que foram associadas no cadastro do usuário. Além disso, existem mais quatro campos opcionais de filtro, que se enviados no queryParam serão aplicados cumulativamente.
...
Parâmetro | Tipo | Descrição | Obrigatorio |
---|---|---|---|
cUserId | string | Id do usuário Protheus (cUserId) | x |
cComGrp | string | Código da empresa logada (cEmpAnt) | x |
cBranch | string | Código da fililal logada (cFilAnt) | x |
nPage | numberPáginainicial | Página inicial | x |
nPageSize | number | Registros por página | x |
cPesqTxt | string | Texto para pesquisar por código ou descrição | |
cTranId | string | Id da transação do Insight usado | |
type_description | string | Filtro do campo items.alerts.type_description | |
group_description | string | Filtro do campo items.alerts.group_description | |
frequency | string | Filtro do campo items.alerts.frequency |
Retorno
O serviço deve retornar as propriedades informadas, de acordo com os parâmetros passados na consulta, e com o código http 200.
Propriedade | Tipo | Descrição |
---|---|---|
branchs | string | Código da filial |
company | string | Código da empresa |
coduser | string | Código do usuário |
sessionId | string | Id da sessão ativa |
type_description | array | Array com os tipos de produtos do insigth. Será alimentado se o queryParam nPage = 1 |
group_description | array | Array com os grupos de produtos do insigth. Será alimentado se o queryParam nPage = 1 |
frequency | array | Array com as frequência de produtos do insigth. Será alimentado se o queryParam nPage = 1 |
tenantid | string | Tenant Id da Filial. |
.alerts | Array | Array com os dados do insight, por item |
alerts.accuracy | number | Percentual de acurácia do insight |
alerts.branch | string | Código da Filial |
alerts.code | string | Código do produto |
alerts.company_group | string | Código Grupo de Empresa |
desc_espec | string | Descrição Especifica |
description | string | Descrição do produto. |
alerts.forecast_value | number | Valor da predição |
alerts.frequency | string | D-Diário M-Mensal S-Semanal |
alerts.graphPoints | array | Array com os pontos do gráfico. |
alerts.graphPoints.code | string | Código do produto |
alerts.graphPoints.final_reference_date | datetime | Data final do ponto de gráfico |
alerts.graphPoints.frequency | string | D-Diário M-Mensal S-Semanal |
alerts.graphPoints.id | string | Id do ponto do gráfico |
alerts.graphPoints.initial_reference_date | string | Data final do ponto de gráfico |
alerts.graphPoints.lower_bound | number | Limite inferior da predição do ponto |
alerts.graphPoints.pb_value | number | Valor de predição do ponto |
alerts.graphPoints.prediction | boolean | Predição ou histórico |
alerts.graphPoints.tenantid | string | TenantId do cliente |
alerts.graphPoints.upper_bound | number | Limite superior da predição do ponto |
alerts.group_code | string | Código do grupo de produto |
alerts.group_description | string | Descrição do grupo de produto |
alerts.id | string | Id do alerta |
alerts.inventory_periodicity | string | D-Diário M-Mensal S-Semanal |
alerts.last_revision_date | datetime | Data de revisão de preço |
alerts.max_stock | number | Estoque máximo do produto |
alerts.mdmLastUpdated | datetime | Data de geração da previsão |
alerts.minimum_lot | number | Estoque minimo |
alerts.origin | string | Armazém de origem |
alerts.pb_calculate | boolean | Acurácia calculada ou não |
alerts.replenishment | number | Ponto de reposição |
alerts.safety_stock | number | Estoque de segurança |
alerts.stock_out_date | datetime | Data prevista para ruptura de estoque |
alerts.stock_quantity | number | Quantidade de estoque |
alerts.storage | string | Armazém do produto |
alerts.store | string | Loja |
alerts.supplier | string | Código do fornecedor |
alerts.suppliername | string | Descrição do fornecedor |
alerts.tenantId | string | TenantId do cliente |
alerts.type | string | Sigla da embalagem |
alerts.type_description | string | Descrição da embalagem |
alerts.unity | string | Tipo de Unidade do produto |
hasNext | boolean | Se foi enviado o último registro, retorna false, senão, true |
...
A API efetua a verificação do envio dos queryParams, caso não seja enviado algum é retornado um a mensagem de erro com o código HTTP 412
Exemplo da mensagem de retorno
Exemplo de retorno da requisição:
...