example-data.com
Menu
Browse docs and collections

Overview

shipments / #89

shipments #89

orderId
orders/153
carrier
usps
trackingNumber
C2O1OQFZS3SGB1P9
status
delivered
shippedAt
deliveredAt
estimatedDeliveryAt
createdAt

Component variants

Medium

#89

#89

Related

References

Request

curl example 

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

JavaScript example 

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

Python example 

import requests

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

Response 

{
  "id": 89,
  "orderId": 153,
  "carrier": "usps",
  "trackingNumber": "C2O1OQFZS3SGB1P9",
  "status": "delivered",
  "shippedAt": "2024-06-30T12:24:53.593Z",
  "deliveredAt": "2024-07-03T09:02:29.598Z",
  "estimatedDeliveryAt": "2024-07-05T16:00:50.990Z",
  "createdAt": "2024-06-30T12:24:53.593Z"
}