← HomeFleetPay / API

Query transport request

Parameters, data structure and responses from the versioned contract.

GET/embarcador/solicitacoes-transporte/{id}
consultarSolicitacaoTransporteEmbarcadorSandbox Base: https://api.fleetpay.site/v1

Technical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.

Returns full details of the transport request, including the 4 state dimensions, stops, volumes, tax documents, commercial snapshot and audit trail.

Authentication

Required Scope
operacao — Operations
Module
Direct Contracting (Shipper)
Target Profiles
Shipper · Transport Manager · Dedicated Fleet Contractor
Schemes
OAuth2 client_credentials (POST /oauth/token) or API Key via Authorization: Bearer / X-Api-Key
[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]
Availability depends on the environment, enabled scopes and provider. This reference does not execute requests or collect credentials.

Parameters

idpath · stringRequired

public_id (e.g. STR-...), external_order_ref or numeric ID of the shipper request.

Constraints
{
  "type": "string"
}

Responses

200 HTTP Response

Transport request details

application/json

successbooleanOptional
commercial_resolutionobject | nullOptional
401 HTTP Response

Unauthenticated (autenticacao): missing, invalid or expired credentials, including an API key used in the wrong environment. A sandbox key is not valid in production, nor a production key in the sandbox; the error message indicates the expected environment.

application/json

errorobjectOptional
403 HTTP Response

Scope not enabled for these credentials

application/json

errorobjectOptional
404 HTTP Response

Request not found or belongs to another shipper

application/json

errorobjectOptional
Complete Operation Definition
{
  "tags": [
    "Solicitações e Contratação de Transporte (Embarcador)"
  ],
  "summary": "Consultar solicitação de transporte",
  "description": "Retorna os detalhes completos da solicitação, incluindo as 4 dimensões de estado, paradas, volumes, documentos fiscais, snapshot comercial e trilha de auditoria.",
  "operationId": "consultarSolicitacaoTransporteEmbarcador",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "required": true,
      "description": "`public_id` (ex.: `STR-...`), `external_order_ref` ou ID numérico da solicitação do embarcador.",
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Detalhes da solicitação de transporte",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/SolicitacaoTransporteResponse"
          }
        }
      }
    },
    "401": {
      "$ref": "#/components/responses/Erro401"
    },
    "403": {
      "$ref": "#/components/responses/Erro403"
    },
    "404": {
      "description": "Solicitação não encontrada ou pertencente a outro embarcador",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Erro"
          }
        }
      }
    }
  },
  "x-fleetpay-scope": "operacao",
  "x-fleetpay-module": "contratacao-direta",
  "x-fleetpay-profiles": [
    "embarcador",
    "gestor",
    "agregado_empresarial"
  ],
  "method": "GET",
  "path": "/embarcador/solicitacoes-transporte/{id}"
}