example-data.com
Menu
Browse docs and collections

Overview

shipments / #40

shipments #40

orderId
orders/76
carrier
dhl
trackingNumber
GRL5ZVCF1E0GRAWY
status
delivered
shippedAt
deliveredAt
estimatedDeliveryAt
createdAt

Component variants

Related

References

Request

curl example

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

JavaScript example

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

Python example

import requests

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

Response

{
  "id": 40,
  "orderId": 76,
  "carrier": "dhl",
  "trackingNumber": "GRL5ZVCF1E0GRAWY",
  "status": "delivered",
  "shippedAt": "2024-10-08T21:05:26.032Z",
  "deliveredAt": "2024-10-11T20:01:34.113Z",
  "estimatedDeliveryAt": "2024-10-15T16:30:55.517Z",
  "createdAt": "2024-10-08T21:05:26.032Z"
}