operation_typequery · stringOptionalOperation type (e.g. urban_delivery, closed_load, full_load).
Constraints
{
"type": "string"
}Parameters, data structure and responses from the versioned contract.
/embarcador/solicitacoes-transporte/modelos-planilhaTechnical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.
Provides the tabular template accepted for batch import of transport requests.
operacao — Operations[
{
"oauth2": []
},
{
"chaveApi": []
}
]operation_typequery · stringOptionalOperation type (e.g. urban_delivery, closed_load, full_load).
{
"type": "string"
}200 HTTP ResponseOperation processed successfully.
application/jsondata—Optionalmetaobject | nullOptionaladditionalPropertiestrueambientestringOptional"homologacao" · "producao"401 HTTP ResponseMissing, invalid or cross-environment credential.
403 HTTP ResponseDashboard scope not enabled or resource outside company scope.
{
"tags": [
"Solicitações e Contratação de Transporte (Embarcador)"
],
"operationId": "baixarModeloPlanilhaSolicitacoes",
"summary": "Baixar modelo de planilha para importação de solicitações",
"description": "Disponibiliza o template tabular aceito na importação em lote de solicitações de transporte.",
"parameters": [
{
"name": "operation_type",
"in": "query",
"required": false,
"description": "Tipo de operação (ex: urban_delivery, closed_load, full_load).",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Operação processada com sucesso.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
}
]
},
"meta": {
"type": [
"object",
"null"
],
"additionalProperties": true
},
"ambiente": {
"type": "string",
"enum": [
"homologacao",
"producao"
]
}
}
}
}
}
},
"401": {
"description": "Credencial ausente, inválida ou de outro ambiente."
},
"403": {
"description": "Escopo do painel não habilitado ou recurso fora do escopo da company."
}
},
"x-fleetpay-scope": "operacao",
"x-fleetpay-module": "contratacao-direta",
"x-fleetpay-profiles": [
"embarcador",
"gestor",
"agregado_empresarial"
],
"method": "GET",
"path": "/embarcador/solicitacoes-transporte/modelos-planilha"
}