SHshipoway
Carrier API

Submit GPS location for a shipment

Changed on

Submit a GPS location update tied to a specific shipment.

State requirement: The shipment must be in ACCEPTED or PICKED_UP status.

post/v1/carrier/shipments/{identifier}/location

Request

  • Base URL
    https://api.oway.io
  • URL
    https://api.oway.io/v1/carrier/shipments/{identifier}/location
  • Auth
    HTTP bearer and API key in header x-oway-api-key

Path parameters

identifierstring required

Shipment identifier (offerId, orderNumber, or carrierReference)

Request body

latitudenumber double required

Latitude in decimal degrees

longitudenumber double required

Longitude in decimal degrees

headinginteger

Heading in degrees (0-359, where 0 is north; -1 for unknown)

speed_mphinteger

Speed in miles per hour

timestampstring date-time required

Timestamp of this location reading

vehicle_idstring

Identifier of the vehicle reporting this position. Optional. Supply it here if the vehicle was not known at offer acceptance, or when the truck changes mid-shipment; the latest value is recorded as the shipment's assigned vehicle. The position trail itself is keyed internally per shipment, so changing or omitting this never affects tracking history.

Example request

{
  "latitude": 33.7701,
  "longitude": -118.1937,
  "heading": 270,
  "speed_mph": 65,
  "vehicle_id": "TRUCK-42"
}

Response

Location update acknowledged

recordedboolean

Whether the location update was recorded

order_numberstring

Human-readable order number

Example response

{
  "recorded": true,
  "order_number": "Y73Q0"
}

Changes