example-data.com
Menu
Browse docs and collections

Overview

shipments / #345

shipments #345

orderId
orders/650
carrier
usps
trackingNumber
DLKQDWPYMY3II6O4
status
delivered
shippedAt
deliveredAt
estimatedDeliveryAt
createdAt

Component variants

Related

References

Request

curl example 

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

JavaScript example 

const res = await fetch(
  "https://example-data.com/api/v1/shipments/345"
);
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/345"
);
const shipment = (await res.json()) as Shipment;

Python example 

import requests

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

Response 

{
  "id": 345,
  "orderId": 650,
  "carrier": "usps",
  "trackingNumber": "DLKQDWPYMY3II6O4",
  "status": "delivered",
  "shippedAt": "2025-02-04T00:46:19.098Z",
  "deliveredAt": "2025-02-07T09:20:22.912Z",
  "estimatedDeliveryAt": "2025-02-09T17:57:54.519Z",
  "createdAt": "2025-02-04T00:46:19.098Z"
}