> ## Documentation Index
> Fetch the complete documentation index at: https://docs.devmob.app.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Preview Trip Schedule

> Previews the trips a schedule would materialize.



## OpenAPI

````yaml /api-reference/ops/openapi.json post /api/v1/ops/trip-schedules/preview
openapi: 3.0.0
info:
  title: DEVMOB OPS API
  description: DEVMOB API
  version: '1.0'
  contact: {}
servers: []
security: []
tags:
  - name: Auth
    description: Authentication and token lifecycle
  - name: Bank Account
    description: Bank accounts
  - name: Benefit
    description: Benefit categories and usage history
  - name: Benefit Program
    description: Fare benefit programs
  - name: Benefit Request
    description: Fare benefit requests and documents
  - name: Credit Grant
    description: Company granted credits
  - name: Driver
    description: Company drivers
  - name: Employee
    description: Company employees
  - name: Employee Session
    description: Employee sessions
  - name: Export
    description: Export resources
  - name: Export Job
    description: Immediate export jobs
  - name: Export Schedule
    description: Scheduled exports
  - name: Invite
    description: Member invitations
  - name: Notification
    description: OPS inbox notifications
  - name: Offering
    description: Trip offerings and seat maps
  - name: Order
    description: Orders
  - name: Organization
    description: Organization profile
  - name: Organization Address
    description: Organization address
  - name: OTP
    description: One-time password flows
  - name: Payment
    description: Payments
  - name: Permission
    description: Permissions
  - name: Point
    description: Point lookup
  - name: Profile
    description: Authenticated OPS profile
  - name: Promotion
    description: Promotions
  - name: Promotion Rule
    description: Promotion rules
  - name: Receivable
    description: Receivables
  - name: Report
    description: Operational reports
  - name: Role
    description: Roles
  - name: Route
    description: Routes
  - name: Route Approval
    description: Route approvals
  - name: Routing
    description: Routing helpers
  - name: Storage
    description: Storage uploads
  - name: Support
    description: Support cases
  - name: Transfer
    description: Transfers
  - name: Trip
    description: Trips
  - name: Trip Event
    description: Trip operational events
  - name: Trip Schedule
    description: Recurring trip schedules
  - name: Trip Tracking
    description: Trip GPS tracking
  - name: Vehicle
    description: Vehicles and seats
paths:
  /api/v1/ops/trip-schedules/preview:
    post:
      tags:
        - Trip Schedule
      summary: Preview Trip Schedule
      description: Previews the trips a schedule would materialize.
      operationId: previewTripSchedule
      parameters:
        - name: fields
          required: false
          in: query
          description: >-
            Comma-separated list of fields to include in the response. Supports
            dot notation for nested projection (e.g.
            `id,name,user.email,trips.route.id`). Unknown fields are silently
            dropped.
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PreviewTripScheduleRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TripScheduleMaterialization'
                description: Trip schedule materialization preview
          description: OK
        '400':
          content:
            application/json:
              example:
                errors:
                  - message: required
                    path: name
                message: Bad Request Error
                statusCode: 400
              schema:
                properties:
                  message:
                    type: string
                  statusCode:
                    enum:
                      - 400
                    type: number
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                        path:
                          type: string
                      required:
                        - message
                        - path
                      type: object
                    type: array
                required:
                  - message
                  - statusCode
                type: object
          description: Bad Request Error
        '401':
          content:
            application/json:
              example:
                message: Missing or invalid access token
                statusCode: 401
              schema:
                properties:
                  message:
                    type: string
                  statusCode:
                    enum:
                      - 401
                    type: number
                required:
                  - message
                  - statusCode
                type: object
          description: Unauthorized
        '403':
          content:
            application/json:
              example:
                message: Insufficient permissions
                statusCode: 403
              schema:
                properties:
                  message:
                    type: string
                  statusCode:
                    enum:
                      - 403
                    type: number
                required:
                  - message
                  - statusCode
                type: object
          description: Forbidden
        '500':
          content:
            application/json:
              example:
                message: Internal Server Error
                statusCode: 500
              schema:
                properties:
                  message:
                    type: string
                  statusCode:
                    enum:
                      - 500
                    type: number
                required:
                  - message
                  - statusCode
                type: object
          description: Internal Server Error
      security:
        - bearer: []
        - bearer: []
components:
  schemas:
    PreviewTripScheduleRequest:
      type: object
      properties:
        routeId:
          type: string
          format: uuid
          description: Route identifier
          example: 0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3c
        vehicleId:
          type: string
          format: uuid
          description: Vehicle identifier
          example: 0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3d
        driverId:
          type: string
          format: uuid
          description: Driver identifier
          example: 0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3e
        name:
          type: string
          description: Trip schedule name
          example: São Paulo to Campinas daily morning
        frequency:
          type: string
          enum:
            - DAILY
            - WEEKLY
            - MONTHLY
          description: Trip schedule frequency
          example: DAILY
        interval:
          description: Frequency interval
          example: 1
          type: integer
          exclusiveMinimum: true
          minimum: 0
        departureAt:
          type: string
          format: date-time
          description: First scheduled departure
          example: '2026-04-15T08:00:00.000Z'
        endAt:
          type: string
          format: date-time
          description: Optional recurrence end
          example: '2026-12-31T23:59:59.000Z'
          nullable: true
        stops:
          minItems: 2
          type: array
          items:
            type: object
            properties:
              pointId:
                type: string
                format: uuid
                description: Point identifier
                example: 0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3c
              stopOrder:
                type: integer
                description: Stop sequence order
                example: 0
              arrivalOffsetMinutes:
                type: integer
                description: Arrival offset from departure in minutes
                example: 120
                nullable: true
              departureOffsetMinutes:
                type: integer
                description: Departure offset from departure in minutes
                example: 135
                nullable: true
            required:
              - pointId
              - stopOrder
          description: Trip schedule stops
        itineraries:
          minItems: 1
          type: array
          items:
            type: object
            properties:
              fromStopOrder:
                type: integer
                description: Origin stop order
                example: 0
              toStopOrder:
                type: integer
                exclusiveMinimum: true
                description: Destination stop order
                example: 1
                minimum: 0
              price:
                type: integer
                description: Price in centavos
                example: 15000
            required:
              - fromStopOrder
              - toStopOrder
              - price
          description: Trip schedule itineraries
      required:
        - routeId
        - vehicleId
        - driverId
        - name
        - frequency
        - departureAt
        - stops
        - itineraries
      description: Preview trip schedule payload
    TripScheduleMaterialization:
      type: object
      properties:
        status:
          type: string
          enum:
            - MATERIALIZABLE
            - CONFLICT
            - DUPLICATE
          description: Materialization status of a candidate trip
          example: MATERIALIZABLE
        description:
          type: string
          description: Conflict reason when not materializable
          example: Driver already booked in this period
          nullable: true
        departureAt:
          type: string
          format: date-time
          description: Departure time
          example: '2026-04-15T08:00:00.000Z'
        estimatedArrivalAt:
          type: string
          format: date-time
          description: Estimated arrival time
          example: '2026-04-15T14:00:00.000Z'
      required:
        - status
        - description
        - departureAt
        - estimatedArrivalAt
      description: Candidate trip materialization preview
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http

````