pagequery · integerOpcionalRestrições
{
"type": "integer",
"minimum": 1,
"default": 1
}Parâmetros, estrutura de dados e respostas do contrato versionado.
/embarcador/solicitacoes-transporteDescrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.
Retorna a lista paginada de solicitações de transporte pertencentes ao shipper_company_id autenticado, com filtros por status de recepção (intake_status), comercial (commercial_status), atendimento (attendance_status), fiscal (fiscal_status), modalidade (contract_mode), tipo de operação (operation_type), busca textual (search) e lote (batch_id).
operacao — Operação[
{
"oauth2": []
},
{
"chaveApi": []
}
]pagequery · integerOpcional{
"type": "integer",
"minimum": 1,
"default": 1
}per_pagequery · integerOpcional{
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 25
}intake_statusquery · stringOpcional{
"type": "string",
"enum": [
"draft",
"received",
"pending_data",
"validated",
"cancelled"
]
}commercial_statusquery · stringOpcional{
"type": "string",
"enum": [
"pending_resolution",
"contract_identified",
"ambiguous_contract",
"ambiguity_blocked",
"out_of_scope_spot_required",
"spot_requested",
"spot_proposal_ready",
"spot_accepted",
"pending_acceptance",
"contracted",
"revision_requested",
"cancelled"
]
}attendance_statusquery · stringOpcional{
"type": "string",
"enum": [
"not_requested",
"awaiting_confirmation",
"manager_committed",
"awaiting_driver_acceptance",
"partially_confirmed",
"confirmed",
"declined",
"in_transit",
"completed",
"cancelled"
]
}fiscal_statusquery · stringOpcional{
"type": "string",
"enum": [
"awaiting_nfe",
"not_required_yet",
"nfe_received_pending_confirmation",
"pending_nfe",
"nfe_validated",
"nfe_linked",
"ready_for_cte_prefill",
"ready_for_cte",
"cte_prefilled",
"cte_issuing",
"cte_authorized",
"cte_rejected",
"cte_timeout",
"cancelled"
]
}contract_modequery · stringOpcional{
"type": "string",
"enum": [
"period_contract",
"spot"
]
}operation_typequery · stringOpcional{
"type": "string",
"enum": [
"urban_delivery",
"closed_load",
"full_load"
]
}searchquery · stringOpcional{
"type": "string"
}batch_idquery · stringOpcional{
"type": "string"
}200 Resposta HTTPLista paginada de solicitações de transporte
application/json401 Resposta HTTPNã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.
403 Resposta HTTPEscopo não habilitado para esta credencial
429 Resposta HTTPLimite de requisições excedido (limite_requisicoes). Aguarde o intervalo indicado no header Retry-After antes de repetir. Pode vir do provedor, repassado, ou do teto anti-abuso da própria FleetPay — contado por empresa autenticada e por grupo de rotas, com uma janela curta que pega a rajada e uma longa que pega o robô lento. Os tetos são folgados de propósito: integração real, inclusive lote grande processado de uma vez, não chega perto deles. Se a sua chegar, fale com a FleetPay.
{
"tags": [
"Solicitações e Contratação de Transporte (Embarcador)"
],
"summary": "Listar solicitações de transporte do embarcador",
"description": "Retorna a lista paginada de solicitações de transporte pertencentes ao `shipper_company_id` autenticado, com filtros por status de recepção (`intake_status`), comercial (`commercial_status`), atendimento (`attendance_status`), fiscal (`fiscal_status`), modalidade (`contract_mode`), tipo de operação (`operation_type`), busca textual (`search`) e lote (`batch_id`).\n",
"operationId": "listarSolicitacoesTransporteEmbarcador",
"parameters": [
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/PerPage"
},
{
"name": "intake_status",
"in": "query",
"schema": {
"type": "string",
"enum": [
"draft",
"received",
"pending_data",
"validated",
"cancelled"
]
}
},
{
"name": "commercial_status",
"in": "query",
"schema": {
"type": "string",
"enum": [
"pending_resolution",
"contract_identified",
"ambiguous_contract",
"ambiguity_blocked",
"out_of_scope_spot_required",
"spot_requested",
"spot_proposal_ready",
"spot_accepted",
"pending_acceptance",
"contracted",
"revision_requested",
"cancelled"
]
}
},
{
"name": "attendance_status",
"in": "query",
"schema": {
"type": "string",
"enum": [
"not_requested",
"awaiting_confirmation",
"manager_committed",
"awaiting_driver_acceptance",
"partially_confirmed",
"confirmed",
"declined",
"in_transit",
"completed",
"cancelled"
]
}
},
{
"name": "fiscal_status",
"in": "query",
"schema": {
"type": "string",
"enum": [
"awaiting_nfe",
"not_required_yet",
"nfe_received_pending_confirmation",
"pending_nfe",
"nfe_validated",
"nfe_linked",
"ready_for_cte_prefill",
"ready_for_cte",
"cte_prefilled",
"cte_issuing",
"cte_authorized",
"cte_rejected",
"cte_timeout",
"cancelled"
]
}
},
{
"name": "contract_mode",
"in": "query",
"schema": {
"type": "string",
"enum": [
"period_contract",
"spot"
]
}
},
{
"name": "operation_type",
"in": "query",
"schema": {
"type": "string",
"enum": [
"urban_delivery",
"closed_load",
"full_load"
]
}
},
{
"name": "search",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "batch_id",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Lista paginada de solicitações de transporte",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListaSolicitacoesTransporteResponse"
}
}
}
},
"401": {
"$ref": "#/components/responses/Erro401"
},
"403": {
"$ref": "#/components/responses/Erro403"
},
"429": {
"$ref": "#/components/responses/Erro429"
}
},
"x-fleetpay-scope": "operacao",
"x-fleetpay-module": "contratacao-direta",
"x-fleetpay-profiles": [
"embarcador",
"gestor",
"agregado_empresarial"
],
"method": "GET",
"path": "/embarcador/solicitacoes-transporte"
}