example-data.com
Menu
Browse docs and collections

Overview

shipments / #65

shipments #65

orderId
orders/115
carrier
usps
trackingNumber
S6FNPUH3CA1RR6N6
status
delivered
shippedAt
deliveredAt
estimatedDeliveryAt
createdAt

Component variants

Medium

#65

#65

Related

References

Request

curl example 

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

JavaScript example 

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

Python example 

import requests

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

Response 

{
  "id": 65,
  "orderId": 115,
  "carrier": "usps",
  "trackingNumber": "S6FNPUH3CA1RR6N6",
  "status": "delivered",
  "shippedAt": "2024-10-10T20:10:51.032Z",
  "deliveredAt": "2024-10-17T21:21:45.640Z",
  "estimatedDeliveryAt": "2024-10-20T06:57:05.932Z",
  "createdAt": "2024-10-10T20:10:51.032Z"
}