negotiation_idintegerObrigatório← InícioFleetPay / API
Criar programação de ofertas para motoristas agregados
Parâmetros, estrutura de dados e respostas do contrato versionado.
POST
/gestor/programacoes-ofertasDescrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.
Cria uma programação de disparo de ofertas vinculada a uma negociação ativa do gestor e gera vagas iniciais. Exige escopo operacao.
Autenticação
- Escopo Necessário
operacao— Operação- Módulo
- Gestor de Transporte e Alocação
- Perfis Aplicáveis
- Gestor de Transporte
- Mecanismos
- OAuth2 client_credentials (POST /oauth/token) ou API Key em Authorization: Bearer / X-Api-Key
[
{
"oauth2": []
},
{
"chaveApi": []
}
]A disponibilidade depende do ambiente, dos escopos habilitados e do provedor. Esta referência não executa chamadas nem recebe credenciais.
Parâmetros
Nenhum parâmetro declarado nesta operação.
Corpo da Requisição
Obrigatório
Configuração da programação de ofertas.
application/json
titlestringObrigatóriostart_datestring · dateObrigatórioend_datestring | null · dateOpcionaldaily_slotsinteger | nullOpcionalRespostas
201 Resposta HTTP
Programação criada com sucesso.
application/json
data—Opcionalmetaobject | nullOpcionaladditionalPropertiestrueambientestringOpcional"homologacao" · "producao"401 Resposta HTTP
Credencial ausente, inválida ou de outro ambiente.
403 Resposta HTTP
Escopo do painel não habilitado ou recurso fora do escopo da company.
422 Resposta HTTP
Negociação incompatível ou payload inválido.
Definição Completa da Operação
{
"tags": [
"Programações & Alocação"
],
"operationId": "criarProgramacaoOfertasGestor",
"summary": "Criar programação de ofertas para motoristas agregados",
"description": "Cria uma programação de disparo de ofertas vinculada a uma negociação ativa do gestor e gera vagas iniciais. Exige escopo `operacao`.",
"requestBody": {
"required": true,
"description": "Configuração da programação de ofertas.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"negotiation_id",
"title",
"start_date"
],
"properties": {
"negotiation_id": {
"type": "integer"
},
"title": {
"type": "string"
},
"start_date": {
"type": "string",
"format": "date"
},
"end_date": {
"type": [
"string",
"null"
],
"format": "date"
},
"daily_slots": {
"type": [
"integer",
"null"
]
}
}
}
}
}
},
"responses": {
"201": {
"description": "Programação criada 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."
},
"422": {
"description": "Negociação incompatível ou payload inválido."
}
},
"x-fleetpay-scope": "operacao",
"x-fleetpay-module": "gestor-alocacao",
"x-fleetpay-profiles": [
"gestor"
],
"method": "POST",
"path": "/gestor/programacoes-ofertas",
"parameters": []
}