example-data.com
Menu
Browse docs and collections

Overview

shipments / #425

shipments #425

orderId
orders/795
carrier
usps
trackingNumber
AXK5AU9J689WA71N
status
out_for_delivery
shippedAt
deliveredAt
—
estimatedDeliveryAt
createdAt

Component variants

Related

References

Request

curl example 

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

JavaScript example 

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

Python example 

import requests

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

Response 

{
  "id": 425,
  "orderId": 795,
  "carrier": "usps",
  "trackingNumber": "AXK5AU9J689WA71N",
  "status": "out_for_delivery",
  "shippedAt": "2024-07-30T21:20:46.747Z",
  "deliveredAt": null,
  "estimatedDeliveryAt": "2024-08-04T22:02:06.111Z",
  "createdAt": "2024-07-30T21:20:46.747Z"
}