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

# Read customer-safe progress through the waybill number printed on the label

> Opened with the number printed on the label, which is what a customer actually has. A link is handed to one person; a number travels on a parcel and is read out over the phone, so this answers only where the parcel has got to, on the same rounded public projection an opaque link opens.



## OpenAPI

````yaml /openapi.yaml get /api/v2/public/tracking/waybills/{shipmentNumber}
openapi: 3.1.0
info:
  title: DropHub External API
  version: v2
  description: The public machine-to-machine integration surface of DropHub.
servers:
  - url: https://api-test.drop-hub.com
    description: Sandbox. Isolated data and credentials.
  - url: https://api.drop-hub.com
    description: Production. Production credentials only.
security: []
tags:
  - name: Authentication
    description: >-
      Authentication, sessions, the company a principal is, and merchant API
      credentials
  - name: External Shipments
    description: OAuth-scoped Merchant shipment creation, lookup, and cancellation
  - name: External Tracking
    description: Merchant-authenticated and privacy-minimized public tracking projections
  - name: External Webhooks
  - name: Sandbox
    description: >-
      Tenant-bound self-service fixture lifecycle, available only on the
      isolated sandbox deployment
paths:
  /api/v2/public/tracking/waybills/{shipmentNumber}:
    get:
      tags:
        - External Tracking
      summary: >-
        Read customer-safe progress through the waybill number printed on the
        label
      description: >-
        Opened with the number printed on the label, which is what a customer
        actually has. A link is handed to one person; a number travels on a
        parcel and is read out over the phone, so this answers only where the
        parcel has got to, on the same rounded public projection an opaque link
        opens.
      operationId: getPublicWaybillTracking
      parameters:
        - name: shipmentNumber
          in: path
          required: true
          schema:
            type: string
            pattern: ^[A-Za-z0-9-]{4,64}$
      responses:
        '200':
          description: Customer-safe tracking without exact endpoints or identity
          headers:
            Cache-Control:
              schema:
                type: string
                const: no-store
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicTracking'
        '404':
          $ref: '#/components/responses/ResourceNotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    PublicTracking:
      type: object
      additionalProperties: false
      required:
        - status
        - locationStatus
        - recommendedRefreshSeconds
        - history
      properties:
        status:
          $ref: '#/components/schemas/ExternalShipmentStatus'
        driverLocation:
          description: Coarse position only; exact position and accuracy are never public.
          oneOf:
            - $ref: '#/components/schemas/ExternalMapLocation'
            - type: 'null'
        locationStatus:
          type: string
          enum:
            - NOT_ASSIGNED
            - WAITING_FOR_DRIVER_ACCEPTANCE
            - LOCATION_UNAVAILABLE
            - AVAILABLE
            - STALE
            - TERMINAL_NO_LIVE_LOCATION
        recommendedRefreshSeconds:
          type: integer
          format: int64
          minimum: 5
          maximum: 60
        history:
          type: array
          items:
            $ref: '#/components/schemas/ExternalTrackingStep'
    ExternalShipmentStatus:
      type: string
      enum:
        - CREATED
        - ASSIGNED
        - PICKED_UP
        - OUT_FOR_DELIVERY
        - DELIVERED
        - FAILED
        - NO_DRIVER_AVAILABLE
        - CANCELLED
      description: >-
        ASSIGNED covers an offer awaiting the driver's acceptance and an
        accepted one. NO_DRIVER_AVAILABLE means the bounded driver search ended
        without a driver; the shipment can still be cancelled.
    ExternalMapLocation:
      type: object
      additionalProperties: false
      required:
        - latitude
        - longitude
        - recordedAt
        - stale
        - ageSeconds
      properties:
        latitude:
          $ref: '#/components/schemas/Latitude'
        longitude:
          $ref: '#/components/schemas/Longitude'
        accuracyMetres:
          type:
            - number
            - 'null'
          minimum: 0
        recordedAt:
          $ref: '#/components/schemas/InstantUtc'
        stale:
          type: boolean
        ageSeconds:
          type: integer
          format: int64
          minimum: 0
    ExternalTrackingStep:
      type: object
      additionalProperties: false
      required:
        - status
        - at
      properties:
        status:
          $ref: '#/components/schemas/ExternalShipmentStatus'
        at:
          $ref: '#/components/schemas/InstantUtc'
    Problem:
      type: object
      description: RFC 9457 Problem Details with stable DropHub extensions
      additionalProperties: true
      required:
        - type
        - title
        - status
        - code
        - timestamp
        - correlationId
        - requestId
      properties:
        type:
          type: string
          format: uri
        title:
          type: string
          maxLength: 128
        status:
          type: integer
          format: int32
          minimum: 400
          maximum: 599
        detail:
          type: string
          maxLength: 512
        instance:
          type: string
          format: uri-reference
        code:
          type: string
          pattern: ^[A-Z][A-Z0-9_]{1,63}$
        timestamp:
          type: string
          format: date-time
        correlationId:
          type: string
          format: uuid
        requestId:
          type: string
          format: uuid
        violations:
          type: array
          maxItems: 20
          items:
            $ref: '#/components/schemas/Violation'
      example:
        type: https://api.drophub.example/problems/access-denied
        title: Access denied
        status: 403
        detail: Access to this resource is denied.
        instance: /api/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206
        code: ACCESS_DENIED
        timestamp: '2026-08-22T18:30:00Z'
        correlationId: 018f2d8a-1f00-7000-8000-000000000207
        requestId: 018f2d8a-1f00-7000-8000-000000000208
    Latitude:
      type: number
      minimum: -90
      maximum: 90
      multipleOf: 0.000001
    Longitude:
      type: number
      minimum: -180
      maximum: 180
      multipleOf: 0.000001
    InstantUtc:
      type: string
      format: date-time
    Violation:
      type: object
      additionalProperties: false
      required:
        - field
        - code
        - message
      properties:
        field:
          type: string
          maxLength: 128
        code:
          type: string
          maxLength: 64
        message:
          type: string
          maxLength: 256
  responses:
    ResourceNotFound:
      description: Resource not found; existence is hidden across authorization boundaries.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    RateLimited:
      description: The security operation is temporarily rate limited.
      headers:
        Retry-After:
          description: Suggested delay in seconds when available.
          schema:
            type: integer
            minimum: 1
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.