← InícioFleetPay / API

Revisar programação de demanda e sincronizar com o serviço central de ofertas

Parâmetros, estrutura de dados e respostas do contrato versionado.

POST/embarcador/solicitacoes-transporte/{id}/revisar-demanda
revisarDemandaSolicitacaoTransporteEmbarcadorBase de Homologação: https://api.fleetpay.site/v1

Descrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.

Integra alterações de demanda recebidas por API, arquivo ou interface com a programação central de envio de ofertas da sessão Gestão de Ofertas e Negociações, diferenciando:

  • Acréscimo de demanda (demand_revision_mode: complement): soma entregas e/ou vagas adicionais à programação vigente e incrementa demand_version.
  • Substituição do total (demand_revision_mode: total_revision): substitui os totais planejados da janela/turno. Se houver redução abaixo do número de executores já com aceite/alocação ativa, não cancela silenciosamente o trabalho já aceito: preserva as alocações ativas e sinaliza reduction_after_acceptance = true e cancellation_requested_after_acceptance = true para tratativa explícita.
  • Incorporação à mesma unidade de trabalho (demand_revision_mode: incorporate_into_work_unit): adiciona entregas à diária/turno já aceito (work_unit_key) sem abrir novas vagas e sem gerar diária duplicada (ShipperManagedOperation) para o mesmo motorista/turno.
  • Idempotência de reenvio: reenviar o mesmo payload de revisão para o mesmo estado retorna 200 com data.demand_offer_integration.idempotent_replay = true sem incrementar demand_version.
  • Controle de revisão concorrente: se expected_demand_version divergir da versão atual da programação, responde 409 DEMAND_VERSION_CONFLICT.
  • Regra explícita entregas -> vagas: quando deliveries_count é informado sem required_vacancies_count, exige deliveries_per_driver_rule positivo (422 DELIVERIES_TO_DRIVERS_RULE_REQUIRED).

Autenticação

Escopo Necessário
operacao — Operação
Módulo
Contratação Direta (Embarcador)
Perfis Aplicáveis
Embarcador · Gestor de Transporte · Agregado Empresarial
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

idpath · stringObrigatório
Restrições
{
  "type": "string"
}

Corpo da Requisição

Obrigatório

application/json

demand_revision_modestringOpcional

complement soma entregas/vagas; total_revision substitui o total planejado da janela sem cancelar silenciosamente aceites ativos; incorporate_into_work_unit incorpora entregas na mesma diária/turno sem gerar diária duplicada.

"complement" · "total_revision" · "incorporate_into_work_unit"
expected_demand_versioninteger | nullOpcional

Versão atual esperada da programação de demanda para controle de concorrência (409 DEMAND_VERSION_CONFLICT se divergir).

demand_schedule_typestring | nullOpcional
"variable" · "fixed_scheduled" · "mixed" · null
operational_base_codestring | nullOpcional
window_shift_codestring | nullOpcional
deliveries_countinteger | nullOpcional
minimum0
required_vacancies_countinteger | nullOpcional
minimum0
deliveries_per_driver_ruleinteger | nullOpcional

Regra explícita de conversão de quantidade de entregas em vagas/motoristas quando required_vacancies_count não é informado diretamente.

minimum1
work_unit_keystring | nullOpcional

Respostas

200 Resposta HTTP

Programação de demanda sincronizada (ou replay idempotente reconhecido)

application/json

successbooleanOpcional
commercial_resolutionobject | nullOpcional
404 Resposta HTTP

Solicitação não encontrada

application/json

errorobjectOpcional
409 Resposta HTTP

Conflito de versão concorrente da programação de demanda (DEMAND_VERSION_CONFLICT)

application/json

errorobjectOpcional
422 Resposta HTTP

Ausência de regra explícita de conversão entregas -> motoristas (DELIVERIES_TO_DRIVERS_RULE_REQUIRED) ou parâmetros inválidos

application/json

errorobjectOpcional
Definição Completa da Operação
{
  "tags": [
    "Solicitações e Contratação de Transporte (Embarcador)"
  ],
  "summary": "Revisar programação de demanda e sincronizar com o serviço central de ofertas",
  "description": "Integra alterações de demanda recebidas por API, arquivo ou interface com a programação central de envio de ofertas da sessão **Gestão de Ofertas e Negociações**, diferenciando:\n- **Acréscimo de demanda (`demand_revision_mode: complement`)**: soma entregas e/ou vagas adicionais à programação vigente e incrementa `demand_version`.\n- **Substituição do total (`demand_revision_mode: total_revision`)**: substitui os totais planejados da janela/turno. Se houver redução abaixo do número de executores já com aceite/alocação ativa, **não cancela silenciosamente** o trabalho já aceito: preserva as alocações ativas e sinaliza `reduction_after_acceptance = true` e `cancellation_requested_after_acceptance = true` para tratativa explícita.\n- **Incorporação à mesma unidade de trabalho (`demand_revision_mode: incorporate_into_work_unit`)**: adiciona entregas à diária/turno já aceito (`work_unit_key`) sem abrir novas vagas e **sem gerar diária duplicada** (`ShipperManagedOperation`) para o mesmo motorista/turno.\n- **Idempotência de reenvio**: reenviar o mesmo payload de revisão para o mesmo estado retorna `200` com `data.demand_offer_integration.idempotent_replay = true` sem incrementar `demand_version`.\n- **Controle de revisão concorrente**: se `expected_demand_version` divergir da versão atual da programação, responde `409 DEMAND_VERSION_CONFLICT`.\n- **Regra explícita entregas -> vagas**: quando `deliveries_count` é informado sem `required_vacancies_count`, exige `deliveries_per_driver_rule` positivo (`422 DELIVERIES_TO_DRIVERS_RULE_REQUIRED`).\n",
  "operationId": "revisarDemandaSolicitacaoTransporteEmbarcador",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/RevisarDemandaSolicitacaoTransporteRequest"
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Programação de demanda sincronizada (ou replay idempotente reconhecido)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/SolicitacaoTransporteResponse"
          }
        }
      }
    },
    "404": {
      "description": "Solicitação não encontrada",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Erro"
          }
        }
      }
    },
    "409": {
      "description": "Conflito de versão concorrente da programação de demanda (`DEMAND_VERSION_CONFLICT`)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Erro"
          }
        }
      }
    },
    "422": {
      "description": "Ausência de regra explícita de conversão entregas -> motoristas (`DELIVERIES_TO_DRIVERS_RULE_REQUIRED`) ou parâmetros inválidos",
      "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}/revisar-demanda"
}