shipments
shipments
Page 17 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": 385,
"orderId": 720,
"carrier": "fedex",
"trackingNumber": "D1VWOTAI0H50NUNC",
"status": "label_created",
"shippedAt": "2025-11-03T13:33:16.167Z",
"deliveredAt": null,
"estimatedDeliveryAt": "2025-11-09T09:13:56.792Z",
"createdAt": "2025-11-03T13:33:16.167Z"
},
{
"id": 386,
"orderId": 721,
"carrier": "usps",
"trackingNumber": "HVCZV9ESOEK07BPA",
"status": "label_created",
"shippedAt": "2025-03-28T18:50:44.937Z",
"deliveredAt": null,
"estimatedDeliveryAt": "2025-04-07T05:58:58.746Z",
"createdAt": "2025-03-28T18:50:44.937Z"
},
{
"id": 387,
"orderId": 722,
"carrier": "fedex",
"trackingNumber": "PYP7LC1UMWZOM0HE",
"status": "in_transit",
"shippedAt": "2024-06-29T00:12:33.223Z",
"deliveredAt": null,
"estimatedDeliveryAt": "2024-07-03T06:48:35.756Z",
"createdAt": "2024-06-29T00:12:33.223Z"
}
],
"meta": {
"page": 17,
"limit": 24,
"total": 531,
"totalPages": 23
},
"links": {
"self": "/api/v1/shipments?page=17&limit=24",
"first": "/api/v1/shipments?page=1&limit=24",
"last": "/api/v1/shipments?page=23&limit=24",
"next": "/api/v1/shipments?page=18&limit=24",
"prev": "/api/v1/shipments?page=16&limit=24"
}
}