shipments
shipments
Page 15 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": 337,
"orderId": 637,
"carrier": "dhl",
"trackingNumber": "724Z79KV87W4H9VR",
"status": "delivered",
"shippedAt": "2025-05-07T00:43:51.305Z",
"deliveredAt": "2025-05-10T18:32:11.224Z",
"estimatedDeliveryAt": "2025-05-11T10:40:28.548Z",
"createdAt": "2025-05-07T00:43:51.305Z"
},
{
"id": 338,
"orderId": 638,
"carrier": "fedex",
"trackingNumber": "WK8TBRV2103PQ11N",
"status": "in_transit",
"shippedAt": "2025-10-15T04:01:13.720Z",
"deliveredAt": null,
"estimatedDeliveryAt": "2025-10-19T06:55:18.910Z",
"createdAt": "2025-10-15T04:01:13.720Z"
},
{
"id": 339,
"orderId": 641,
"carrier": "usps",
"trackingNumber": "J1QQNOEIETX1OIAY",
"status": "out_for_delivery",
"shippedAt": "2025-06-20T22:56:50.423Z",
"deliveredAt": null,
"estimatedDeliveryAt": "2025-06-26T20:35:42.632Z",
"createdAt": "2025-06-20T22:56:50.423Z"
}
],
"meta": {
"page": 15,
"limit": 24,
"total": 531,
"totalPages": 23
},
"links": {
"self": "/api/v1/shipments?page=15&limit=24",
"first": "/api/v1/shipments?page=1&limit=24",
"last": "/api/v1/shipments?page=23&limit=24",
"next": "/api/v1/shipments?page=16&limit=24",
"prev": "/api/v1/shipments?page=14&limit=24"
}
}