shipments
shipments
Page 21 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": 481,
"orderId": 899,
"carrier": "ups",
"trackingNumber": "8AHTVJNUDJG9URY1",
"status": "delivered",
"shippedAt": "2025-04-29T03:12:37.077Z",
"deliveredAt": "2025-05-02T21:53:48.058Z",
"estimatedDeliveryAt": "2025-05-01T21:59:45.616Z",
"createdAt": "2025-04-29T03:12:37.077Z"
},
{
"id": 482,
"orderId": 903,
"carrier": "usps",
"trackingNumber": "1M0GYABTKQAYV51J",
"status": "label_created",
"shippedAt": "2026-05-12T08:58:44.048Z",
"deliveredAt": null,
"estimatedDeliveryAt": "2026-05-18T19:08:53.175Z",
"createdAt": "2026-05-12T08:58:44.048Z"
},
{
"id": 483,
"orderId": 904,
"carrier": "usps",
"trackingNumber": "1K7XTOBK7RJKMTT0",
"status": "delivered",
"shippedAt": "2025-06-16T04:54:54.908Z",
"deliveredAt": "2025-06-21T22:08:45.495Z",
"estimatedDeliveryAt": "2025-06-19T11:15:51.219Z",
"createdAt": "2025-06-16T04:54:54.908Z"
}
],
"meta": {
"page": 21,
"limit": 24,
"total": 531,
"totalPages": 23
},
"links": {
"self": "/api/v1/shipments?page=21&limit=24",
"first": "/api/v1/shipments?page=1&limit=24",
"last": "/api/v1/shipments?page=23&limit=24",
"next": "/api/v1/shipments?page=22&limit=24",
"prev": "/api/v1/shipments?page=20&limit=24"
}
}