← InícioFleetPay / API

Listar vínculos e contratos elegíveis do embarcador

Parâmetros, estrutura de dados e respostas do contrato versionado.

GET/embarcador/solicitacoes-transporte/opcoes
listarOpcoesSolicitacoesTransporteEmbarcadorBase de Homologação: https://api.fleetpay.site/v1

Descrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.

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.

Autenticação

Escopo Necessário
operacao — Operação
Módulo
Contratação Direta (Embarcador)
Perfis Aplicáveis
Embarcador · Gestor de Transporte · Agregado Empresarial
Mecanismos
OAuth2 client_credentials (POST /oauth/token) ou API Key em Authorization: Bearer / X-Api-Key
[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]
A disponibilidade depende do ambiente, dos escopos habilitados e do provedor. Esta referência não executa chamadas nem recebe credenciais.

Parâmetros

Nenhum parâmetro declarado nesta operação.

Respostas

200 Resposta HTTP

Opções comerciais e operacionais do embarcador

application/json

successbooleanOpcional
environmentstringOpcional
"homologacao" · "producao"
dataobjectOpcional
401 Resposta HTTP

Não autenticado (autenticacao): credencial ausente, inválida ou expirada — inclusive chave de API usada no ambiente errado. A chave de homologação não vale em produção, nem a de produção em homologação; a mensagem do erro indica o ambiente esperado.

application/json

errorobjectOpcional
403 Resposta HTTP

Escopo não habilitado para esta credencial

application/json

errorobjectOpcional
Definição Completa da Operação
{
  "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": []
}