shipments
shipments
Page 22 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": 505,
"orderId": 950,
"carrier": "fedex",
"trackingNumber": "HQJY85CAT88V35VS",
"status": "label_created",
"shippedAt": "2025-06-08T19:48:27.486Z",
"deliveredAt": null,
"estimatedDeliveryAt": "2025-06-14T01:26:04.619Z",
"createdAt": "2025-06-08T19:48:27.486Z"
},
{
"id": 506,
"orderId": 951,
"carrier": "usps",
"trackingNumber": "7VKAHP37J5I0RWAQ",
"status": "in_transit",
"shippedAt": "2025-05-16T10:26:06.704Z",
"deliveredAt": null,
"estimatedDeliveryAt": "2025-05-24T13:51:08.994Z",
"createdAt": "2025-05-16T10:26:06.704Z"
},
{
"id": 507,
"orderId": 954,
"carrier": "dhl",
"trackingNumber": "YGJ1JV6X69Q3CBWL",
"status": "out_for_delivery",
"shippedAt": "2024-07-26T15:31:59.121Z",
"deliveredAt": null,
"estimatedDeliveryAt": "2024-08-04T04:23:58.769Z",
"createdAt": "2024-07-26T15:31:59.121Z"
}
],
"meta": {
"page": 22,
"limit": 24,
"total": 531,
"totalPages": 23
},
"links": {
"self": "/api/v1/shipments?page=22&limit=24",
"first": "/api/v1/shipments?page=1&limit=24",
"last": "/api/v1/shipments?page=23&limit=24",
"next": "/api/v1/shipments?page=23&limit=24",
"prev": "/api/v1/shipments?page=21&limit=24"
}
}