example-data.com
Menu
Browse docs and collections

Overview

shipments / #321

shipments #321

orderId
orders/606
carrier
ups
trackingNumber
LDMDZASB4H4X7JRJ
status
delivered
shippedAt
deliveredAt
estimatedDeliveryAt
createdAt

Component variants

Related

References

Request

curl example 

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

JavaScript example 

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

Python example 

import requests

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

Response 

{
  "id": 321,
  "orderId": 606,
  "carrier": "ups",
  "trackingNumber": "LDMDZASB4H4X7JRJ",
  "status": "delivered",
  "shippedAt": "2024-07-20T16:19:12.617Z",
  "deliveredAt": "2024-07-22T23:34:56.394Z",
  "estimatedDeliveryAt": "2024-07-30T13:12:39.034Z",
  "createdAt": "2024-07-20T16:19:12.617Z"
}