example-data.com
Menu
Browse docs and collections

Overview

shipments / #468

shipments #468

orderId
orders/872
carrier
dhl
trackingNumber
VL106N5B3U8OYLSS
status
label_created
shippedAt
deliveredAt
estimatedDeliveryAt
createdAt

Component variants

Related

References

Request

curl example

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

JavaScript example

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

Python example

import requests

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

Response

{
  "id": 468,
  "orderId": 872,
  "carrier": "dhl",
  "trackingNumber": "VL106N5B3U8OYLSS",
  "status": "label_created",
  "shippedAt": "2025-02-08T06:02:38.293Z",
  "deliveredAt": null,
  "estimatedDeliveryAt": "2025-02-15T13:15:14.538Z",
  "createdAt": "2025-02-08T06:02:38.293Z"
}