shipments
shipments
Page 16 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": 361,
"orderId": 676,
"carrier": "ups",
"trackingNumber": "69PBZDOMPD2FLGHW",
"status": "in_transit",
"shippedAt": "2024-11-22T06:53:38.807Z",
"deliveredAt": null,
"estimatedDeliveryAt": "2024-11-30T20:43:46.231Z",
"createdAt": "2024-11-22T06:53:38.807Z"
},
{
"id": 362,
"orderId": 677,
"carrier": "dhl",
"trackingNumber": "L99BBWE4DREMXOUD",
"status": "label_created",
"shippedAt": "2025-12-19T03:38:02.296Z",
"deliveredAt": null,
"estimatedDeliveryAt": "2025-12-25T01:50:52.678Z",
"createdAt": "2025-12-19T03:38:02.296Z"
},
{
"id": 363,
"orderId": 680,
"carrier": "ups",
"trackingNumber": "ER2Y27OTQJZ8HXTL",
"status": "label_created",
"shippedAt": "2024-06-12T14:15:03.819Z",
"deliveredAt": null,
"estimatedDeliveryAt": "2024-06-20T05:59:11.870Z",
"createdAt": "2024-06-12T14:15:03.819Z"
}
],
"meta": {
"page": 16,
"limit": 24,
"total": 531,
"totalPages": 23
},
"links": {
"self": "/api/v1/shipments?page=16&limit=24",
"first": "/api/v1/shipments?page=1&limit=24",
"last": "/api/v1/shipments?page=23&limit=24",
"next": "/api/v1/shipments?page=17&limit=24",
"prev": "/api/v1/shipments?page=15&limit=24"
}
}