shipments
shipments
Page 23 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": 529,
"orderId": 997,
"carrier": "usps",
"trackingNumber": "SMQSPPNF8CMORUJU",
"status": "label_created",
"shippedAt": "2025-06-26T18:31:38.558Z",
"deliveredAt": null,
"estimatedDeliveryAt": "2025-07-03T22:00:28.111Z",
"createdAt": "2025-06-26T18:31:38.558Z"
},
{
"id": 530,
"orderId": 998,
"carrier": "dhl",
"trackingNumber": "OCT8O1AFYUOQFJSA",
"status": "out_for_delivery",
"shippedAt": "2025-05-25T20:31:04.972Z",
"deliveredAt": null,
"estimatedDeliveryAt": "2025-05-28T05:39:23.069Z",
"createdAt": "2025-05-25T20:31:04.972Z"
},
{
"id": 531,
"orderId": 1000,
"carrier": "dhl",
"trackingNumber": "4HLKT1HDD3CK6W8Z",
"status": "in_transit",
"shippedAt": "2025-09-03T08:17:43.226Z",
"deliveredAt": null,
"estimatedDeliveryAt": "2025-09-10T03:04:37.520Z",
"createdAt": "2025-09-03T08:17:43.226Z"
}
],
"meta": {
"page": 23,
"limit": 24,
"total": 531,
"totalPages": 23
},
"links": {
"self": "/api/v1/shipments?page=23&limit=24",
"first": "/api/v1/shipments?page=1&limit=24",
"last": "/api/v1/shipments?page=23&limit=24",
"next": null,
"prev": "/api/v1/shipments?page=22&limit=24"
}
}