example-data.com
Menu
Browse docs and collections

Overview

shipments / #225

shipments #225

orderId
orders/434
carrier
dhl
trackingNumber
XC4KMXRI5ZIJ52ZR
status
delivered
shippedAt
deliveredAt
estimatedDeliveryAt
createdAt

Component variants

Related

References

Request

curl example 

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

JavaScript example 

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

Python example 

import requests

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

Response 

{
  "id": 225,
  "orderId": 434,
  "carrier": "dhl",
  "trackingNumber": "XC4KMXRI5ZIJ52ZR",
  "status": "delivered",
  "shippedAt": "2024-08-24T22:28:15.919Z",
  "deliveredAt": "2024-08-30T07:47:41.529Z",
  "estimatedDeliveryAt": "2024-09-01T17:57:27.272Z",
  "createdAt": "2024-08-24T22:28:15.919Z"
}