example-data.com
Menu
Browse docs and collections

Overview

shipments / #226

shipments #226

orderId
orders/437
carrier
usps
trackingNumber
E4KUAPS1KIBU436B
status
out_for_delivery
shippedAt
deliveredAt
estimatedDeliveryAt
createdAt

Component variants

Related

References

Request

curl example

curl -sS \
  "https://example-data.com/api/v1/shipments/226" \
  -H "Accept: application/json"

JavaScript example

const res = await fetch(
  "https://example-data.com/api/v1/shipments/226"
);
const shipment = 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 } from "./types/shipments";

const res = await fetch(
  "https://example-data.com/api/v1/shipments/226"
);
const shipment = (await res.json()) as Shipment;

Python example

import requests

res = requests.get(
    "https://example-data.com/api/v1/shipments/226"
)
shipment = res.json()

Response

{
  "id": 226,
  "orderId": 437,
  "carrier": "usps",
  "trackingNumber": "E4KUAPS1KIBU436B",
  "status": "out_for_delivery",
  "shippedAt": "2025-01-21T16:22:30.400Z",
  "deliveredAt": null,
  "estimatedDeliveryAt": "2025-01-30T10:57:32.231Z",
  "createdAt": "2025-01-21T16:22:30.400Z"
}