shipments
shipments
Page 5 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": 97,
"orderId": 170,
"carrier": "fedex",
"trackingNumber": "V32QBVDLCVPAHSF5",
"status": "delivered",
"shippedAt": "2025-06-05T20:10:34.418Z",
"deliveredAt": "2025-06-11T17:25:18.107Z",
"estimatedDeliveryAt": "2025-06-15T07:47:19.172Z",
"createdAt": "2025-06-05T20:10:34.418Z"
},
{
"id": 98,
"orderId": 172,
"carrier": "ups",
"trackingNumber": "UU0ABH69DQCBD71Y",
"status": "label_created",
"shippedAt": "2025-10-31T09:24:48.476Z",
"deliveredAt": null,
"estimatedDeliveryAt": "2025-11-04T10:39:07.845Z",
"createdAt": "2025-10-31T09:24:48.476Z"
},
{
"id": 99,
"orderId": 174,
"carrier": "usps",
"trackingNumber": "O3N9TBT5TWTDEA34",
"status": "in_transit",
"shippedAt": "2025-12-28T16:48:49.441Z",
"deliveredAt": null,
"estimatedDeliveryAt": "2026-01-01T01:23:21.804Z",
"createdAt": "2025-12-28T16:48:49.441Z"
}
],
"meta": {
"page": 5,
"limit": 24,
"total": 531,
"totalPages": 23
},
"links": {
"self": "/api/v1/shipments?page=5&limit=24",
"first": "/api/v1/shipments?page=1&limit=24",
"last": "/api/v1/shipments?page=23&limit=24",
"next": "/api/v1/shipments?page=6&limit=24",
"prev": "/api/v1/shipments?page=4&limit=24"
}
}