List tracking events for a shipment

GET/v1/shipments/{shipment_id}/eventsList tracking events for a shipment

Parameters

shipment_idstringpathrequired

pattern ^shp_[a-z0-9]{20}$

cursorstringquery

minLength 1

limitintegerquery

default 25 · maximum 100 · minimum 1

Responses

objectTrackingEventPage

dataarray of objectrequired

Show child attributes

Show array items

idstringrequired

locationobjectrequired

Show child attributes

citystringrequired

countrystringrequired

messagestring

objectvaluerequired

const "tracking_event"

occurred_atstring · date-timerequired

shipment_idstringrequired

statusstringrequired

one of "draft", "label_purchased", "in_transit", "out_for_delivery", "delivered", "exception", "canceled"

has_morebooleanrequired

next_cursornull | stringrequired

Example response

{
  "data": [
    {
      "id": "evt_00000000000000000001",
      "location": {
        "city": "Samplehaven",
        "country": "ZZ"
      },
      "message": "Parcel scanned at synthetic sorting hub",
      "object": "tracking_event",
      "occurred_at": "2026-09-05T05:40:00Z",
      "shipment_id": "shp_00000000000000000001",
      "status": "canceled"
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}

objectProblem

detailstring

errorsarray of object

Show child attributes

Show array items

messagestringrequired

pathstringrequired

request_idstringrequired

statusintegerrequired

maximum 599 · minimum 400

titlestringrequired

typestring · urirequired

Example response

{
  "request_id": "req_00000000000000000004",
  "status": 404,
  "title": "Synthetic resource was not found",
  "type": "https://parcel-events.example/problems/not-found"
}

Examples

shipment_idrequiredpath parameter

cursorquery parameter

limitquery parameter

curl -X GET 'https://api.parcel-events.example/v1/shipments/string/events?cursor=string&limit=25'

const response = await fetch('https://api.parcel-events.example/v1/shipments/string/events?cursor=string&limit=25', { method: 'GET' });
const data = await response.json();

const response = await fetch('https://api.parcel-events.example/v1/shipments/string/events?cursor=string&limit=25', { method: 'GET' });
console.log(await response.json());

import requests

response = requests.request("GET", "https://api.parcel-events.example/v1/shipments/string/events?cursor=string&limit=25")
print(response.json())

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "GET", "https://api.parcel-events.example/v1/shipments/string/events?cursor=string&limit=25", nil)
	if err != nil {
		panic(err)
	}
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://api.parcel-events.example/v1/shipments/string/events?cursor=string&limit=25");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://api.parcel-events.example/v1/shipments/string/events?cursor=string&limit=25"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.parcel-events.example/v1/shipments/string/events?cursor=string&limit=25")
request = Net::HTTPGenericRequest.new("GET", false, true, uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://api.parcel-events.example/v1/shipments/string/events?cursor=string&limit=25");
using var response = await client.SendAsync(request);

{
  "data": [
    {
      "id": "evt_00000000000000000001",
      "location": {
        "city": "Samplehaven",
        "country": "ZZ"
      },
      "message": "Parcel scanned at synthetic sorting hub",
      "object": "tracking_event",
      "occurred_at": "2026-09-05T05:40:00Z",
      "shipment_id": "shp_00000000000000000001",
      "status": "canceled"
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}

{
  "request_id": "req_00000000000000000004",
  "status": 404,
  "title": "Synthetic resource was not found",
  "type": "https://parcel-events.example/problems/not-found"
}

Search documentation

Parameters

Responses

Documentation menu