example-data.com
Menu
Browse docs and collections

Overview

shipments / #13

shipments #13

orderId
orders/18
carrier
ups
trackingNumber
J30OZW79SQ030NJH
status
delivered
shippedAt
deliveredAt
estimatedDeliveryAt
createdAt

Component variants

Medium

#13

#13

Related

References

Request

curl example 

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

JavaScript example 

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

Python example 

import requests

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

Response 

{
  "id": 13,
  "orderId": 18,
  "carrier": "ups",
  "trackingNumber": "J30OZW79SQ030NJH",
  "status": "delivered",
  "shippedAt": "2025-03-17T09:01:37.025Z",
  "deliveredAt": "2025-03-22T11:22:23.902Z",
  "estimatedDeliveryAt": "2025-03-19T14:35:47.413Z",
  "createdAt": "2025-03-17T09:01:37.025Z"
}