← HomeFleetPay / API

List shipper's eligible links and contracts

Parameters, data structure and responses from the versioned contract.

GET/embarcador/solicitacoes-transporte/opcoes
listarOpcoesSolicitacoesTransporteEmbarcadorSandbox 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 active links with Transport Managers (carrier_shippers), active and formally accepted negotiations/contracts (shipper_negotiations + ShipperContractAcceptance), modes and supported states across the 4 dimensions.

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

No parameters declared for this operation.

Responses

200 HTTP Response

Shipper commercial and operational options

application/json

successbooleanOptional
environmentstringOptional
"homologacao" · "producao"
dataobjectOptional
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
Complete Operation Definition
{
  "tags": [
    "Solicitações e Contratação de Transporte (Embarcador)"
  ],
  "summary": "Listar vínculos e contratos elegíveis do embarcador",
  "description": "Retorna os vínculos ativos com Gestores de Transporte (`carrier_shippers`), as negociações/contratos vigentes e formalmente aceitos (`shipper_negotiations` + `ShipperContractAcceptance`), as modalidades e os estados suportados nas 4 dimensões.\n",
  "operationId": "listarOpcoesSolicitacoesTransporteEmbarcador",
  "responses": {
    "200": {
      "description": "Opções comerciais e operacionais do embarcador",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "environment": {
                "type": "string",
                "enum": [
                  "homologacao",
                  "producao"
                ]
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "401": {
      "$ref": "#/components/responses/Erro401"
    },
    "403": {
      "$ref": "#/components/responses/Erro403"
    }
  },
  "x-fleetpay-scope": "operacao",
  "x-fleetpay-module": "contratacao-direta",
  "x-fleetpay-profiles": [
    "embarcador",
    "gestor",
    "agregado_empresarial"
  ],
  "method": "GET",
  "path": "/embarcador/solicitacoes-transporte/opcoes",
  "parameters": []
}