shipper_cnpjstring | nullOpcionalCNPJ del embarcador cuando corresponda.
Parámetros, estructura de datos y respuestas del contrato versionado.
/servicos/importLas descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.
Recibe un lote JSON de servicios/documentos para procesamiento asíncrono en el flujo operativo de la company autenticada.
operacao — Operación[
{
"oauth2": []
},
{
"chaveApi": []
}
]No hay parámetros declarados para esta operación.
Obligatorio
Lista de elementos de servicio para creación en lote.
application/jsonshipper_cnpjstring | nullOpcionalCNPJ del embarcador cuando corresponda.
itemsarrayObligatorioElementos de servicio del lote.
202 Respuesta HTTPLote recibido para procesamiento asíncrono.
application/jsondata—Opcionalmetaobject | nullOpcionaladditionalPropertiestrueambientestringOpcional"homologacao" · "producao"401 Respuesta HTTPCredencial ausente, inválida o de otro entorno.
403 Respuesta HTTPPermiso del panel no habilitado o recurso fuera del alcance de la company.
422 Respuesta HTTPFalla de validación estructural del 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": []
}