openapi: 3.1.1
info:
  title: Waypoint
  version: 2.0.0
  description: Schema definition for the Waypoint entity in the Beckn Logistics domain.
  license:
    name: CC-BY-NC-SA 4.0 International
  contact:
    name: Beckn Labs
    url: https://beckn.io
components:
  schemas:
    Waypoint:
      x-iri: https://schema.nfh.global/Waypoint/v2.0
      type: object
      title: Waypoint
      description: 'A Waypoint is an intermediate stop or checkpoint on a logistics route, such as a sorting hub, relay station, or customs checkpoint. Maps to beckn:Stop.

        '
      required:
      - id
      - place
      properties:
        id:
          type: string
          example: WPT-HYD-001
        name:
          type: string
          example: Hyderabad Sorting Hub
        place:
          $ref: https://schema.nfh.global/LogisticsPlace/v2.0/attributes.yaml#/components/schemas/LogisticsPlace
        type:
          type: string
          enum:
          - HUB
          - RELAY_POINT
          - CUSTOMS
          - PICKUP
          - DELIVERY
          example: HUB
        sequenceNumber:
          type: integer
          description: Order of this waypoint in the route
          example: 2
        scheduledArrival:
          type: string
          format: date-time
        scheduledDeparture:
          type: string
          format: date-time
        actualArrival:
          type: string
          format: date-time
        actualDeparture:
          type: string
          format: date-time
        dwellTimeMinutes:
          type: integer
          description: Expected dwell time at this waypoint in minutes
          example: 120
        handoverRequired:
          type: boolean
          description: Whether shipment changes carrier/vehicle at this point
          example: true
        status:
          type: string
          enum:
          - PENDING
          - REACHED
          - DEPARTED
          - SKIPPED