shipments
shipments
Page 4 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": 73,
"orderId": 127,
"carrier": "ups",
"trackingNumber": "AZ9C4W8Z4LOQ5DGI",
"status": "delivered",
"shippedAt": "2026-04-24T01:15:30.003Z",
"deliveredAt": "2026-04-28T21:33:32.411Z",
"estimatedDeliveryAt": "2026-05-02T02:13:58.398Z",
"createdAt": "2026-04-24T01:15:30.003Z"
},
{
"id": 74,
"orderId": 128,
"carrier": "fedex",
"trackingNumber": "0JLYYLBI1Q3GZE3U",
"status": "label_created",
"shippedAt": "2024-11-01T17:44:10.583Z",
"deliveredAt": null,
"estimatedDeliveryAt": "2024-11-04T07:37:07.844Z",
"createdAt": "2024-11-01T17:44:10.583Z"
},
{
"id": 75,
"orderId": 131,
"carrier": "usps",
"trackingNumber": "QCUUWNPBVTBSGC9P",
"status": "label_created",
"shippedAt": "2025-05-31T07:18:43.108Z",
"deliveredAt": null,
"estimatedDeliveryAt": "2025-06-07T02:28:23.806Z",
"createdAt": "2025-05-31T07:18:43.108Z"
}
],
"meta": {
"page": 4,
"limit": 24,
"total": 531,
"totalPages": 23
},
"links": {
"self": "/api/v1/shipments?page=4&limit=24",
"first": "/api/v1/shipments?page=1&limit=24",
"last": "/api/v1/shipments?page=23&limit=24",
"next": "/api/v1/shipments?page=5&limit=24",
"prev": "/api/v1/shipments?page=3&limit=24"
}
}