shipments
shipments
Page 7 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": 145,
"orderId": 267,
"carrier": "ups",
"trackingNumber": "QNVZ2AUVH51SN767",
"status": "in_transit",
"shippedAt": "2025-09-27T01:26:23.074Z",
"deliveredAt": null,
"estimatedDeliveryAt": "2025-10-04T05:55:45.424Z",
"createdAt": "2025-09-27T01:26:23.074Z"
},
{
"id": 146,
"orderId": 270,
"carrier": "ups",
"trackingNumber": "UP0LSXO6S28FPJL9",
"status": "label_created",
"shippedAt": "2025-03-15T03:17:47.239Z",
"deliveredAt": null,
"estimatedDeliveryAt": "2025-03-24T05:52:28.185Z",
"createdAt": "2025-03-15T03:17:47.239Z"
},
{
"id": 147,
"orderId": 280,
"carrier": "ups",
"trackingNumber": "IZXBCO32SO4AI4HE",
"status": "in_transit",
"shippedAt": "2026-03-07T06:50:24.010Z",
"deliveredAt": null,
"estimatedDeliveryAt": "2026-03-11T20:06:56.424Z",
"createdAt": "2026-03-07T06:50:24.010Z"
}
],
"meta": {
"page": 7,
"limit": 24,
"total": 531,
"totalPages": 23
},
"links": {
"self": "/api/v1/shipments?page=7&limit=24",
"first": "/api/v1/shipments?page=1&limit=24",
"last": "/api/v1/shipments?page=23&limit=24",
"next": "/api/v1/shipments?page=8&limit=24",
"prev": "/api/v1/shipments?page=6&limit=24"
}
}