← InicioFleetPay / API

Revisar programación de demanda y sincronizar con el servicio central de ofertas

Parámetros, estructura de datos y respuestas del contrato versionado.

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

Las descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.

Integra cambios de demanda recibidos vía API, archivo o interfaz con la programación central de ofertas en Gestión de Ofertas y Negociaciones, diferenciando:

  • Adición de demanda (demand_revision_mode: complement): suma entregas y/o vacantes adicionales e incrementa demand_version.
  • Reemplazo del total (demand_revision_mode: total_revision): sustituye los totales planificados. Si se reduce debajo de ejecutores ya con aceptación/asignación activa, no cancela en silencio: preserva las asignaciones y marca reduction_after_acceptance = true y cancellation_requested_after_acceptance = true para gestión explícita.
  • Incorporación a la misma unidad de trabajo (demand_revision_mode: incorporate_into_work_unit): añade entregas a la tarifa diaria/turno aceptada (work_unit_key) sin abrir nuevas vacantes y sin generar tarifa diaria duplicada (ShipperManagedOperation).
  • Idempotencia de reenvío: reenviar el mismo payload devuelve 200 con data.demand_offer_integration.idempotent_replay = true sin incrementar demand_version.
  • Control de concurrencia: si expected_demand_version diverge, responde 409 DEMAND_VERSION_CONFLICT.
  • Regla explícita entregas -> vacantes: cuando se informa deliveries_count sin required_vacancies_count, exige deliveries_per_driver_rule positivo (422 DELIVERIES_TO_DRIVERS_RULE_REQUIRED).

Autenticación

Permiso Requerido
operacao — Operación
Módulo
Contratación Directa (Embarcador)
Perfiles Aplicables
Embarcador · Gestor de Transporte · Agregado Empresarial
Mecanismos
OAuth2 client_credentials (POST /oauth/token) o API Key vía Authorization: Bearer / X-Api-Key
[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]
La disponibilidad depende del entorno, los permisos habilitados y el proveedor. Esta referencia no ejecuta solicitudes ni recibe credenciales.

Parámetros

idpath · stringObligatorio
Restricciones
{
  "type": "string"
}

Cuerpo de la Solicitud

Obligatorio

application/json

demand_revision_modestringOpcional

complement suma entregas/vacantes; total_revision sustituye el total planificado de la ventana sin cancelar silenciosamente aceptaciones activas; incorporate_into_work_unit incorpora entregas en la misma tarifa diaria/turno sin generar tarifa diaria duplicada.

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

Versión actual esperada de la programación de demanda para control de concurrencia (409 DEMAND_VERSION_CONFLICT si diverge).

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

Regla explícita de conversión de cantidad de entregas a vacantes/conductores cuando required_vacancies_count no se informa directamente.

minimum1
work_unit_keystring | nullOpcional

Respuestas

200 Respuesta HTTP

Programación de demanda sincronizada (o repetición idempotente reconocida)

application/json

successbooleanOpcional
commercial_resolutionobject | nullOpcional
404 Respuesta HTTP

Solicitud no encontrada

application/json

errorobjectOpcional
409 Respuesta HTTP

Conflicto de versión concurrente de la programación de demanda (DEMAND_VERSION_CONFLICT)

application/json

errorobjectOpcional
422 Respuesta HTTP

Falta de regla explícita de conversión entregas -> conductores (DELIVERIES_TO_DRIVERS_RULE_REQUIRED) o parámetros inválidos

application/json

errorobjectOpcional
Definición Completa de la Operación
{
  "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"
}