logistica.getentregasanalise
Este endpoint devolve análises das entregas dentro do período de emissão dos serviços
Dados da requisição
| API | Método |
|---|---|
| api.rule - API principal | GET |
JSON da requisição
{
"taggetentregasanalise": [
{
"idconsumer": "yyyy",
"dtpiso": "2020-01-01T00:00:00-03:00",
"dtteto": "2020-01-01T23:59:59-03:00",
"modeloanalise": "xxxxxxxxxxxxxx"
"modelodoc":"xxx"
}
]
}
Especificação das tags
| Tag | N | Obrigatório | Descrição |
|---|---|---|---|
| idconsumer | 1 | N | ID interno para controle do ator |
| modeloanalise | 1 | S | Define o modelo de análise a ser aplicado [Modelos disponíveis](#Resposta de Sucesso de acordo com modeloanalise) |
| dtpiso | 1 | S | Data piso para filtro dos serviços emitidos (data de emissão) |
| dtteto | 1 | S | Data teto para filtro dos serviços emitidos (data de emissão) |
| modelodoc | 1 | S | Modelo de documento a ser filtrado 57 - CTe |
✅ Resposta de Sucesso de acordo com modeloanalise
Especificações do retorno de acordo com o modeloanalise escolhido na chamada
"modeloanalise":"eficiencia01"
Este modelo analisa o SLA BASE das entregas dentro do período requisitado, devolvendo quantidades por:
- Status da Entrega
{
"taggetentregasanalise": [
{
"erromensagemitem": "",
"idconsumer": "yyyy",
"itens": [
{
"statusentregas": "xxx",
"qtdeoperacoes":0
}
]
}
]
}
Especificação das tags de retorno
| Tag | N | Obrigatório | Descrição |
|---|---|---|---|
| erromensagemitem | 1 | Se possuir conteúdo, a chamada do endpoint não foi bem sucedida, se possuir conteúdo, traz o erro ocorrido | |
| idconsumer | 1 | N | ID interno para controle do ator |
| itens | 1 | S | Dados da análise conforme o status da entrega |
| statusentregas | 2 | S | Status das entregas Operações que estão concluídas (Foram encerradas) "OTD" - On Time Delivery - Operações concluídas dentro do prazo "LTD" - Late Delivery - Operações concluídas fora do prazo Operações que não estão concluídas (Ainda estão em curso) "OTW" - On Time Waiting - Operações não concluídas dentro do prazo "LTW" - Late Waiting - Operações não concluídas e já estão fora do prazo |
| qtdeoperacoes | 2 | S | Quantidade de operações dentro do status |
"modeloanalise":"eficiencia02"
Este modelo analisa o SLA BASE das entregas dentro do período requisitado, devolvendo quantidades por:
- Status da Entrega
- Município origem
- Município destino
{
"taggetentregasanalise": [
{
"idconsumer": "yyyy",
"erromensagemitem": "",
"itens": [
{
"statusentregas": "LTW",
"qtdeoperacoes": 1,
"origem": {
"uf": "SP",
"municipio": "BOITUVA",
"ibge": 3507001
},
"destino": {
"municipio": "SANTO ANDRE",
"uf": "SP",
"ibge": 3547809
}
}
]
}
]
}
Especificação das tags de retorno
| Tag | N | Obrigatório | Descrição |
|---|---|---|---|
| erromensagemitem | 1 | Se possuir conteúdo, a chamada do endpoint não foi bem sucedida, se possuir conteúdo, traz o erro ocorrido | |
| idconsumer | 1 | N | ID interno para controle do ator |
| itens | 1 | S | Dados da análise conforme o status da entrega |
| statusentregas | 2 | S | Status das entregas Operações que estão concluídas (Foram encerradas) "OTD" - On Time Delivery - Operações concluídas dentro do prazo "LTD" - Late Delivery - Operações concluídas fora do prazo Operações que não estão concluídas (Ainda estão em curso) "OTW" - On Time Waiting - Operações não concluídas dentro do prazo "LTW" - Late Waiting - Operações não concluídas e já estão fora do prazo |
| qtdeoperacoes | 2 | S | Quantidade de operações dentro do status |
| origem | 2 | S | Dados do ponto de origem da mercadoria |
| uf | 3 | S | UF Origem |
| municipio | 3 | S | Município Origem |
| ibge | 3 | S | Código IBGE do município origem |
| destino | 2 | S | Dados do ponto de destino da mercadoria |
| uf | 3 | S | UF Origem |
| municipio | 3 | S | Município Origem |
| ibge | 3 | S | Código IBGE do município origem |
❌ Possíveis Erros
- `400 Bad Request`
- JSON de parâmetros inválido
- `401 Unauthorized` → Credenciais inválidas.
- Header authorization não inciado com "token"
- Token inválido
- `405 Method Not Allowed`
- Tentativa de acesso ao endpoint com método diferente de GET.