openapi: 3.1.1
info:
  title: TrackingRequest
  version: 2.0.0
  description: Schema definition for TrackingRequest in the Beckn Protocol v2.0.1
  license:
    name: CC-BY-NC-SA 4.0 International
  contact:
    name: Beckn Labs
    url: https://beckn.io
components:
  schemas:
    TrackingRequest:
      x-iri: https://schema.nfh.global/TrackingRequest/v2.0
      description: Schema definition for TrackingRequest in the Beckn Protocol v2.0.1
      title: TrackingRequest
      x-tags:
      - common
      type: object
      properties:
        id:
          description: Tracking reference identifier
          type: string
        callbackUrl:
          description: Optional callback URL for streaming tracking coordinates/updates
          type: string
          format: uri
        modeHint:
          description: Optional delivery mode for the tracking handle.
          type: string
          enum:
          - LINK_ONLY
          - DEEP_LINK
          - WEBHOOK
          - WS_HANDLE
        trackingDataSchema:
          description: A JSON Schema (2020-12) that describes the structure of trackingData payloads.
      required:
      - id
      additionalProperties: false