> ## 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 partner-safe shipment progress and available driver location ## OpenAPI ````yaml /openapi.yaml get /v2/external/shipments/{shipmentId}/tracking 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: OAuth 2.0 client-credentials token issuance - name: External Shipments description: Create, read, and cancel your shipments - name: External Tracking description: Partner and customer-safe shipment progress - name: External Webhooks description: Your single signed shipment webhook paths: /v2/external/shipments/{shipmentId}/tracking: get: tags: - External Tracking summary: Read partner-safe shipment progress and available driver location operationId: getExternalShipmentTracking parameters: - $ref: '#/components/parameters/ShipmentId' responses: '200': description: Partner-safe tracking content: application/json: schema: $ref: '#/components/schemas/ExternalTracking' '401': $ref: '#/components/responses/AuthenticationFailed' '403': $ref: '#/components/responses/AccessDenied' '404': $ref: '#/components/responses/ResourceNotFound' '429': $ref: '#/components/responses/RateLimited' security: - oauthClientCredentials: - shipments:read components: parameters: ShipmentId: name: shipmentId in: path required: true schema: type: string format: uuid schemas: ExternalTracking: type: object additionalProperties: false required: - id - reference - status - locationStatus - recommendedRefreshSeconds - history properties: id: $ref: '#/components/schemas/Uuid' reference: type: string status: $ref: '#/components/schemas/ExternalShipmentStatus' driverLocation: 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' Uuid: type: string format: uuid ExternalShipmentStatus: type: string enum: - CREATED - ASSIGNED - PICKED_UP - OUT_FOR_DELIVERY - DELIVERED - FAILED - 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 traceId: type: string pattern: ^[0-9a-f]{32}$ violations: type: array maxItems: 20 items: $ref: '#/components/schemas/Violation' example: type: https://api.drop-hub.com/problems/access-denied title: Access denied status: 403 detail: Access to this resource is denied. instance: /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 x-java-type: java.math.BigDecimal x-postgresql-type: numeric(9,6) x-unit: decimal-degrees Longitude: type: number minimum: -180 maximum: 180 multipleOf: 0.000001 x-java-type: java.math.BigDecimal x-postgresql-type: numeric(10,6) x-unit: decimal-degrees InstantUtc: type: string format: date-time x-java-type: java.time.Instant x-postgresql-type: timestamptz(6) x-time-semantics: UTC-instant 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: AuthenticationFailed: description: >- Authentication failed: the bearer token is missing, malformed, or expired. headers: WWW-Authenticate: $ref: '#/components/headers/WwwAuthenticate' content: application/problem+json: schema: $ref: '#/components/schemas/Problem' example: type: https://api.drop-hub.com/problems/authentication-required title: Authentication required status: 401 detail: Authentication is required for this resource. instance: /v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206 code: AUTHENTICATION_REQUIRED timestamp: '2026-08-22T18:30:00Z' correlationId: 018f2d8a-1f00-7000-8000-000000000207 requestId: 018f2d8a-1f00-7000-8000-000000000208 AccessDenied: description: >- The token is valid but the credential lacks the required scope, or the resource belongs to another merchant. The machine code is `ACCESS_DENIED`. Retrying with the same credential will never succeed. content: application/problem+json: schema: $ref: '#/components/schemas/Problem' 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' headers: WwwAuthenticate: description: Bearer challenge for an unauthenticated or invalid-token request. schema: type: string example: Bearer securitySchemes: oauthClientCredentials: type: oauth2 description: >- OAuth 2.0 client-credentials flow for external machine-to-machine integrations. flows: clientCredentials: tokenUrl: /oauth/token scopes: shipments:read: Read Merchant-owned shipments shipments:write: Create and cancel Merchant-owned shipments webhooks:manage: Configure and rotate the merchant's single signed shipment webhook ````