successbooleanOpcionalListar vínculos y contratos elegibles del embarcador
Parámetros, estructura de datos y respuestas del contrato versionado.
/embarcador/solicitacoes-transporte/opcoesLas descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.
Devuelve los vínculos activos con Gestores de Transporte (carrier_shippers), las negociaciones/contratos vigentes y formalmente aceptados (shipper_negotiations + ShipperContractAcceptance), las modalidades y los estados soportados en las 4 dimensiones.
Autenticación
- Permiso Requerido
operacao— Operación- Módulo
- Contratación Directa (Embarcador)
- Perfiles Aplicables
- Embarcador · Gestor de Transporte · Agregado Empresarial
- Mecanismos
- OAuth2 client_credentials (POST /oauth/token) o API Key vía Authorization: Bearer / X-Api-Key
[
{
"oauth2": []
},
{
"chaveApi": []
}
]Parámetros
No hay parámetros declarados para esta operación.
Respuestas
200 Respuesta HTTP
Opciones comerciales y operativas del embarcador
application/json
environmentstringOpcional"homologacao" · "producao"dataobjectOpcional401 Respuesta HTTP
Sin autenticación (autenticacao): credencial ausente, inválida o vencida, incluida una clave API utilizada en el entorno incorrecto. La clave de homologación no es válida en producción, ni la de producción en homologación; el mensaje de error indica el entorno esperado.
403 Respuesta HTTP
Ámbito no habilitado para esta credencial
Definición Completa de la Operación
{
"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": []
}