shipments
shipments
Page 2 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": 25,
"orderId": 48,
"carrier": "ups",
"trackingNumber": "44CMB9PVDU2BRY83",
"status": "label_created",
"shippedAt": "2025-05-19T22:15:34.740Z",
"deliveredAt": null,
"estimatedDeliveryAt": "2025-05-27T23:42:20.974Z",
"createdAt": "2025-05-19T22:15:34.740Z"
},
{
"id": 26,
"orderId": 50,
"carrier": "ups",
"trackingNumber": "2DJWR727LMMTABLE",
"status": "delivered",
"shippedAt": "2024-12-14T15:01:15.522Z",
"deliveredAt": "2024-12-18T22:58:44.636Z",
"estimatedDeliveryAt": "2024-12-20T07:49:10.065Z",
"createdAt": "2024-12-14T15:01:15.522Z"
},
{
"id": 27,
"orderId": 51,
"carrier": "usps",
"trackingNumber": "F6SIIJPYUREU43UI",
"status": "delivered",
"shippedAt": "2025-12-04T09:47:33.283Z",
"deliveredAt": "2025-12-11T13:42:03.393Z",
"estimatedDeliveryAt": "2025-12-06T12:22:07.701Z",
"createdAt": "2025-12-04T09:47:33.283Z"
}
],
"meta": {
"page": 2,
"limit": 24,
"total": 531,
"totalPages": 23
},
"links": {
"self": "/api/v1/shipments?page=2&limit=24",
"first": "/api/v1/shipments?page=1&limit=24",
"last": "/api/v1/shipments?page=23&limit=24",
"next": "/api/v1/shipments?page=3&limit=24",
"prev": "/api/v1/shipments?page=1&limit=24"
}
}