shipments
shipments
Page 8 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": 169,
"orderId": 322,
"carrier": "fedex",
"trackingNumber": "CUVS97MJFSJG7J38",
"status": "label_created",
"shippedAt": "2024-11-02T08:58:38.938Z",
"deliveredAt": null,
"estimatedDeliveryAt": "2024-11-11T06:23:59.936Z",
"createdAt": "2024-11-02T08:58:38.938Z"
},
{
"id": 170,
"orderId": 323,
"carrier": "ups",
"trackingNumber": "OL7P2K9FHW0IHAMI",
"status": "in_transit",
"shippedAt": "2025-12-06T01:53:20.553Z",
"deliveredAt": null,
"estimatedDeliveryAt": "2025-12-10T05:07:36.162Z",
"createdAt": "2025-12-06T01:53:20.553Z"
},
{
"id": 171,
"orderId": 325,
"carrier": "dhl",
"trackingNumber": "GYT4H2QXZEVP2PPX",
"status": "out_for_delivery",
"shippedAt": "2025-06-29T04:37:13.335Z",
"deliveredAt": null,
"estimatedDeliveryAt": "2025-07-03T11:16:28.842Z",
"createdAt": "2025-06-29T04:37:13.335Z"
}
],
"meta": {
"page": 8,
"limit": 24,
"total": 531,
"totalPages": 23
},
"links": {
"self": "/api/v1/shipments?page=8&limit=24",
"first": "/api/v1/shipments?page=1&limit=24",
"last": "/api/v1/shipments?page=23&limit=24",
"next": "/api/v1/shipments?page=9&limit=24",
"prev": "/api/v1/shipments?page=7&limit=24"
}
}