shipments
shipments
Page 10 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": 217,
"orderId": 417,
"carrier": "usps",
"trackingNumber": "8C0VDPUW0KRKBG90",
"status": "label_created",
"shippedAt": "2025-12-03T22:45:57.713Z",
"deliveredAt": null,
"estimatedDeliveryAt": "2025-12-13T14:07:30.730Z",
"createdAt": "2025-12-03T22:45:57.713Z"
},
{
"id": 218,
"orderId": 419,
"carrier": "dhl",
"trackingNumber": "CKYKLFRCY25GFTVQ",
"status": "label_created",
"shippedAt": "2025-04-07T18:12:14.529Z",
"deliveredAt": null,
"estimatedDeliveryAt": "2025-04-13T13:04:31.739Z",
"createdAt": "2025-04-07T18:12:14.529Z"
},
{
"id": 219,
"orderId": 421,
"carrier": "usps",
"trackingNumber": "Z3AJYOF7EODWCBYS",
"status": "label_created",
"shippedAt": "2025-05-26T10:21:30.052Z",
"deliveredAt": null,
"estimatedDeliveryAt": "2025-06-03T21:14:06.214Z",
"createdAt": "2025-05-26T10:21:30.052Z"
}
],
"meta": {
"page": 10,
"limit": 24,
"total": 531,
"totalPages": 23
},
"links": {
"self": "/api/v1/shipments?page=10&limit=24",
"first": "/api/v1/shipments?page=1&limit=24",
"last": "/api/v1/shipments?page=23&limit=24",
"next": "/api/v1/shipments?page=11&limit=24",
"prev": "/api/v1/shipments?page=9&limit=24"
}
}