Histórico da Página
Índice printable false
| printable | false |
|---|
...
GET /api/bo-ba/v1/insights/stock/rupturealert
Descrição do Método
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âmetros
Os parâmetros são mandatórios, e devem ser passados via queryParams.
| 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 | number | 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 |
items
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 |
Tratamento de Erros
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:
| Bloco de código | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"PermissionInsight": "false",
"InsightIA": "false",
"branchs": "D MG 01",
"company": "T1",
"coduser": "000000",
"company "sessionId": "T149746338f28c10042FCFB7C04F344632",
"type_description": [],
"group_description": "items[],
"frequency": [],
"tenantid": {
null,
"alerts": [
{
{
"accuracy": 8785.69,
03,
"branch": "D MG 01",
"code": "000102004213",
"company_group": "T1",
"desc_espec": "",
"description": "EMBALAGEM - ARROZREEMBALAGEM PARBOILIZADOENFARDADEIRA SABOR SUL 6X5KG TP1 LF",
FEIJAO 82X0,05",
"forecast_value": 518,
38,
"frequency": "D",
"graphPoints": [
{
{
"code": "000102004213",
"final_reference_date": "2023-12-10T03:00:00-03:00",
"frequency": "D",
"id": "2b86ef8a63f702aaa59dc397817908b6724ac5ec9ece4a68b69e29dbea716279",
"initial_reference_date": "2023-12-10T03:00:00-03:00",
"lower_bound": 61761903.721,
835,
"pb_value": 64071940.721,
835,
"prediction": true,
"tenantid": "20938a01-1e6d-4041-80c5-f4d980603e37",
"upper_bound": 66371978.721
}
],
835
}
],
"group_code": "0191",
"group_description": "EMBALAGEM",
"id": "2b86ef8a63f702aaa59dc397817908b6724ac5ec9ece4a68b69e29dbea716279",
"inventory_periodicity": "0",
"last_revision_date": "20222021-0208-04T0005T00:00:00-03:00",
"max_stock": 0,
"mdmLastUpdated": "2023-12-05T16:53:26-03:00",
"minimum_lot": 0,
500,
"origin": "0",
"pb_calculate": true,
"replenishment": 11322,
3448,
"safety_stock": 5627,
1860,
"stock_out_date": "2023-12-02T03:00:00-03:00",
"stock_quantity": 7475,
2166,
"storage": "01",
"store": " ",
"supplier": " ",
"suppliername": "",
"tenantId": "a066b32a-9565-463b-863d-1cb65562546e",
"type": "EM",
"type_description": "EMBALAGEM",
"unity": "KG"
}
],
"tenantId": null
},
"sessionId": "a16d8a68f2701004480BB7C04F344632"
}
]
} |
Recomendações de Uso
Esta API funciona corretamente após as devidas configurações da funcionalidade Protheus Insights.
...
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas