shipments
shipments
Page 20 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": 457,
"orderId": 846,
"carrier": "fedex",
"trackingNumber": "UXV88W0Y91Q6HG22",
"status": "out_for_delivery",
"shippedAt": "2025-01-02T08:36:23.376Z",
"deliveredAt": null,
"estimatedDeliveryAt": "2025-01-05T14:07:11.338Z",
"createdAt": "2025-01-02T08:36:23.376Z"
},
{
"id": 458,
"orderId": 848,
"carrier": "ups",
"trackingNumber": "2Z8K1ZACZJ1A6VVQ",
"status": "delivered",
"shippedAt": "2025-05-09T23:55:47.785Z",
"deliveredAt": "2025-05-15T18:54:10.093Z",
"estimatedDeliveryAt": "2025-05-13T16:17:34.368Z",
"createdAt": "2025-05-09T23:55:47.785Z"
},
{
"id": 459,
"orderId": 852,
"carrier": "fedex",
"trackingNumber": "4GJ9P9O6GZ4TJQJ3",
"status": "out_for_delivery",
"shippedAt": "2025-10-05T01:47:46.934Z",
"deliveredAt": null,
"estimatedDeliveryAt": "2025-10-14T15:14:32.941Z",
"createdAt": "2025-10-05T01:47:46.934Z"
}
],
"meta": {
"page": 20,
"limit": 24,
"total": 531,
"totalPages": 23
},
"links": {
"self": "/api/v1/shipments?page=20&limit=24",
"first": "/api/v1/shipments?page=1&limit=24",
"last": "/api/v1/shipments?page=23&limit=24",
"next": "/api/v1/shipments?page=21&limit=24",
"prev": "/api/v1/shipments?page=19&limit=24"
}
}