shipments
shipments
Page 9 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": 193,
"orderId": 373,
"carrier": "usps",
"trackingNumber": "Z1DZN8VCT7S3U0UU",
"status": "label_created",
"shippedAt": "2024-12-05T00:16:51.173Z",
"deliveredAt": null,
"estimatedDeliveryAt": "2024-12-08T22:35:14.345Z",
"createdAt": "2024-12-05T00:16:51.173Z"
},
{
"id": 194,
"orderId": 376,
"carrier": "usps",
"trackingNumber": "HMK8J96ISHXSRNZ5",
"status": "delivered",
"shippedAt": "2025-03-26T18:58:02.639Z",
"deliveredAt": "2025-04-01T22:15:33.393Z",
"estimatedDeliveryAt": "2025-03-31T20:21:28.015Z",
"createdAt": "2025-03-26T18:58:02.639Z"
},
{
"id": 195,
"orderId": 378,
"carrier": "dhl",
"trackingNumber": "ZX22EXSNTEM4BIR5",
"status": "out_for_delivery",
"shippedAt": "2025-07-06T07:51:08.039Z",
"deliveredAt": null,
"estimatedDeliveryAt": "2025-07-15T17:34:06.866Z",
"createdAt": "2025-07-06T07:51:08.039Z"
}
],
"meta": {
"page": 9,
"limit": 24,
"total": 531,
"totalPages": 23
},
"links": {
"self": "/api/v1/shipments?page=9&limit=24",
"first": "/api/v1/shipments?page=1&limit=24",
"last": "/api/v1/shipments?page=23&limit=24",
"next": "/api/v1/shipments?page=10&limit=24",
"prev": "/api/v1/shipments?page=8&limit=24"
}
}