Árvore de páginas

Versões comparadas

Chave

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

...

PropriedadeTipoDescrição

branchs

stringCódigo da filial

company

stringCódigo da empresa
coduserstringCódigo do usuário

sessionId

stringId da sessão ativa

type_description

arrayArray com os tipos de produtos do insigth.  Será alimentado se o queryParam nPage = 1

group_description

arrayArray com os grupos de produtos do insigth.  Será alimentado se o queryParam nPage = 1

frequency

arrayArray com as frequência de produtos do insigth.  Será alimentado se o queryParam nPage = 1
tenantidstringTenant Id da Filial.
.alertsArrayArray com os dados do insight, por item
alerts.accuracynumberPercentual de acurácia do insight
alerts.branchstringCódigo da Filial
alerts.codestringCódigo do produto
alerts.company_groupstringCódigo Grupo de Empresa
desc_especstringDescrição Especifica
descriptionstringDescrição do produto.
alerts.forecast_valuenumberValor da predição
alerts.frequencystringD-Diário M-Mensal S-Semanal
alerts.graphPointsarrayArray com os pontos do gráfico.
alerts.graphPoints.codestringCódigo do produto
alerts.graphPoints.final_reference_datedatetimeData final do ponto de gráfico
alerts.graphPoints.frequencystringD-Diário M-Mensal S-Semanal
alerts.graphPoints.idstringId do ponto do gráfico
alerts.graphPoints.initial_reference_datestringData final do ponto de gráfico
alerts.graphPoints.lower_boundnumberLimite inferior da predição do ponto
alerts.graphPoints.pb_valuenumberValor de predição do ponto
alerts.graphPoints.predictionbooleanPredição ou histórico
alerts.graphPoints.tenantidstringTenantId do cliente
alerts.graphPoints.upper_boundnumberLimite superior da predição do ponto
alerts.group_codestringCódigo do grupo de produto
alerts.group_descriptionstringDescrição do grupo de produto
alerts.idstringId do alerta
alerts.inventory_periodicitystringD-Diário M-Mensal S-Semanal
alerts.last_revision_datedatetimeData de revisão de preço
alerts.max_stocknumberEstoque máximo do produto
alerts.mdmLastUpdateddatetimeData de geração da previsão
alerts.minimum_lotnumberEstoque minimo
alerts.originstringArmazém de origem
alerts.pb_calculatebooleanAcurácia calculada ou não
alerts.replenishmentnumberPonto de reposição
alerts.safety_stocknumberEstoque de segurança
alerts.stock_out_datedatetimeData prevista para ruptura de estoque
alerts.stock_quantitynumberQuantidade de estoque
alerts.storagestringArmazém do produto
alerts.storestringLoja
alerts.supplierstringCódigo do fornecedor
alerts.suppliernamestringDescrição do fornecedor

alerts.tenantId

stringTenantId do cliente

alerts.type

stringSigla da embalagem

alerts.type_description

stringDescrição da embalagem

alerts.unity

stringTipo de Unidade do produto

hasNext

booleanSe 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 de retorno da requisição:

GET http://<ip:port>/api/bo-ba/v1/insights/stock/rupturealert?cUserId=000001&cBranch=D%20MG%2001&cComGrp=T1&nPage=1&nPageSize=10

Bloco de código
languagejs
themeRDark
titleresponse.json
collapsetrue
{
	"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.

...