Histórico da Página
CONTEÚDO
- Visão Geral
- GET Rota
Descrição do Método:
Parâmetros
Códigos de Resposta
Tratamento de Erros
Segurança
Exemplos
Recomendações de Uso
Referências e Links Relacionados
- POST Rota
- Parametros
- Retorno
- Exemplo de utilizacao
- PUT Rota
- Parametros
- Retorno
- Exemplo de utilizacao
- DELETE Rota
- Parametros
- Retorno
- Exemplo de utilizacao
01. VISÃO GERAL
...
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 de do usuário.
Parâmetros
Os parâmetros são mandatórios, e devem ser passados via queryParams.
Parâmetro | Tipo | Descrição |
---|---|---|
cUserId | String | Id do usuário Protheus (cUserId) |
cComGrp | String | Código da empresa logada (cEmpAnt) |
cBranch | String | Código da fililal logada (cFilAnt) |
Códigos de Resposta
O serviço deve retornar as propriedades informadas, de acordo com os parâmetros passados na consulta.Com , e com o código HTTP http 200.
Propriedade | Tipo | Descrição | Adicional |
---|---|---|---|
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 | Object | Objeto container dos alerts | |
items.tenantid | string | Tenant Id da Filial. | |
items.alerts | Array | Array com os dados do insight, por item | |
items.alerts.accuracy | number | Percentual de acurácia do insight | |
items.alerts.branch | string | Código da Filial | |
items.alerts.code | string | Código do produto | |
items.alerts.company_group | string | ||
items.alerts.desc_espec | string | ||
items.alerts.description | string | Descrição do produto. | |
items.alerts.forecast_value | number | ||
items.alerts.frequency | string | D-Diário M-Mensal S-Semanal | |
items.alerts.graphPoints | array | Array com os pontos do gráfico. | |
items.alerts.graphPoints.code | string | Código do produto | |
items.alerts.graphPoints.final_reference_date | datetime | ||
items.alerts.graphPoints.frequency | string | D-Diário M-Mensal S-Semanal | |
items.alerts.graphPoints.id | string | Id do ponto do gráfico | |
items.alerts.graphPoints.initial_reference_date | string | ||
items.alerts.graphPoints.lower_bound | number | ||
items.alerts.graphPoints.pb_value | number | ||
items.alerts.graphPoints.prediction | boolean | ||
items.alerts.graphPoints.tenantid | string | ||
items.alerts.graphPoints.upper_bound | number | ||
items.alerts.group_code | string | ||
items.alerts.group_description | string | ||
items.alerts.id | string | Id do alerta | |
items.alerts.inventory_periodicity | string | D-Diário M-Mensal S-Semanal | |
items.alerts.last_revision_date | datetime | ||
items.alerts.max_stock | number | Estoque máximo do produto | |
items.alerts.mdmLastUpdated | datetime | ||
items.alerts.minimum_lot | number | ||
items.alerts.origin | string | ||
items.alerts.pb_calculate | boolean | ||
items.alerts.replenishment | number | ||
items.alerts.safety_stock | number | ||
items.alerts.stock_out_date | datetime | ||
items.alerts.stock_quantity | number | Quantidade de estoque | |
items.alerts.storage | string | Armazém do produto | |
items.alerts.store | string | ||
items.alerts.supplier | string | Código do fornecedor | |
items.alerts.suppliername | string | Descrição do fornecedor | |
items.alerts.tenantId | string | ||
items.alerts.type | string | Sigla da embalagem | |
items.alerts.type_description | string | Descrição da embalagem | |
items.alerts.unity | string | Tipo de Unidade do produto |
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
Exemplos
Exemplo de retorno da requisição:
...
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "branchs": "D MG 01", "coduser": "000000", "company": "T1", "items": { "alerts": [ { "accuracy": 87.69, "branch": "D MG 01", "code": "000102", "company_group": "T1", "desc_espec": "", "description": "EMBALAGEM - ARROZ PARBOILIZADO SABOR SUL 6X5KG TP1 LF", "forecast_value": 518, "frequency": "D", "graphPoints": [ { "code": "000102", "final_reference_date": "2023-12-10T03:00:00-03:00", "frequency": "D", "id": "2b86ef8a63f702aaa59dc397817908b6", "initial_reference_date": "2023-12-10T03:00:00-03:00", "lower_bound": 6176.721, "pb_value": 6407.721, "prediction": true, "tenantid": "20938a01-1e6d-4041-80c5-f4d980603e37", "upper_bound": 6637.721 } ], "group_code": "0191", "group_description": "EMBALAGEM", "id": "2b86ef8a63f702aaa59dc397817908b6", "inventory_periodicity": "0", "last_revision_date": "2022-02-04T00:00:00-03:00", "max_stock": 0, "mdmLastUpdated": "2023-12-05T16:53:26-03:00", "minimum_lot": 0, "origin": "0", "pb_calculate": true, "replenishment": 11322, "safety_stock": 5627, "stock_out_date": "2023-12-02T03:00:00-03:00", "stock_quantity": 7475, "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
...
Caso n
POST /rota/assets/request/
Envia requisição para tranferência / baixa e ampliação do ativo.
Parâmetros aceitos
Não são aceitos parâmetros de URL para esta requisição.
Payload
O payload que será enviado na requisição conterá as seguintes propriedades:
...
0: Baixa
1: Transferência
2: Ampliação
...
0: Pendente
1: Finalizada
2: Cancelada
...
Se operation=0 -> Motivo
Se operation=1 -> Detalhes
Se operation=2 -> Observação
...
0: Física
1: Contábil
Exemplo de retorno da requisição:
- item: Código do item (mostrar sempre junto)
- status: Status da solicitação (0-Pendente, 1-Finalizada, 2-cancelada)
- date: Data da solicitação, formato data Protheus YYYYMMDD
- reason: Motivo
Se operation=0 -> Motivo
Se operation=1 -> Detalhes
Se operation=2 -> Observação
- value: (só não existe se operation=1)
- quantity: (só existe se operation=0)
- balances: Tipos de saldo disponíveis no bem (ver GET /assets) (só existe se operation=0)
- type: Tipo de transferência (0-física, 1-contábil) (só existe se for operation=1)
Post /wsatf001/assets/request
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{
"operation": 1,
"asset": "000001",
"item": "0001",
"type": "0",
"status" : 0,
"reason" : "teste",
"value" : 100,
"quantity" : 1,
"balance": {
"type": "10",
"balance_type": "3"}
}
|
PUT /rota/assets/{asset}/{item}
Grava a localização de um ativo identificado pelos parâmetros asset e item na url. Este serviço pode ser usado de duas formas: enviando lat e lng para atualizar a geolocalização, ou enviando o local para atualizar o N1_LOCAL.
Parâmetros aceitos
Não são aceitos parâmetros de URL para esta requisição.
Payload
O payload que será enviado na requisição conterá as seguintes propriedades:
...
Exemplo de retorno da requisição:
- location: Array com a localização.
- lat: Latitude da localização do ativo.
- lng: Longitude da localização do ativo
- local: Código do local cadastrado no Protheus.
Put /wsatf001/assets/{assets}/{item}
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Exemplo 1: Atualizando a geolocalização
{
"type": "latlng",
"location": {
"lat": -93.5084952,
"lng": -96.6536569
}
}
Exemplo 2: Atualizando o N1_LOCAL:
{
"type": "local",
"location": {
"local": "000001"
}
} |
DELETE /rota/assets/{asset}/{item}/image
Método HTTP:
DELETE
- Este é o método HTTP usado para solicitar a exclusão de um recurso.
Rota:
/users/{id}
- Aqui,
/users/{id}
é a rota específica da API para excluir um usuário pelo seu ID. O{id}
é um espaço reservado que será substituído pelo ID real do usuário que queremos excluir.
- Aqui,
Neste exemplo:
- Estamos enviando uma solicitação DELETE para a rota
/users/123
. - Isso indicaria à API que queremos excluir o usuário com o ID 123.
Portanto, ao enviar essa solicitação DELETE para a API, o usuário com o ID 123 seria excluído do sistema, se ele existir.
Parâmetros aceitos
Não são aceitos parâmetros de URL para esta requisição.
Payload
O payload que será enviado na requisição conterá as seguintes propriedades:
...
Exemplo de retorno da requisição:
- location: Array com a localização.
Put /wsatf001/assets/{assets}/{item}
...
language | js |
---|---|
theme | RDark |
title | response.json |
collapse | true |
...
Uso
Esta API funciona corretamente após as devidas configurações da funcionalidade Protheus Insights.