shipments
shipments
Page 6 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": 121,
"orderId": 212,
"carrier": "usps",
"trackingNumber": "E1B46HWMW3I2BQ71",
"status": "delivered",
"shippedAt": "2025-10-16T06:55:43.046Z",
"deliveredAt": "2025-10-20T23:30:20.776Z",
"estimatedDeliveryAt": "2025-10-20T06:45:52.320Z",
"createdAt": "2025-10-16T06:55:43.046Z"
},
{
"id": 122,
"orderId": 217,
"carrier": "dhl",
"trackingNumber": "L398YVHO6UI5S133",
"status": "delivered",
"shippedAt": "2025-02-09T23:28:20.738Z",
"deliveredAt": "2025-02-17T20:43:51.056Z",
"estimatedDeliveryAt": "2025-02-17T12:29:25.819Z",
"createdAt": "2025-02-09T23:28:20.738Z"
},
{
"id": 123,
"orderId": 221,
"carrier": "dhl",
"trackingNumber": "XWNX1C4A7L9DIKUK",
"status": "in_transit",
"shippedAt": "2024-10-13T01:08:11.118Z",
"deliveredAt": null,
"estimatedDeliveryAt": "2024-10-19T21:51:30.908Z",
"createdAt": "2024-10-13T01:08:11.118Z"
}
],
"meta": {
"page": 6,
"limit": 24,
"total": 531,
"totalPages": 23
},
"links": {
"self": "/api/v1/shipments?page=6&limit=24",
"first": "/api/v1/shipments?page=1&limit=24",
"last": "/api/v1/shipments?page=23&limit=24",
"next": "/api/v1/shipments?page=7&limit=24",
"prev": "/api/v1/shipments?page=5&limit=24"
}
}