SHshipoway
Carrier API

Report a shipment milestone

Changed on

Records a physical shipment observation without changing the shipment's commercial order state.

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

Request

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

Path parameters

identifierstring required

Shipment identifier (offerId, orderNumber, or carrierReference)

Request body

type'ARRIVED_AT_PICKUP' | 'LOADED' | 'DEPARTED_PICKUP' | 'ARRIVED_AT_DELIVERY' | 'UNLOADED' required
occurred_atstring date-time required

Time the physical event occurred

notesstring

Additional notes about the milestone

Example request

{
  "coordinates": {
    "latitude": 33.7701,
    "longitude": -118.1937
  }
}

Response

Milestone recorded

type'ARRIVED_AT_PICKUP' | 'LOADED' | 'DEPARTED_PICKUP' | 'ARRIVED_AT_DELIVERY' | 'UNLOADED'
source'DRIVER_APP' | 'ADMIN_APP' | 'CARRIER_API' | 'ELD_AUTO' | 'INFERRED'
occurredAtstring date-time
latnumber double
lngnumber double
notesstring

Changes