Notifications

Server

Download schema

Endpoints for tracking shipments and configuring notifications for shipment status updates.

Get shipment tracking events

GET

https://c1cf69108515455da09b5a33ff336111-oas.api.mockbin.io

/shipments/{shipmentId}/events

Bearer (JWT)

X-API-Key (header)

Retrieve detailed tracking events for a shipment

Get shipment tracking events › path Parameters

shipmentId

string · uuid · required

Get shipment tracking events › Responses

200

Tracking events retrieved successfully

shipmentId

string · uuid

object[]

GET/shipments/{shipmentId}/events

fetch('https://c1cf69108515455da09b5a33ff336111-oas.api.mockbin.io/shipments/:shipmentId/events', {
  headers: {
    Authorization: 'Bearer <token>'
  }
})

Example Responses

{
  "shipmentId": "123e4567-e89b-12d3-a456-426614174000",
  "events": [
    {
      "timestamp": "2025-01-09T16:30:00Z",
      "status": "DELIVERED",
      "location": {
        "city": "Shiptown",
        "state": "ST",
        "country": "US",
        "coordinates": {
          "latitude": 37.7749,
          "longitude": -122.4194
        }
      },
      "description": "Package delivered to recipient",
      "details": {
        "signedBy": "John Smith",
        "deliveryLocation": "Front Door"
      }
    },
    {
      "timestamp": "2025-01-09T09:15:00Z",
      "status": "OUT_FOR_DELIVERY",
      "location": {
        "city": "Shiptown",
        "state": "ST",
        "country": "US",
        "coordinates": {
          "latitude": 37.7749,
          "longitude": -122.4194
        }
      },
      "description": "Package is out for delivery",
      "details": {
        "vehicleId": "VAN123",
        "estimatedDelivery": "2025-01-09T17:00:00Z"
      }
    },
    {
      "timestamp": "2025-01-09T02:30:00Z",
      "status": "ARRIVED_AT_FACILITY",
      "location": {
        "city": "Shiptown",
        "state": "ST",
        "country": "US",
        "coordinates": {
          "latitude": 37.7749,
          "longitude": -122.4194
        }
      },
      "description": "Package arrived at local facility",
      "details": {
        "facilityId": "ST123"
      }
    }
  ]
}

json

application/json

Set up notifications

POST

https://c1cf69108515455da09b5a33ff336111-oas.api.mockbin.io

/shipments/{shipmentId}/notifications

Bearer (JWT)

X-API-Key (header)

Configure notification preferences for shipment status updates

Set up notifications › path Parameters

shipmentId

string · uuid · required

Set up notifications › Request Body

email

string[]

sms

string[]

webhooks

string[]

events

string[]

Enum values:

PICKUP_SCHEDULED

IN_TRANSIT

OUT_FOR_DELIVERY

DELIVERED

EXCEPTION

Set up notifications › Responses

Notification preferences updated

No data returned

Shipment Management Rates & Billing