example-data.com
Menu
Browse docs and collections

Overview

shipments / #269

shipments #269

orderId
orders/510
carrier
usps
trackingNumber
VRXBH5JG5FKDE7CC
status
delivered
shippedAt
deliveredAt
estimatedDeliveryAt
createdAt

Component variants

Related

References

Request

curl example 

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

JavaScript example 

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

Python example 

import requests

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

Response 

{
  "id": 269,
  "orderId": 510,
  "carrier": "usps",
  "trackingNumber": "VRXBH5JG5FKDE7CC",
  "status": "delivered",
  "shippedAt": "2024-12-24T22:05:26.255Z",
  "deliveredAt": "2024-12-30T14:43:24.021Z",
  "estimatedDeliveryAt": "2024-12-30T23:27:38.038Z",
  "createdAt": "2024-12-24T22:05:26.255Z"
}