SHshipoway
Carrier API

Report a shipment exception or delay

Changed on

Report an exception such as weather delay, vehicle breakdown, or address issue.

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

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

Request

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

Path parameters

identifierstring required

Shipment identifier (offerId, orderNumber, or carrierReference)

Request body

exception_type'no_capacity' | 'wrong_equipment' | 'load_not_ready' | 'failed_pickup' | 'truck_breakdown' | 'driver_hos_expired' | 'damage_upon_receipt' | 'damage_in_transit' | 'damage_at_delivery' | 'weather_delay' | 'traffic_delay' | 'address_incorrect' | 'recipient_unavailable' | 'customs_delay' | 'delivery_attempted' | 'other' required

Type of exception that occurred

exception_timestring date-time required

Time the exception occurred

descriptionstring

Description of the exception

estimated_delivery_timestring date-time

Revised estimated delivery time following the exception

Example request

{
  "location": {
    "address1": "1531 Junipero Avenue",
    "address2": "Dock 5",
    "city": "Long Beach",
    "state": "CA",
    "zip_code": "90804",
    "country": "US"
  }
}

Response

Exception recorded

order_numberstring

Human-readable order number

exception_recordedboolean

Whether the exception was successfully recorded

notifications_sentboolean

Whether notifications were sent to relevant parties (reserved for future use)

Example response

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

Changes