shipments
shipments
Page 3 of 23.
Overview
Request
curl example
curl -sS \ "https://example-data.com/api/v1/shipments?limit=25"
JavaScript example
const res = await fetch(
"https://example-data.com/api/v1/shipments?limit=25"
);
const { data, meta } = await res.json(); TypeScript example
// Download once: mkdir -p types && curl -o types/shipments.d.ts https://example-data.com/types/shipments.d.ts
import type { Shipment, ListEnvelope } from "./types/shipments";
const res = await fetch(
"https://example-data.com/api/v1/shipments?limit=25"
);
const { data, meta } = (await res.json()) as ListEnvelope<Shipment>; Python example
import requests
res = requests.get(
"https://example-data.com/api/v1/shipments",
params={"limit": 25},
)
data = res.json() Response
{
"data": [
{
"id": 49,
"orderId": 88,
"carrier": "fedex",
"trackingNumber": "DA8MBKTETUTOW4SF",
"status": "out_for_delivery",
"shippedAt": "2024-06-09T08:47:31.779Z",
"deliveredAt": null,
"estimatedDeliveryAt": "2024-06-15T14:53:44.042Z",
"createdAt": "2024-06-09T08:47:31.779Z"
},
{
"id": 50,
"orderId": 89,
"carrier": "usps",
"trackingNumber": "3GRRZ9QW6OGPC6BT",
"status": "delivered",
"shippedAt": "2026-02-16T20:21:59.401Z",
"deliveredAt": "2026-02-22T07:52:54.744Z",
"estimatedDeliveryAt": "2026-02-24T02:08:22.808Z",
"createdAt": "2026-02-16T20:21:59.401Z"
},
{
"id": 51,
"orderId": 92,
"carrier": "usps",
"trackingNumber": "3ZRAZ962VCPFXOAG",
"status": "in_transit",
"shippedAt": "2026-04-05T14:52:19.013Z",
"deliveredAt": null,
"estimatedDeliveryAt": "2026-04-10T03:08:30.422Z",
"createdAt": "2026-04-05T14:52:19.013Z"
}
],
"meta": {
"page": 3,
"limit": 24,
"total": 531,
"totalPages": 23
},
"links": {
"self": "/api/v1/shipments?page=3&limit=24",
"first": "/api/v1/shipments?page=1&limit=24",
"last": "/api/v1/shipments?page=23&limit=24",
"next": "/api/v1/shipments?page=4&limit=24",
"prev": "/api/v1/shipments?page=2&limit=24"
}
}