idpath · stringRequiredConstraints
{
"type": "string"
}Parameters, data structure and responses from the versioned contract.
/embarcador/solicitacoes-transporte/{id}/documentosTechnical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.
Attaches NF-e XML files, PDF/DANFE or ZIP archives (via multipart/form-data in arquivos[]) or access keys to the request.
uncertainty_flags + requires_confirmation=true (fiscal_status: nfe_pending_confirmation) whenever weight, value or address cannot be extracted with certainty.operacao — Operations[
{
"oauth2": []
},
{
"chaveApi": []
}
]idpath · stringRequired{
"type": "string"
}Required
multipart/form-dataarquivosarrayOptionalapplication/jsondocumentosarrayOptional200 HTTP ResponseDocuments attached and fiscal status updated
application/jsonsuccessbooleanOptionaldataobjectOptionalcommercial_resolutionobject | nullOptional{
"tags": [
"Solicitações e Contratação de Transporte (Embarcador)"
],
"summary": "Anexar documentos fiscais (NF-e XML/PDF/ZIP ou CT-e) à solicitação",
"description": "Anexa arquivos XML de NF-e, PDF/DANFE ou ZIP (via `multipart/form-data` em `arquivos[]`) ou chaves de acesso à solicitação.\n- Em **XML de NF-e**, extrai chave de 44 dígitos, número/série, valor declarado, peso, volumes e municípios de origem/destino, preenchendo campos ausentes sem sobrescrever endereços operacionais já definidos e sem fingir contratação confirmada.\n- Em **PDF/DANFE**, extrai os campos identificáveis e marca `uncertainty_flags` + `requires_confirmation=true` (`fiscal_status: nfe_pending_confirmation`) quando peso, valor ou endereço não puderem ser extraídos com certeza.\n",
"operationId": "anexarDocumentosSolicitacaoTransporteEmbarcador",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"arquivos": {
"type": "array",
"items": {
"type": "string",
"format": "binary"
}
}
}
}
},
"application/json": {
"schema": {
"type": "object",
"properties": {
"documentos": {
"type": "array",
"items": {
"type": "object",
"properties": {
"access_key": {
"type": "string",
"pattern": "^[0-9]{44}$"
},
"document_type": {
"type": "string",
"enum": [
"nfe",
"cte"
]
},
"source_format": {
"type": "string",
"enum": [
"xml",
"pdf",
"manual_key",
"api"
]
}
}
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "Documentos anexados e estado fiscal atualizado",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SolicitacaoTransporteResponse"
}
}
}
},
"404": {
"description": "Solicitação não encontrada",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Erro"
}
}
}
},
"422": {
"description": "Arquivo inválido ou erro de validação",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Erro"
}
}
}
}
},
"x-fleetpay-scope": "operacao",
"x-fleetpay-module": "contratacao-direta",
"x-fleetpay-profiles": [
"embarcador",
"gestor",
"agregado_empresarial"
],
"method": "POST",
"path": "/embarcador/solicitacoes-transporte/{id}/documentos"
}