shipments
shipments
Page 14 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": 313,
"orderId": 595,
"carrier": "ups",
"trackingNumber": "4K1RPG9WDX03UCUH",
"status": "delivered",
"shippedAt": "2026-03-14T05:29:50.614Z",
"deliveredAt": "2026-03-20T08:23:21.463Z",
"estimatedDeliveryAt": "2026-03-17T01:37:20.918Z",
"createdAt": "2026-03-14T05:29:50.614Z"
},
{
"id": 314,
"orderId": 596,
"carrier": "usps",
"trackingNumber": "N4F7NCCC2P5AKB12",
"status": "in_transit",
"shippedAt": "2024-08-06T17:06:29.232Z",
"deliveredAt": null,
"estimatedDeliveryAt": "2024-08-09T12:22:43.814Z",
"createdAt": "2024-08-06T17:06:29.232Z"
},
{
"id": 315,
"orderId": 598,
"carrier": "fedex",
"trackingNumber": "FE37KJOF2ZAO6TWW",
"status": "delivered",
"shippedAt": "2025-03-10T08:57:50.036Z",
"deliveredAt": "2025-03-13T14:48:57.066Z",
"estimatedDeliveryAt": "2025-03-15T03:11:22.618Z",
"createdAt": "2025-03-10T08:57:50.036Z"
}
],
"meta": {
"page": 14,
"limit": 24,
"total": 531,
"totalPages": 23
},
"links": {
"self": "/api/v1/shipments?page=14&limit=24",
"first": "/api/v1/shipments?page=1&limit=24",
"last": "/api/v1/shipments?page=23&limit=24",
"next": "/api/v1/shipments?page=15&limit=24",
"prev": "/api/v1/shipments?page=13&limit=24"
}
}