shipments
shipments
Page 19 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": 433,
"orderId": 806,
"carrier": "usps",
"trackingNumber": "N0DFCTHA4EW8GS5D",
"status": "delivered",
"shippedAt": "2025-07-30T17:50:06.939Z",
"deliveredAt": "2025-08-06T16:02:37.385Z",
"estimatedDeliveryAt": "2025-08-06T20:13:23.476Z",
"createdAt": "2025-07-30T17:50:06.939Z"
},
{
"id": 434,
"orderId": 808,
"carrier": "ups",
"trackingNumber": "SYFSHOT13CY4Y7II",
"status": "delivered",
"shippedAt": "2024-09-21T07:48:16.811Z",
"deliveredAt": "2024-09-27T09:01:58.952Z",
"estimatedDeliveryAt": "2024-09-27T18:39:11.117Z",
"createdAt": "2024-09-21T07:48:16.811Z"
},
{
"id": 435,
"orderId": 809,
"carrier": "fedex",
"trackingNumber": "6JYI5LNL21EMNGSX",
"status": "label_created",
"shippedAt": "2025-03-02T10:50:55.872Z",
"deliveredAt": null,
"estimatedDeliveryAt": "2025-03-08T06:34:45.208Z",
"createdAt": "2025-03-02T10:50:55.872Z"
}
],
"meta": {
"page": 19,
"limit": 24,
"total": 531,
"totalPages": 23
},
"links": {
"self": "/api/v1/shipments?page=19&limit=24",
"first": "/api/v1/shipments?page=1&limit=24",
"last": "/api/v1/shipments?page=23&limit=24",
"next": "/api/v1/shipments?page=20&limit=24",
"prev": "/api/v1/shipments?page=18&limit=24"
}
}