shipments
shipments
Page 12 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": 265,
"orderId": 504,
"carrier": "dhl",
"trackingNumber": "0DHM93VK0LS1A05Q",
"status": "in_transit",
"shippedAt": "2025-07-19T17:23:00.081Z",
"deliveredAt": null,
"estimatedDeliveryAt": "2025-07-27T05:52:41.776Z",
"createdAt": "2025-07-19T17:23:00.081Z"
},
{
"id": 266,
"orderId": 505,
"carrier": "fedex",
"trackingNumber": "OC8AI0WTQA81ZDPS",
"status": "label_created",
"shippedAt": "2026-01-07T19:51:01.975Z",
"deliveredAt": null,
"estimatedDeliveryAt": "2026-01-09T23:48:12.474Z",
"createdAt": "2026-01-07T19:51:01.975Z"
},
{
"id": 267,
"orderId": 507,
"carrier": "fedex",
"trackingNumber": "Y4DEZK779MK16FIS",
"status": "label_created",
"shippedAt": "2024-12-16T14:28:25.523Z",
"deliveredAt": null,
"estimatedDeliveryAt": "2024-12-22T23:37:43.281Z",
"createdAt": "2024-12-16T14:28:25.523Z"
}
],
"meta": {
"page": 12,
"limit": 24,
"total": 531,
"totalPages": 23
},
"links": {
"self": "/api/v1/shipments?page=12&limit=24",
"first": "/api/v1/shipments?page=1&limit=24",
"last": "/api/v1/shipments?page=23&limit=24",
"next": "/api/v1/shipments?page=13&limit=24",
"prev": "/api/v1/shipments?page=11&limit=24"
}
}