shipments
shipments
Page 18 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": 409,
"orderId": 768,
"carrier": "dhl",
"trackingNumber": "R6YSQCVFCPRG7GWU",
"status": "delivered",
"shippedAt": "2025-09-04T17:45:36.710Z",
"deliveredAt": "2025-09-11T08:00:47.799Z",
"estimatedDeliveryAt": "2025-09-08T23:24:28.535Z",
"createdAt": "2025-09-04T17:45:36.710Z"
},
{
"id": 410,
"orderId": 769,
"carrier": "dhl",
"trackingNumber": "DNE2D3EFC3WWU2IB",
"status": "label_created",
"shippedAt": "2025-10-02T09:20:26.408Z",
"deliveredAt": null,
"estimatedDeliveryAt": "2025-10-09T12:39:22.961Z",
"createdAt": "2025-10-02T09:20:26.408Z"
},
{
"id": 411,
"orderId": 770,
"carrier": "dhl",
"trackingNumber": "ZM04JA30NOGV7O5G",
"status": "out_for_delivery",
"shippedAt": "2024-06-24T05:47:02.818Z",
"deliveredAt": null,
"estimatedDeliveryAt": "2024-06-27T02:30:00.281Z",
"createdAt": "2024-06-24T05:47:02.818Z"
}
],
"meta": {
"page": 18,
"limit": 24,
"total": 531,
"totalPages": 23
},
"links": {
"self": "/api/v1/shipments?page=18&limit=24",
"first": "/api/v1/shipments?page=1&limit=24",
"last": "/api/v1/shipments?page=23&limit=24",
"next": "/api/v1/shipments?page=19&limit=24",
"prev": "/api/v1/shipments?page=17&limit=24"
}
}