GET /api/broker/ordemAbastecimento/{localizador}
Endpoint responsável por Localizar uma Ordem de Abastecimento, retornando dados que serão utilizados nas próximas etapas do processo.
Importante: Caso a Ordem de Abastecimento retorne como Validada, a etapa de Validação da Ordem de Abastecimento não deve ser apresentada, avançando direto para a etapa de Autorização da Ordem de Abastecimento.
Headers
Content-Type | application/json |
Authorization | Bearer {token} |
Request Query String application/json
Schema:
Campo | Tipo | Descrição | Obrigatório |
localizador | String | Código de Identificação da Ordem de Abastecimento, disponibilizado pelo Motorista. | Sim |
Response Body application/json
Schema:
Campo | Tipo | Descrição |
Validada | Boolean | Indica se a Ordem de Abastecimento já se encontra Validada. Em caso positivo, a etapa de Validação da Ordem de Abastecimento não deve ser apresentada, avançando direto para a etapa de Autorização da Ordem de Abastecimento. |
Combustiveis | Array of Objects <Combustivel> | Valores de Combustíveis existentes no Estabelecimento para serem apresentados em uma Combo de Seleção no momento da Validação. |
Campos | Array of Objects <Campo> | Valores de Campos solicitados pelo Transportador. |
Detalhes | Object <Detalhes> | Dados da Ordem de Abastecimento a serem apresentados para o Usuário na Tela de Detalhes da Ordem de Abastecimento. |
<Combustivel>:
Campo | Tipo | Descrição |
Identificador | String | Identificador do Combustível, que deverá ser enviado no momento da Validação. |
Descricao | String | Descrição do Combustível, que deverá ser apresentado na Combo de Seleção. |
<Campo>:
Campo | Tipo | Descrição |
Chave | String | Chave do Campo, que será enviada no momento da Validação. |
Descricao | String | Descrição do Campo para ser utilizado como Legenda/Label. |
Tipo | String | Tipo do Campo que será apresentado. Tipos esperados:
|
IdentificadorTipo | Integer | Identificador do Tipo do Campo. |
Obrigatorio | Boolean | Booleana que identifica se o Campo é obrigatório. |
<Detalhes>:
Campo | Tipo | Descrição |
Solicitante | String | Nome do Frotista/Empresa que cadastrou a Ordem de Abastecimento. |
Combustivel | String | Descrição do Combustível liberado para essa Ordem de Abastecimento, quando houver. |
ValorLitro | Decimal | Valor por Litro do Combustível em questão, cadastrado previamente pelo Posto de Combustível. |
DescontoNegociado | Decimal | Valor de Desconto Negociado previamente pelo Posto de Combustível e o Transportador/Frotista. |
ValorLitroNegociado | Decimal | Valor por Litro Negociado. No caso de não existir uma negociação prévia, constará o Valor por Litro cadastrado pelo Posto de Combustível. |
QtdLitrosLiberados | Decimal | Quantidade de Litros liberados para abastecimento. (Disponibilizado apenas para Ordens de Abastecimento que não sejam Tanque Cheio) |
TanqueCheio | Boolean | Indica se a Ordem de Abastecimento é para Tanque Cheio. Nesse caso, o Valor Total da Ordem será a Quantidade de Litros Abastecidos multiplicado pelo Valor Litro Negociado (Disponibilizado nesse objeto) |
JSON:
{
"validada": false
"combustiveis": [
{
"identificador": "GSLCM",
"descricao": "Gasolina Comum"
},
{
"identificador": "GSLAT",
"descricao": "Gasolina Aditivada"
},
{
"identificador": "DSS10",
"descricao": "Diesel S-10"
}
],
"campos": [
{
"chave": "23",
"descricao": "Hodômetro",
"tipo": "integer",
"identificadorTipo": 2,
"obrigatorio": true
},
{
"chave": "24",
"descricao": "Placa",
"tipo": "string",
"identificadorTipo": 1,
"obrigatorio": true
}
],
"detalhes": {
"solicitante": "IS Transportes",
"produto": "Diesel",
"valorLitro": 3.800,
"descontoNegociado": 0.300,
"valorLitroNegociado": 3.500,
"qtdLitrosLiberados": 0.000,
"tanqueCheio": true
}
}