shipper_cnpjstring | nullOpcionalCNPJ do embarcador quando aplicável.
Parâmetros, estrutura de dados e respostas do contrato versionado.
/servicos/importDescrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.
Recebe lote JSON de serviços/documentos para processamento assíncrono no trilho operacional da company autenticada.
operacao — Operação[
{
"oauth2": []
},
{
"chaveApi": []
}
]Nenhum parâmetro declarado nesta operação.
Obrigatório
Lista de itens de serviço para criação em lote.
application/jsonshipper_cnpjstring | nullOpcionalCNPJ do embarcador quando aplicável.
itemsarrayObrigatórioItens de serviço do lote.
202 Resposta HTTPLote recebido para processamento assíncrono.
application/jsondata—Opcionalmetaobject | nullOpcionaladditionalPropertiestrueambientestringOpcional"homologacao" · "producao"401 Resposta HTTPCredencial ausente, inválida ou de outro ambiente.
403 Resposta HTTPEscopo do painel não habilitado ou recurso fora do escopo da company.
422 Resposta HTTPFalha de validação estrutural do lote.
{
"tags": [
"Parcelas"
],
"operationId": "importarServicosEmLote",
"summary": "Importar serviços e documentos em lote",
"description": "Recebe lote JSON de serviços/documentos para processamento assíncrono no trilho operacional da company autenticada.",
"requestBody": {
"required": true,
"description": "Lista de itens de serviço para criação em lote.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"items"
],
"properties": {
"shipper_cnpj": {
"type": [
"string",
"null"
],
"description": "CNPJ do embarcador quando aplicável."
},
"items": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
},
"description": "Itens de serviço do lote."
}
}
}
}
}
},
"responses": {
"202": {
"description": "Lote recebido para processamento assíncrono.",
"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."
},
"422": {
"description": "Falha de validação estrutural do lote."
}
},
"x-fleetpay-scope": "operacao",
"x-fleetpay-module": "repasses-comprovantes",
"x-fleetpay-profiles": [
"gestor",
"agregado_empresarial",
"transportador_frotista"
],
"method": "POST",
"path": "/servicos/import",
"parameters": []
}