shipments
shipments
Page 11 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": 241,
"orderId": 462,
"carrier": "ups",
"trackingNumber": "Y5MMXYF3AMWRN3KZ",
"status": "label_created",
"shippedAt": "2025-05-10T00:25:33.512Z",
"deliveredAt": null,
"estimatedDeliveryAt": "2025-05-17T00:31:13.382Z",
"createdAt": "2025-05-10T00:25:33.512Z"
},
{
"id": 242,
"orderId": 464,
"carrier": "fedex",
"trackingNumber": "23N18KLEC38KYTSE",
"status": "label_created",
"shippedAt": "2025-03-12T10:28:01.177Z",
"deliveredAt": null,
"estimatedDeliveryAt": "2025-03-15T17:43:58.453Z",
"createdAt": "2025-03-12T10:28:01.177Z"
},
{
"id": 243,
"orderId": 467,
"carrier": "usps",
"trackingNumber": "HVVGT05EGJ1CCFM2",
"status": "label_created",
"shippedAt": "2025-04-08T10:50:49.752Z",
"deliveredAt": null,
"estimatedDeliveryAt": "2025-04-12T15:01:49.962Z",
"createdAt": "2025-04-08T10:50:49.752Z"
}
],
"meta": {
"page": 11,
"limit": 24,
"total": 531,
"totalPages": 23
},
"links": {
"self": "/api/v1/shipments?page=11&limit=24",
"first": "/api/v1/shipments?page=1&limit=24",
"last": "/api/v1/shipments?page=23&limit=24",
"next": "/api/v1/shipments?page=12&limit=24",
"prev": "/api/v1/shipments?page=10&limit=24"
}
}