SHshipoway
Shipper API

Track a shipment by order number

Retrieves tracking information for a shipment by its order number (PRO number). Returns status and estimated/actual pickup and delivery dates. Pass include=location to embed the live position estimate (route-interpolated, refined by recent vehicle positions, with an uncertainty radius) in the response. It is omitted by default so status polling does not pay the position-computation cost.

get/v1/shipper/shipment/{orderNumber}/tracking

Request

  • Base URL
    https://api.oway.io
  • URL
    https://api.oway.io/v1/shipper/shipment/{orderNumber}/tracking
  • Auth
    HTTP bearer and API key in header x-oway-api-key

Path parameters

orderNumberstring required

Order number (5-character alphanumeric code, commonly called PRO number)

Query parameters

includestring

Comma-separated optional sections to include. Currently supports 'location' to embed the live shipment position estimate (route-interpolated, refined by recent vehicle positions, with an uncertainty radius). Omitted by default so status polling does not pay the position-computation cost.

Response

Tracking information retrieved successfully

idstring

Unique identifier for the order

orderNumberstring

Human-readable PRO number for the shipment (5-character alphanumeric)

orderStatus'INITIALIZED' | 'CONFIRMED' | 'ACCEPTED' | 'ASSIGNED' | 'PICKED_UP' | 'IN_TRANSIT' | 'DELIVERED' | 'CANCELLED' | 'REJECTED' nullable

Current status of the order. Null only for an order whose internal state is unset; every live state maps to a value.

actualPickupDatestring date-time

Actual pickup date/time (ISO 8601 format)

actualDeliveryDatestring date-time

Actual delivery date/time (ISO 8601 format)

estimatedPickupDatestring date-time

Estimated pickup date/time (ISO 8601 format)

estimatedDeliveryDatestring date-time nullable

Estimated delivery date/time (ISO 8601 format). Null until a delivery window has been predicted or an appointment booked, which for most orders is at dispatch.

Example response

{
  "id": "507f1f77bcf86cd799439011",
  "orderNumber": "ZKYQ5",
  "orderStatus": "PICKED_UP",
  "actualPickupDate": "2024-12-23T10:30:00Z",
  "actualDeliveryDate": "2024-12-25T14:00:00Z",
  "estimatedPickupDate": "2024-12-23T09:00:00Z",
  "estimatedDeliveryDate": "2024-12-25T12:00:00Z",
  "location": {
    "center": {
      "vehicleId": "TRUCK-001",
      "timestamp": "2025-02-20T17:33:15Z",
      "latitude": 33.787363,
      "longitude": -118.163715,
      "heading": 270,
      "speed": 65
    },
    "uncertaintyRadiusKm": 4.2,
    "lastEventTimestamp": "2025-02-20T17:33:15Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.